AWS codepipeline documentation change
Summary
Updated documentation to replace 'AWS CloudFormation' with 'CloudFormation' throughout the file for consistency in terminology
Security assessment
The changes are purely terminological, removing redundant 'AWS' prefixes from 'AWS CloudFormation' references. No security-related content was added, modified, or removed. The existing security implications (e.g., IAM permissions for DescribeStackEvents) remain unchanged in substance.
Diff
diff --git a/codepipeline/latest/userguide/action-reference-CloudFormation.md b/codepipeline/latest/userguide/action-reference-CloudFormation.md index df24bd28d..bcd16f2ea 100644 --- a//codepipeline/latest/userguide/action-reference-CloudFormation.md +++ b//codepipeline/latest/userguide/action-reference-CloudFormation.md @@ -5 +5 @@ -Action typeConfiguration parameters Input artifactsOutput artifactsOutput variablesService role permissions: AWS CloudFormation actionAction declarationSee also +Action typeConfiguration parameters Input artifactsOutput artifactsOutput variablesService role permissions: CloudFormation actionAction declarationSee also @@ -7 +7 @@ Action typeConfiguration parameters Input artifactsOutput artifactsOutput variab -# AWS CloudFormation deploy action reference +# CloudFormation deploy action reference @@ -9 +9 @@ Action typeConfiguration parameters Input artifactsOutput artifactsOutput variab -Executes an operation on an AWS CloudFormation stack. A stack is a collection of AWS resources that you can manage as a single unit. The resources in a stack are defined by the stack's AWS CloudFormation template. A change set creates a comparison that can be viewed without altering the original stack. For information about the types of AWS CloudFormation actions that can be performed on stacks and change sets, see the `ActionMode` parameter. +Executes an operation on an CloudFormation stack. A stack is a collection of AWS resources that you can manage as a single unit. The resources in a stack are defined by the stack's CloudFormation template. A change set creates a comparison that can be viewed without altering the original stack. For information about the types of CloudFormation actions that can be performed on stacks and change sets, see the `ActionMode` parameter. @@ -11 +11 @@ Executes an operation on an AWS CloudFormation stack. A stack is a collection of -To construct an error message for an AWS CloudFormation action where a stack operation has failed, CodePipeline calls the AWS CloudFormation `DescribeStackEvents` API. If an action IAM role has permission to access that API, the details about the first failed resource will be included in the CodePipeline error message. Otherwise, if the role policy does not have the appropriate permission, CodePipeline will ignore accessing the API and show a generic error message instead. To do this, the `cloudformation:DescribeStackEvents` permission must be added to the service role or other IAM roles for the pipeline. +To construct an error message for an CloudFormation action where a stack operation has failed, CodePipeline calls the CloudFormation `DescribeStackEvents` API. If an action IAM role has permission to access that API, the details about the first failed resource will be included in the CodePipeline error message. Otherwise, if the role policy does not have the appropriate permission, CodePipeline will ignore accessing the API and show a generic error message instead. To do this, the `cloudformation:DescribeStackEvents` permission must be added to the service role or other IAM roles for the pipeline. @@ -27 +27 @@ If you do not want the resource details surfaced in the pipeline error messages, - * Service role permissions: AWS CloudFormation action + * Service role permissions: CloudFormation action @@ -56 +56 @@ Required: Yes -`ActionMode` is the name of the action AWS CloudFormation performs on a stack or change set. The following action modes are available: +`ActionMode` is the name of the action CloudFormation performs on a stack or change set. The following action modes are available: @@ -58 +58 @@ Required: Yes - * `CHANGE_SET_EXECUTE` executes a change set for the resource stack that is based on a set of specified resource updates. With this action, AWS CloudFormation starts to alter the stack. + * `CHANGE_SET_EXECUTE` executes a change set for the resource stack that is based on a set of specified resource updates. With this action, CloudFormation starts to alter the stack. @@ -60 +60 @@ Required: Yes - * `CHANGE_SET_REPLACE` creates the change set, if it doesn't exist, based on the stack name and template that you submit. If the change set exists, AWS CloudFormation deletes it, and then creates a new one. + * `CHANGE_SET_REPLACE` creates the change set, if it doesn't exist, based on the stack name and template that you submit. If the change set exists, CloudFormation deletes it, and then creates a new one. @@ -62 +62 @@ Required: Yes - * `CREATE_UPDATE` creates the stack if it doesn't exist. If the stack exists, AWS CloudFormation updates the stack. Use this action to update existing stacks. Unlike `REPLACE_ON_FAILURE`, if the stack exists and is in a failed state, CodePipeline won't delete and replace the stack. + * `CREATE_UPDATE` creates the stack if it doesn't exist. If the stack exists, CloudFormation updates the stack. Use this action to update existing stacks. Unlike `REPLACE_ON_FAILURE`, if the stack exists and is in a failed state, CodePipeline won't delete and replace the stack. @@ -66 +66 @@ Required: Yes - * `REPLACE_ON_FAILURE` creates a stack, if it doesn't exist. If the stack exists and is in a failed state, AWS CloudFormation deletes the stack, and then creates a new stack. If the stack isn't in a failed state, AWS CloudFormation updates it. + * `REPLACE_ON_FAILURE` creates a stack, if it doesn't exist. If the stack exists and is in a failed state, CloudFormation deletes the stack, and then creates a new stack. If the stack isn't in a failed state, CloudFormation updates it. @@ -68 +68 @@ Required: Yes -The stack is in a failed state when any of the following status types are displayed in AWS CloudFormation: +The stack is in a failed state when any of the following status types are displayed in CloudFormation: @@ -101 +101 @@ Use of `Capabilities` acknowledges that the template might have the capabilities -This property is required if you have IAM resources in your stack template or you create a stack directly from a template containing macros. In order for the AWS CloudFormation action to successfully operate in this way, you must explicitly acknowledge that you would like it to do so with one of the following capabilities: +This property is required if you have IAM resources in your stack template or you create a stack directly from a template containing macros. In order for the CloudFormation action to successfully operate in this way, you must explicitly acknowledge that you would like it to do so with one of the following capabilities: @@ -130 +130 @@ Required: Conditional -The `RoleArn` is the ARN of the IAM service role that AWS CloudFormation assumes when it operates on resources in the specified stack. `RoleArn` is not applied when executing a change set. If you do not use CodePipeline to create the change set, make sure that the change set or stack has an associated role. +The `RoleArn` is the ARN of the IAM service role that CloudFormation assumes when it operates on resources in the specified stack. `RoleArn` is not applied when executing a change set. If you do not use CodePipeline to create the change set, make sure that the change set or stack has an associated role. @@ -151 +151 @@ This property is required for the following action modes: -AWS CloudFormation is given an S3-signed URL to the template; therefore, this `RoleArn` does not need permission to access the artifact bucket. However, the action `RoleArn` _does_ need permission to access the artifact bucket, in order to generate the signed URL. +CloudFormation is given an S3-signed URL to the template; therefore, this `RoleArn` does not need permission to access the artifact bucket. However, the action `RoleArn` _does_ need permission to access the artifact bucket, in order to generate the signed URL. @@ -158 +158 @@ Required: Conditional -`TemplatePath` represents the AWS CloudFormation template file. You include the file in an input artifact to this action. The file name follows this format: +`TemplatePath` represents the CloudFormation template file. You include the file in an input artifact to this action. The file name follows this format: @@ -182 +182 @@ For all other action modes, this property is ignored. -The AWS CloudFormation template file containing the template body has a minimum length of 1 byte and a maximum length of 1 MB. For AWS CloudFormation deployment actions in CodePipeline, the maximum input artifact size is always 256 MB. For more information, see [Quotas in AWS CodePipeline](./limits.html) and [AWS CloudFormation Limits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html). +The CloudFormation template file containing the template body has a minimum length of 1 byte and a maximum length of 1 MB. For CloudFormation deployment actions in CodePipeline, the maximum input artifact size is always 256 MB. For more information, see [Quotas in AWS CodePipeline](./limits.html) and [CloudFormation Limits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html). @@ -189 +189 @@ Required: No -Use `OutputFileName` to specify an output file name, such as `CreateStackOutput.json`, that CodePipeline adds to the pipeline output artifact for this action. The JSON file contains the contents of the `Outputs` section from the AWS CloudFormation stack. +Use `OutputFileName` to specify an output file name, such as `CreateStackOutput.json`, that CodePipeline adds to the pipeline output artifact for this action. The JSON file contains the contents of the `Outputs` section from the CloudFormation stack. @@ -226 +226 @@ The template configuration file name follows this format: - * **Description:** As input, the AWS CloudFormation action optionally accepts artifacts for these purposes: + * **Description:** As input, the CloudFormation action optionally accepts artifacts for these purposes: @@ -232 +232 @@ The template configuration file name follows this format: - * To provide the artifact for a Lambda function to be deployed as part of the AWS CloudFormation stack. + * To provide the artifact for a Lambda function to be deployed as part of the CloudFormation stack. @@ -241 +241 @@ The template configuration file name follows this format: - * **Description:** If the `OutputFileName` parameter is specified, there is an output artifact produced by this action that contains a JSON file with the specified name. The JSON file contains the contents of the Outputs section from the AWS CloudFormation stack. + * **Description:** If the `OutputFileName` parameter is specified, there is an output artifact produced by this action that contains a JSON file with the specified name. The JSON file contains the contents of the Outputs section from the CloudFormation stack. @@ -243 +243 @@ The template configuration file name follows this format: -For more information about the outputs section you can create for your AWS CloudFormation action, see [Outputs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html). +For more information about the outputs section you can create for your CloudFormation action, see [Outputs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html). @@ -252 +252 @@ When configured, this action produces variables that can be referenced by the ac -For AWS CloudFormation actions, variables are produced from any values designated in the `Outputs` section of a stack template. Note that the only CloudFormation action modes that generate outputs are those that result in creating or updating a stack, such as stack creation, stack updates, and change set execution. The corresponding action modes that generate variables are: +For CloudFormation actions, variables are produced from any values designated in the `Outputs` section of a stack template. Note that the only CloudFormation action modes that generate outputs are those that result in creating or updating a stack, such as stack creation, stack updates, and change set execution. The corresponding action modes that generate variables are: @@ -267 +267 @@ For more information, see [Variables reference](./reference-variables.html). For -## Service role permissions: AWS CloudFormation action +## Service role permissions: CloudFormation action @@ -330 +330 @@ JSON -Note that the `cloudformation:DescribeStackEvents` permission is optional. It allows the AWS CloudFormation action to show a more detailed error message. This permission can be revoked from the IAM role if you don't want resource details surfaced in the pipeline error messages. +Note that the `cloudformation:DescribeStackEvents` permission is optional. It allows the CloudFormation action to show a more detailed error message. This permission can be revoked from the IAM role if you don't want resource details surfaced in the pipeline error messages. @@ -395 +395 @@ The following related resources can help you as you work with this action. - * [AWS CloudFormation API Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/) – The [CreateStack](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html) parameter in the _AWS CloudFormation API Reference_ describes stack parameters for AWS CloudFormation templates. + * [AWS CloudFormation API Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/) – The [CreateStack](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html) parameter in the _AWS CloudFormation API Reference_ describes stack parameters for CloudFormation templates. @@ -408 +408 @@ AWS AppConfig deploy action reference -AWS CloudFormation StackSets +CloudFormation StackSets