AWS AWSCloudFormation documentation change
Summary
Updated terminology from 'stack set' to 'StackSet' (capitalized) throughout the document for consistency
Security assessment
The changes are purely terminological/formatting updates (capitalization and compound word usage). No security vulnerabilities, mitigations, or security features are mentioned or modified. The updates improve documentation clarity but don't address security aspects.
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/stacksets-drift.md b/AWSCloudFormation/latest/UserGuide/stacksets-drift.md index 3a4a0abf7..23f333c0b 100644 --- a//AWSCloudFormation/latest/UserGuide/stacksets-drift.md +++ b//AWSCloudFormation/latest/UserGuide/stacksets-drift.md @@ -5 +5 @@ -How CloudFormation performs drift detection on a stack setDetect drift on a stack set (console)Detect drift on a stack set (AWS CLI)Stopping drift detection on a stack set +How CloudFormation performs drift detection on a StackSetDetect drift on a StackSet (console)Detect drift on a StackSet (AWS CLI)Stopping drift detection on a StackSet @@ -9 +9 @@ How CloudFormation performs drift detection on a stack setDetect drift on a stac -Even as you manage your stacks and the resources they contain through CloudFormation, users can change those resources outside of CloudFormation. Users can edit resources directly by using the underlying service that created the resource. By performing drift detection on a stack set, you can determine if any of the stack instances belonging to that stack set differ, or have _drifted_ , from their expected configuration. +Even as you manage your stacks and the resources they contain through CloudFormation, users can change those resources outside of CloudFormation. Users can edit resources directly by using the underlying service that created the resource. By performing drift detection on a StackSet, you can determine if any of the stack instances belonging to that StackSet differ, or have _drifted_ , from their expected configuration. @@ -13 +13 @@ Even as you manage your stacks and the resources they contain through CloudForma - * How CloudFormation performs drift detection on a stack set + * How CloudFormation performs drift detection on a StackSet @@ -15 +15 @@ Even as you manage your stacks and the resources they contain through CloudForma - * Detect drift on a stack set (console) + * Detect drift on a StackSet (console) @@ -17 +17 @@ Even as you manage your stacks and the resources they contain through CloudForma - * Detect drift on a stack set (AWS CLI) + * Detect drift on a StackSet (AWS CLI) @@ -19 +19 @@ Even as you manage your stacks and the resources they contain through CloudForma - * Stopping drift detection on a stack set + * Stopping drift detection on a StackSet @@ -24 +24 @@ Even as you manage your stacks and the resources they contain through CloudForma -## How CloudFormation performs drift detection on a stack set +## How CloudFormation performs drift detection on a StackSet @@ -26 +26 @@ Even as you manage your stacks and the resources they contain through CloudForma -When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. To do this, CloudFormation compares the current state of each resource in the stack with the expected state of that resource, as defined in the stack's template and any specified input parameters. If the current state of a resource varies from its expected state, that resource is considered to have drifted. If one or more resources in a stack have drifted, then the stack itself is considered to have drifted, and the stack instances that the stack is associated with is considered to have drifted as well. If one or more stack instances in a stack set have drifted, the stack set itself is considered to have drifted. +When CloudFormation performs drift detection on a StackSet, it performs drift detection on the stack associated with each stack instance in the StackSet. To do this, CloudFormation compares the current state of each resource in the stack with the expected state of that resource, as defined in the stack's template and any specified input parameters. If the current state of a resource varies from its expected state, that resource is considered to have drifted. If one or more resources in a stack have drifted, then the stack itself is considered to have drifted, and the stack instances that the stack is associated with is considered to have drifted as well. If one or more stack instances in a StackSet have drifted, the StackSet itself is considered to have drifted. @@ -28 +28 @@ When CloudFormation performs drift detection on a stack set, it performs drift d -Drift detection identifies unmanaged changes; that is, changes made to stacks outside of CloudFormation. Changes made through CloudFormation to a stack directly, rather than at the stack-set level, aren't considered drift. For example, suppose you have a stack that is associated with a stack instance of a stack set. If you use CloudFormation to update that stack to use a different template, that is not considered drift, even though that stack now has a different template than any other stacks belonging to the stack set. This is because the stack still matches its expected template and parameter configuration in CloudFormation. +Drift detection identifies unmanaged changes; that is, changes made to stacks outside of CloudFormation. Changes made through CloudFormation to a stack directly, rather than at the StackSet level, aren't considered drift. For example, suppose you have a stack that is associated with a stack instance of a StackSet. If you use CloudFormation to update that stack to use a different template, that is not considered drift, even though that stack now has a different template than any other stacks belonging to the StackSet. This is because the stack still matches its expected template and parameter configuration in CloudFormation. @@ -32 +32 @@ For detailed information on how CloudFormation performs drift detection on a sta -Because CloudFormation performs drift detection on each stack individually, it takes any overridden parameter values into account when determining whether a stack has drifted. For more information on overriding template parameters in stack instances, see [Override parameter values on stacks within your CloudFormation stack set](./stackinstances-override.html). +Because CloudFormation performs drift detection on each stack individually, it takes any overridden parameter values into account when determining whether a stack has drifted. For more information on overriding template parameters in stack instances, see [Override parameter values on stacks within your CloudFormation StackSet](./stackinstances-override.html). @@ -36 +36 @@ If you perform drift detection [directly on a stack](./using-cfn-stack-drift.htm -## Detect drift on a stack set (console) +## Detect drift on a StackSet (console) @@ -38 +38 @@ If you perform drift detection [directly on a stack](./using-cfn-stack-drift.htm -###### To detect drift on a stack set +###### To detect drift on a StackSet @@ -42 +42 @@ If you perform drift detection [directly on a stack](./using-cfn-stack-drift.htm - 2. On the **StackSets** page, select the stack set on which you want to perform drift detection. + 2. On the **StackSets** page, select the StackSet on which you want to perform drift detection. @@ -46 +46 @@ If you perform drift detection [directly on a stack](./using-cfn-stack-drift.htm -CloudFormation displays an information bar stating that drift detection has been initiated for the selected stack set. +CloudFormation displays an information bar stating that drift detection has been initiated for the selected StackSet. @@ -50 +50 @@ CloudFormation displays an information bar stating that drift detection has been - 1. Select the stack set name to display the **Stackset details** page. + 1. Select the StackSet name to display the **Stackset details** page. @@ -56 +56 @@ CloudFormation displays the **Operation details** dialog box. - 5. Wait until CloudFormation completes the drift detection operation. When the drift detection operation completes, CloudFormation updates **Drift status** and **Last drift check time** for your stack set. These fields are listed on the **Overview** tab of the **StackSet details** page for the selected stack set. + 5. Wait until CloudFormation completes the drift detection operation. When the drift detection operation completes, CloudFormation updates **Drift status** and **Last drift check time** for your StackSet. These fields are listed on the **Overview** tab of the **StackSet details** page for the selected StackSet. @@ -58 +58 @@ CloudFormation displays the **Operation details** dialog box. -The drift detection operation may take some time, depending on the number of stack instances included in the stack set, and the number of resources included in the stack set. You can only run a single drift detection operation on a given stack set at one time. CloudFormation continues the drift detection operation even after you dismiss the information bar. +The drift detection operation may take some time, depending on the number of stack instances included in the StackSet, and the number of resources included in the StackSet. You can only run a single drift detection operation on a given StackSet at one time. CloudFormation continues the drift detection operation even after you dismiss the information bar. @@ -60 +60 @@ The drift detection operation may take some time, depending on the number of sta - 6. To review the drift detection results for the stack instances in a stack set, select the **Stack instances** tab. + 6. To review the drift detection results for the stack instances in a StackSet, select the **Stack instances** tab. @@ -87 +87 @@ If the stack belongs to a different Region and account than the one you're curre -## Detect drift on a stack set (AWS CLI) +## Detect drift on a StackSet (AWS CLI) @@ -91 +91 @@ To detect drift on an entire stack using the AWS CLI, use the following procedur -###### To detect drift on a stack set +###### To detect drift on a StackSet @@ -93 +93 @@ To detect drift on an entire stack using the AWS CLI, use the following procedur - 1. Use the [detect-stack-set-drift](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/detect-stack-set-drift.html) command to detect drift on an entire stack set and its associated stack instances. + 1. Use the [detect-stack-set-drift](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/detect-stack-set-drift.html) command to detect drift on an entire StackSet and its associated stack instances. @@ -95 +95 @@ To detect drift on an entire stack using the AWS CLI, use the following procedur -The following example initiates drift detection on the stack set `stack-set-drift-example`. +The following example initiates drift detection on the StackSet `stack-set-drift-example`. @@ -106 +106 @@ Output: - 2. Because stack set drift detection operations can be a long-running operation, use the [describe-stack-set-operation](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/describe-stack-set-operation.html) command to monitor the status of drift operation. This command takes the stack set operation ID returned by the **detect-stack-set-drift** command. + 2. Because StackSet drift detection operations can be a long-running operation, use the [describe-stack-set-operation](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/describe-stack-set-operation.html) command to monitor the status of drift operation. This command takes the StackSet operation ID returned by the **detect-stack-set-drift** command. @@ -108 +108 @@ Output: -The following examples uses the operation ID from the previous example to return information on the stack set drift detection operation. In this example, the operation is still running. Of the seven stack instances associated with this stack set, one stack instance has already been found to have drifted, two instances are in sync , and drift detection for the remaining four stack instances is still in progress. Because one instance has drifted, the drift status of the stack set itself is now `DRIFTED`. +The following examples uses the operation ID from the previous example to return information on the StackSet drift detection operation. In this example, the operation is still running. Of the seven stack instances associated with this StackSet, one stack instance has already been found to have drifted, two instances are in sync , and drift detection for the remaining four stack instances is still in progress. Because one instance has drifted, the drift status of the StackSet itself is now `DRIFTED`. @@ -140 +140 @@ Output: -Performing the same command later, this example shows the information returned once the drift detection operation has completed. Two of the seven total stack instances associated with this stack set have drifted, rendering the drift status of the stack set itself as `DRIFTED`. +Performing the same command later, this example shows the information returned once the drift detection operation has completed. Two of the seven total stack instances associated with this StackSet have drifted, rendering the drift status of the StackSet itself as `DRIFTED`. @@ -173 +173 @@ Output: - 3. When the stack set drift detection operation is complete, use the **describe-stack-set** , **list-stack-instances** , **describe-stack-instance** , and **list-stack-instance-resource-drifts** commands to review the results. + 3. When the StackSet drift detection operation is complete, use the **describe-stack-set** , **list-stack-instances** , **describe-stack-instance** , and **list-stack-instance-resource-drifts** commands to review the results. @@ -213 +213 @@ Output: -You can use the [list-stack-instances](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-stack-instances.html) command to return summary information about the stack instances associated with a stack set, including the drift status of each stack instance. +You can use the [list-stack-instances](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-stack-instances.html) command to return summary information about the stack instances associated with a StackSet, including the drift status of each stack instance. @@ -215 +215 @@ You can use the [list-stack-instances](https://docs.aws.amazon.com/cli/latest/re -In this example, executing **list-stack-instances** on the example stack set with the drift status filter set to `DRIFTED` enables you to identify which two stack instances have a drift status of `DRIFTED`. +In this example, executing **list-stack-instances** on the example StackSet with the drift status filter set to `DRIFTED` enables you to identify which two stack instances have a drift status of `DRIFTED`. @@ -316 +316 @@ Output: -## Stopping drift detection on a stack set +## Stopping drift detection on a StackSet @@ -318 +318 @@ Output: -Because drift detection on a stack set can be a long-running operation, there may be instances when you want to stop a drift detection operation that is currently running on a stack set. +Because drift detection on a StackSet can be a long-running operation, there may be instances when you want to stop a drift detection operation that is currently running on a StackSet. @@ -320 +320 @@ Because drift detection on a stack set can be a long-running operation, there ma -###### To stop drift detection on a stack set (console) +###### To stop drift detection on a StackSet (console) @@ -324 +324 @@ Because drift detection on a stack set can be a long-running operation, there ma - 2. On the **StackSets** page, select the name of the stack set. + 2. On the **StackSets** page, select the name of the StackSet. @@ -326 +326 @@ Because drift detection on a stack set can be a long-running operation, there ma -CloudFormation displays the **StackSets details** page for the selected stack set. +CloudFormation displays the **StackSets details** page for the selected StackSet. @@ -335 +335 @@ CloudFormation displays the **StackSets details** page for the selected stack se -###### To stop drift detection on a stack set (AWS CLI) +###### To stop drift detection on a StackSet (AWS CLI) @@ -337 +337 @@ CloudFormation displays the **StackSets details** page for the selected stack se - * Use the [stop-stack-set-operation](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/stop-stack-set-operation.html) command. You must supply both the stack set name and the operation ID of the drift detection stack set operation. + * Use the [stop-stack-set-operation](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/stop-stack-set-operation.html) command. You must supply both the StackSet name and the operation ID of the drift detection StackSet operation.