AWS AWSCloudFormation documentation change
Summary
Updated documentation to standardize capitalization of 'StackSet' and 'CloudFormation' terms, adjusted links, and improved clarity in failure tolerance explanations
Security assessment
Changes focus on terminology consistency (StackSet vs stack set) and documentation structure improvements. No security vulnerabilities, mitigations, or security feature enhancements are mentioned. The concurrency mode explanations relate to operational reliability rather than security controls.
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/concurrency-mode.md b/AWSCloudFormation/latest/UserGuide/concurrency-mode.md index 313fc91d6..74c3cceb3 100644 --- a//AWSCloudFormation/latest/UserGuide/concurrency-mode.md +++ b//AWSCloudFormation/latest/UserGuide/concurrency-mode.md @@ -7 +7 @@ How each Concurrency Mode worksChoosing between Strict failure tolerance and Sof -# Choose the Concurrency Mode for CloudFormation StackSets +# Choose the Concurrency Mode for AWS CloudFormation StackSets @@ -9 +9 @@ How each Concurrency Mode worksChoosing between Strict failure tolerance and Sof -**Concurrency Mode** is a parameter for [StackSetOperationPreferences](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_StackSetOperationPreferences.html) that allows you to choose how the concurrency level behaves during stack set operations. You can choose between the following modes: +**Concurrency Mode** is a parameter for [StackSetOperationPreferences](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_StackSetOperationPreferences.html) that allows you to choose how the concurrency level behaves during StackSet operations. You can choose between the following modes: @@ -13 +13 @@ How each Concurrency Mode worksChoosing between Strict failure tolerance and Sof - * **Soft Failure Tolerance** : This option decouples **Failure tolerance** from the actual concurrency. This allows stack set operations to run at the concurrency level set by the **Maximum concurrent accounts** value, regardless of the number of failures. + * **Soft Failure Tolerance** : This option decouples **Failure tolerance** from the actual concurrency. This allows StackSet operations to run at the concurrency level set by the **Maximum concurrent accounts** value, regardless of the number of failures. @@ -18 +18 @@ How each Concurrency Mode worksChoosing between Strict failure tolerance and Sof -**Strict Failure Tolerance** lowers the deployment speed as stack set operation failures occur because concurrency decreases for each failure. **Soft Failure Tolerance** prioritizes deployment speed while still leveraging AWS CloudFormation safety capabilities. This allows you to review and address stack set operation failures for common issues such as those related to existing resources, service quotas, and permissions. +**Strict Failure Tolerance** lowers the deployment speed as StackSet operation failures occur because concurrency decreases for each failure. **Soft Failure Tolerance** prioritizes deployment speed while still leveraging CloudFormation safety capabilities. This allows you to review and address StackSet operation failures for common issues such as those related to existing resources, service quotas, and permissions. @@ -22 +22 @@ For more information on StackSets stack operation failures, see [Common reasons -For more information on **Maximum concurrent accounts** and **Failure tolerance** , see [Stack set operation options](./what-is-cfnstacksets.html#stackset-ops-options). +For more information on **Maximum concurrent accounts** and **Failure tolerance** , see [StackSet operation options](./stacksets-concepts.html#stackset-ops-options). @@ -26 +26 @@ For more information on **Maximum concurrent accounts** and **Failure tolerance* -The images below provide a visual representation of how each **Concurrency Mode** works during a stack set operation. The string of nodes represents a deployment to single AWS Region and each node is a target AWS account. +The images below provide a visual representation of how each **Concurrency Mode** works during a StackSet operation. The string of nodes represents a deployment to single AWS Region and each node is a target AWS account. @@ -31 +31 @@ The images below provide a visual representation of how each **Concurrency Mode* -When a stack set operation using **Strict Failure Tolerance** has the **Failure tolerance** value set to 5 and the **Maximum concurrent accounts** value set to 10, the actual concurrency is 6. The actual concurrency is 6 because this the **Failure tolerance** value of 5 +1 is lower than the value of **Maximum concurrent accounts**. +When a StackSet operation using **Strict Failure Tolerance** has the **Failure tolerance** value set to 5 and the **Maximum concurrent accounts** value set to 10, the actual concurrency is 6. The actual concurrency is 6 because this the **Failure tolerance** value of 5 +1 is lower than the value of **Maximum concurrent accounts**. @@ -33 +33 @@ When a stack set operation using **Strict Failure Tolerance** has the **Failure -The following image shows the impact that the **Failure tolerance** value has on the **Maximum concurrent accounts** value, and the impact they both have on the actual concurrency of the stack set operation: +The following image shows the impact that the **Failure tolerance** value has on the **Maximum concurrent accounts** value, and the impact they both have on the actual concurrency of the StackSet operation: @@ -35 +35 @@ The following image shows the impact that the **Failure tolerance** value has on - + @@ -39 +39 @@ When deployment begins and there are failed stack instances, then the actual con - + @@ -41 +41 @@ When deployment begins and there are failed stack instances, then the actual con - + @@ -45 +45 @@ The **Strict Failure Tolerance** mode reduces the actual concurrency proportiona - + @@ -47 +47 @@ The **Strict Failure Tolerance** mode reduces the actual concurrency proportiona -StackSets fails the stack set operation when the number of failed stack instances equals the defined value of **Failure tolerance** +1. In the following example, StackSets fails the operation when there are 6 failed stack instances and the **Failure tolerance** value is 5. +StackSets fails the StackSet operation when the number of failed stack instances equals the defined value of **Failure tolerance** +1. In the following example, StackSets fails the operation when there are 6 failed stack instances and the **Failure tolerance** value is 5. @@ -49 +49 @@ StackSets fails the stack set operation when the number of failed stack instance - + @@ -51 +51 @@ StackSets fails the stack set operation when the number of failed stack instance -In this example, StackSets deployed 9 stack instances (3 successful and 6 failed) before stopping the stack set operation. +In this example, CloudFormation deployed 9 stack instances (3 successful and 6 failed) before stopping the StackSet operation. @@ -56 +56 @@ In this example, StackSets deployed 9 stack instances (3 successful and 6 failed -When a stack set operation using **Soft Failure Tolerance** has the **Failure tolerance** value set to 5 and the **Maximum concurrent accounts** value set to 10, the actual concurrency is 10. +When a StackSet operation using **Soft Failure Tolerance** has the **Failure tolerance** value set to 5 and the **Maximum concurrent accounts** value set to 10, the actual concurrency is 10. @@ -58 +58 @@ When a stack set operation using **Soft Failure Tolerance** has the **Failure to - + @@ -62 +62 @@ When deployment begins and there are failed stack instances, the actual concurre - + @@ -66 +66 @@ The actual concurrency remains at 10 even after 2 more stack instance failures. - + @@ -68 +68 @@ The actual concurrency remains at 10 even after 2 more stack instance failures. -StackSets fails the stack set operation when failed stack instances exceeds the **Failure tolerance** value. In the following example, StackSets fails the operation when there are 6 failed stack instances and the **Failure tolerance** count is 5. However, the operation won't end until the remaining operations in the concurrency queue finish. +StackSets fails the StackSet operation when failed stack instances exceeds the **Failure tolerance** value. In the following example, StackSets fails the operation when there are 6 failed stack instances and the **Failure tolerance** count is 5. However, the operation won't end until the remaining operations in the concurrency queue finish. @@ -70 +70 @@ StackSets fails the stack set operation when failed stack instances exceeds the - + @@ -72 +72 @@ StackSets fails the stack set operation when failed stack instances exceeds the -StackSets continues to deploy stack instances that are already in the concurrency queue. This means that the number of failed stack instances can be higher than **Failure tolerance**. In the following example, there are 8 failed stack instances because the concurrency queue still had 7 operations left to perform, even though the stack set operation had reached the **Failure tolerance** of 5. +StackSets continues to deploy stack instances that are already in the concurrency queue. This means that the number of failed stack instances can be higher than **Failure tolerance**. In the following example, there are 8 failed stack instances because the concurrency queue still had 7 operations left to perform, even though the StackSet operation had reached the **Failure tolerance** of 5. @@ -74 +74 @@ StackSets continues to deploy stack instances that are already in the concurrenc - + @@ -80 +80 @@ In this example, StackSets deployed 15 stack instances (7 successful and 8 faile -Choosing between **Strict failure tolerance** and **Soft failure tolerance** modes depends on the preferred speed of your stack set deployment and the permissible number of deployment failures. +Choosing between **Strict failure tolerance** and **Soft failure tolerance** modes depends on the preferred speed of your StackSet deployment and the permissible number of deployment failures. @@ -82 +82 @@ Choosing between **Strict failure tolerance** and **Soft failure tolerance** mod -The following tables show how each concurrency mode handles a stack set operation that fails while trying to deploy 1000 total stack instances. In each scenario, the **Failure tolerance** value is set to 100 stack instances and the **Maximum concurrent accounts** value is set to 250 stack instances. +The following tables show how each concurrency mode handles a StackSet operation that fails while trying to deploy 1000 total stack instances. In each scenario, the **Failure tolerance** value is set to 100 stack instances and the **Maximum concurrent accounts** value is set to 250 stack instances. @@ -88 +88 @@ While StackSets actually queues accounts as a sliding window (see How each Concu -This example using **Strict failure tolerance** mode lowers the actual concurrency relative to the number of failures that occur in each preceding batch. Each batch has 20 failed instances, which then lowers the actual concurrency of the following batch by 20 until the stack set operation reaches the **Failure tolerance** value of 100. +This example using **Strict failure tolerance** mode lowers the actual concurrency relative to the number of failures that occur in each preceding batch. Each batch has 20 failed instances, which then lowers the actual concurrency of the following batch by 20 until the StackSet operation reaches the **Failure tolerance** value of 100. @@ -98 +98 @@ In following table, the initial actual concurrency of the first batch is 101 sta -The operation using **Strict failure tolerance** completed 305 stack instance deployments in 5 batches by the time the stack set operation reached the **Failure tolerance** of 100 stack instances. The stack set operation successfully deploys 205 stack instances before it fails. +The operation using **Strict failure tolerance** completed 305 stack instance deployments in 5 batches by the time the StackSet operation reached the **Failure tolerance** of 100 stack instances. The StackSet operation successfully deploys 205 stack instances before it fails. @@ -102 +102 @@ The operation using **Strict failure tolerance** completed 305 stack instance de -This example using **Soft failure tolerance** mode maintains the same actual concurrency count defined by the **Maximum concurrent accounts** value of 250 stack instances, regardless of the number of failed instances. The stack set operations keeps the same actual concurrency until it reaches the **Failure tolerance** value of 100 instances. +This example using **Soft failure tolerance** mode maintains the same actual concurrency count defined by the **Maximum concurrent accounts** value of 250 stack instances, regardless of the number of failed instances. The StackSet operations keeps the same actual concurrency until it reaches the **Failure tolerance** value of 100 instances. @@ -112 +112 @@ In following table, the initial actual concurrency of the first batch is 250 sta -Using the same **Maximum concurrent accounts** value and **Failure tolerance** value, the operation using **Soft failure tolerance** mode completed 500 stack instance deployments in 2 batches. The stack set operation successfully deploys 400 stack instances before it fails. +Using the same **Maximum concurrent accounts** value and **Failure tolerance** value, the operation using **Soft failure tolerance** mode completed 500 stack instance deployments in 2 batches. The StackSet operation successfully deploys 400 stack instances before it fails. @@ -116 +116 @@ Using the same **Maximum concurrent accounts** value and **Failure tolerance** v -When creating or updating a stack set, on the **Set deployment options** page, for **Concurrency mode** , choose **Strict failure tolerance** or **Soft failure tolerance**. +When creating or updating a StackSet, on the **Set deployment options** page, for **Concurrency mode** , choose **Strict failure tolerance** or **Soft failure tolerance**. @@ -157 +157 @@ The following example creates a stack instance using the `STRICT_FAILURE_TOLERAN -For detailed procedures for creating and updating stack sets, see the following topics: +For detailed procedures for creating and updating a StackSet, see the following topics: