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, standardizing references to CloudFormation without altering security configurations or introducing new security-related content. No evidence of addressing vulnerabilities or security weaknesses.
Diff
diff --git a/codepipeline/latest/userguide/update-change-detection.md b/codepipeline/latest/userguide/update-change-detection.md index 4ed19e2ce..cbbe62d2a 100644 --- a//codepipeline/latest/userguide/update-change-detection.md +++ b//codepipeline/latest/userguide/update-change-detection.md @@ -21 +21 @@ To migrate polling pipelines, determine your polling pipelines and then determin - * In the table, find your pipeline source type and then choose the procedure with the implementation you want to use to migrate your polling pipeline. Each section contains multiple methods for migration, such as using the CLI or AWS CloudFormation. + * In the table, find your pipeline source type and then choose the procedure with the implementation you want to use to migrate your polling pipeline. Each section contains multiple methods for migration, such as using the CLI or CloudFormation. @@ -227 +227 @@ You can migrate your polling pipeline to use EventBridge to detect changes in yo - * **AWS CloudFormation:** Migrate polling pipelines (CodeCommit source) (AWS CloudFormation template) + * **CloudFormation:** Migrate polling pipelines (CodeCommit source) (CloudFormation template) @@ -395 +395 @@ JSON -**Why am I making this change?** This command enables AWS CloudFormation to create the event. +**Why am I making this change?** This command enables CloudFormation to create the event. @@ -445 +445 @@ The following sample command specifies that for the rule called `MyCodeCommitRep -### Migrate polling pipelines (CodeCommit source) (AWS CloudFormation template) +### Migrate polling pipelines (CodeCommit source) (CloudFormation template) @@ -456 +456 @@ To build an event-driven pipeline with AWS CodeCommit, you edit the `PollForSour -If you use AWS CloudFormation to create and manage your pipelines, your template includes content like the following. +If you use CloudFormation to create and manage your pipelines, your template includes content like the following. @@ -523 +523 @@ JSON -###### To update your pipeline AWS CloudFormation template and create EventBridge rule +###### To update your pipeline CloudFormation template and create EventBridge rule @@ -525 +525 @@ JSON - 1. In the template, under `Resources`, use the `AWS::IAM::Role` AWS CloudFormation resource to configure the IAM role that allows your event to start your pipeline. This entry creates a role that uses two policies: + 1. In the template, under `Resources`, use the `AWS::IAM::Role` CloudFormation resource to configure the IAM role that allows your event to start your pipeline. This entry creates a role that uses two policies: @@ -531 +531 @@ JSON -**Why am I making this change?** Adding the `AWS::IAM::Role` resource enables AWS CloudFormation to create permissions for EventBridge. This resource is added to your AWS CloudFormation stack. +**Why am I making this change?** Adding the `AWS::IAM::Role` resource enables CloudFormation to create permissions for EventBridge. This resource is added to your CloudFormation stack. @@ -610 +610 @@ JSON - 2. In the template, under `Resources`, use the `AWS::Events::Rule` AWS CloudFormation resource to add an EventBridge rule. This event pattern creates an event that monitors push changes to your repository. When EventBridge detects a repository state change, the rule invokes `StartPipelineExecution` on your target pipeline. + 2. In the template, under `Resources`, use the `AWS::Events::Rule` CloudFormation resource to add an EventBridge rule. This event pattern creates an event that monitors push changes to your repository. When EventBridge detects a repository state change, the rule invokes `StartPipelineExecution` on your target pipeline. @@ -612 +612 @@ JSON -**Why am I making this change?** Adding the `AWS::Events::Rule` resource enables AWS CloudFormation to create the event. This resource is added to your AWS CloudFormation stack. +**Why am I making this change?** Adding the `AWS::Events::Rule` resource enables CloudFormation to create the event. This resource is added to your CloudFormation stack. @@ -745 +745 @@ JSON - 4. Save the updated template to your local computer, and then open the AWS CloudFormation console. + 4. Save the updated template to your local computer, and then open the CloudFormation console. @@ -749 +749 @@ JSON - 6. Upload the template, and then view the changes listed in AWS CloudFormation. These are the changes to be made to the stack. You should see your new resources in the list. + 6. Upload the template, and then view the changes listed in CloudFormation. These are the changes to be made to the stack. You should see your new resources in the list. @@ -823 +823 @@ JSON -When you create these resources with AWS CloudFormation, your pipeline is triggered when files in your repository are created or updated. Here is the final template snippet: +When you create these resources with CloudFormation, your pipeline is triggered when files in your repository are created or updated. Here is the final template snippet: @@ -1087 +1087 @@ JSON -For a pipeline with an Amazon S3 source, modify the pipeline so that change detection is automated through EventBridge and with a source bucket that is enabled for event notifications. This is the recommend method if you are using the CLI or AWS CloudFormation to migrate your pipeline. +For a pipeline with an Amazon S3 source, modify the pipeline so that change detection is automated through EventBridge and with a source bucket that is enabled for event notifications. This is the recommend method if you are using the CLI or CloudFormation to migrate your pipeline. @@ -1095 +1095 @@ This includes using a bucket that is enabled for event notifications, where you - * **AWS CloudFormation:**Migrate polling pipelines with an S3 source and CloudTrail trail (AWS CloudFormation template) + * **CloudFormation:**Migrate polling pipelines with an S3 source and CloudTrail trail (CloudFormation template) @@ -1239 +1239 @@ The **update-pipeline** command stops the pipeline. If a revision is being run t -### Migrate polling pipelines with an S3 source enabled for events (AWS CloudFormation template) +### Migrate polling pipelines with an S3 source enabled for events (CloudFormation template) @@ -1252 +1252 @@ To build an event-driven pipeline with Amazon S3, you edit the `PollForSourceCha -If you use AWS CloudFormation to create and manage your pipelines, your template includes content like the following. +If you use CloudFormation to create and manage your pipelines, your template includes content like the following. @@ -1335 +1335 @@ JSON - 1. In the template, under `Resources`, use the `AWS::IAM::Role` AWS CloudFormation resource to configure the IAM role that allows your event to start your pipeline. This entry creates a role that uses two policies: + 1. In the template, under `Resources`, use the `AWS::IAM::Role` CloudFormation resource to configure the IAM role that allows your event to start your pipeline. This entry creates a role that uses two policies: @@ -1341 +1341 @@ JSON -**Why am I making this change?** Adding `AWS::IAM::Role` resource enables AWS CloudFormation to create permissions for EventBridge. This resource is added to your AWS CloudFormation stack. +**Why am I making this change?** Adding `AWS::IAM::Role` resource enables CloudFormation to create permissions for EventBridge. This resource is added to your CloudFormation stack. @@ -1424 +1424 @@ JSON - 2. Use the `AWS::Events::Rule` AWS CloudFormation resource to add an EventBridge rule. This event pattern creates an event that monitors creation or deletion of objects in your Amazon S3 source bucket. In addition, include a target of your pipeline. When an object is created, this rule invokes `StartPipelineExecution` on your target pipeline. + 2. Use the `AWS::Events::Rule` CloudFormation resource to add an EventBridge rule. This event pattern creates an event that monitors creation or deletion of objects in your Amazon S3 source bucket. In addition, include a target of your pipeline. When an object is created, this rule invokes `StartPipelineExecution` on your target pipeline. @@ -1426 +1426 @@ JSON -**Why am I making this change?** Adding the `AWS::Events::Rule` resource enables AWS CloudFormation to create the event. This resource is added to your AWS CloudFormation stack. +**Why am I making this change?** Adding the `AWS::Events::Rule` resource enables CloudFormation to create the event. This resource is added to your CloudFormation stack. @@ -1516 +1516 @@ JSON - 3. Save your updated template to your local computer, and open the AWS CloudFormation console. + 3. Save your updated template to your local computer, and open the CloudFormation console. @@ -1520 +1520 @@ JSON - 5. Upload your updated template, and then view the changes listed in AWS CloudFormation. These are the changes that will be made to the stack. You should see your new resources in the list. + 5. Upload your updated template, and then view the changes listed in CloudFormation. These are the changes that will be made to the stack. You should see your new resources in the list. @@ -1589 +1589 @@ JSON -When you use AWS CloudFormation to create these resources, your pipeline is triggered when files in your repository are created or updated. +When you use CloudFormation to create these resources, your pipeline is triggered when files in your repository are created or updated. @@ -1593 +1593 @@ When you use AWS CloudFormation to create these resources, your pipeline is trig -Do not stop here. Although your pipeline is created, you must create a second AWS CloudFormation template for your Amazon S3 pipeline. If you do not create the second template, your pipeline does not have any change detection functionality. +Do not stop here. Although your pipeline is created, you must create a second CloudFormation template for your Amazon S3 pipeline. If you do not create the second template, your pipeline does not have any change detection functionality. @@ -1858 +1858 @@ For a pipeline with an Amazon S3 source, modify the pipeline so that change dete - * **AWS CloudFormation:**Migrate polling pipelines with an S3 source and CloudTrail trail (AWS CloudFormation template) + * **CloudFormation:**Migrate polling pipelines with an S3 source and CloudTrail trail (CloudFormation template) @@ -2079 +2079 @@ The **update-pipeline** command stops the pipeline. If a revision is being run t -### Migrate polling pipelines with an S3 source and CloudTrail trail (AWS CloudFormation template) +### Migrate polling pipelines with an S3 source and CloudTrail trail (CloudFormation template) @@ -2092 +2092 @@ To build an event-driven pipeline with Amazon S3, you edit the `PollForSourceCha -If you use AWS CloudFormation to create and manage your pipelines, your template includes content like the following. +If you use CloudFormation to create and manage your pipelines, your template includes content like the following. @@ -2175 +2175 @@ JSON - 1. In the template, under `Resources`, use the `AWS::IAM::Role` AWS CloudFormation resource to configure the IAM role that allows your event to start your pipeline. This entry creates a role that uses two policies: + 1. In the template, under `Resources`, use the `AWS::IAM::Role` CloudFormation resource to configure the IAM role that allows your event to start your pipeline. This entry creates a role that uses two policies: @@ -2181 +2181 @@ JSON -**Why am I making this change?** Adding `AWS::IAM::Role` resource enables AWS CloudFormation to create permissions for EventBridge. This resource is added to your AWS CloudFormation stack. +**Why am I making this change?** Adding `AWS::IAM::Role` resource enables CloudFormation to create permissions for EventBridge. This resource is added to your CloudFormation stack. @@ -2264 +2264 @@ JSON - 2. Use the `AWS::Events::Rule` AWS CloudFormation resource to add an EventBridge rule. This event pattern creates an event that monitors `CopyObject`, `PutObject` and `CompleteMultipartUpload` on your Amazon S3 source bucket. In addition, include a target of your pipeline. When `CopyObject`, `PutObject`, or `CompleteMultipartUpload` occurs, this rule invokes `StartPipelineExecution` on your target pipeline. + 2. Use the `AWS::Events::Rule` CloudFormation resource to add an EventBridge rule. This event pattern creates an event that monitors `CopyObject`, `PutObject` and `CompleteMultipartUpload` on your Amazon S3 source bucket. In addition, include a target of your pipeline. When `CopyObject`, `PutObject`, or `CompleteMultipartUpload` occurs, this rule invokes `StartPipelineExecution` on your target pipeline. @@ -2266 +2266 @@ JSON -**Why am I making this change?** Adding the `AWS::Events::Rule` resource enables AWS CloudFormation to create the event. This resource is added to your AWS CloudFormation stack. +**Why am I making this change?** Adding the `AWS::Events::Rule` resource enables CloudFormation to create the event. This resource is added to your CloudFormation stack. @@ -2423 +2423 @@ JSON - 5. Save your updated template to your local computer, and open the AWS CloudFormation console. + 5. Save your updated template to your local computer, and open the CloudFormation console. @@ -2427 +2427 @@ JSON - 7. Upload your updated template, and then view the changes listed in AWS CloudFormation. These are the changes that will be made to the stack. You should see your new resources in the list. + 7. Upload your updated template, and then view the changes listed in CloudFormation. These are the changes that will be made to the stack. You should see your new resources in the list. @@ -2498 +2498 @@ JSON - * In a separate template, under `Resources`, use the `AWS::S3::Bucket`, `AWS::S3::BucketPolicy`, and `AWS::CloudTrail::Trail` AWS CloudFormation resources to provide a simple bucket definition and trail for CloudTrail. + * In a separate template, under `Resources`, use the `AWS::S3::Bucket`, `AWS::S3::BucketPolicy`, and `AWS::CloudTrail::Trail` CloudFormation resources to provide a simple bucket definition and trail for CloudTrail. @@ -2695 +2695 @@ JSON -When you use AWS CloudFormation to create these resources, your pipeline is triggered when files in your repository are created or updated. +When you use CloudFormation to create these resources, your pipeline is triggered when files in your repository are created or updated. @@ -2699 +2699 @@ When you use AWS CloudFormation to create these resources, your pipeline is trig -Do not stop here. Although your pipeline is created, you must create a second AWS CloudFormation template for your Amazon S3 pipeline. If you do not create the second template, your pipeline does not have any change detection functionality. +Do not stop here. Although your pipeline is created, you must create a second CloudFormation template for your Amazon S3 pipeline. If you do not create the second template, your pipeline does not have any change detection functionality. @@ -3412 +3412 @@ To do this, use the **create-connection** command. -A connection created through the AWS CLI or AWS CloudFormation is in `PENDING` status by default. After you create a connection with the CLI or AWS CloudFormation, use the console to edit the connection to make its status `AVAILABLE`. +A connection created through the AWS CLI or AWS CloudFormation is in `PENDING` status by default. After you create a connection with the CLI or CloudFormation, use the console to edit the connection to make its status `AVAILABLE`. @@ -3439 +3439 @@ You can migrate your pipeline to use webhooks to detect changes in your GitHub s - * **AWS CloudFormation:** Update pipelines for push events (GitHub (via OAuth app) source actions) (AWS CloudFormation template) + * **CloudFormation:** Update pipelines for push events (GitHub (via OAuth app) source actions) (CloudFormation template) @@ -3502 +3502 @@ To build an event-driven pipeline, you edit the `PollForSourceChanges` parameter -When you use the CLI or AWS CloudFormation to create a pipeline and add a webhook, you must disable periodic checks. To disable periodic checks, you must explicitly add the `PollForSourceChanges` parameter and set it to false, as detailed in the final procedure below. Otherwise, the default for a CLI or AWS CloudFormation pipeline is that `PollForSourceChanges` defaults to true and does not display in the pipeline structure output. For more information about PollForSourceChanges defaults, see [Valid settings for the PollForSourceChanges parameter](./PollForSourceChanges-defaults.html). +When you use the CLI or CloudFormation to create a pipeline and add a webhook, you must disable periodic checks. To disable periodic checks, you must explicitly add the `PollForSourceChanges` parameter and set it to false, as detailed in the final procedure below. Otherwise, the default for a CLI or CloudFormation pipeline is that `PollForSourceChanges` defaults to true and does not display in the pipeline structure output. For more information about PollForSourceChanges defaults, see [Valid settings for the PollForSourceChanges parameter](./PollForSourceChanges-defaults.html). @@ -3620 +3620 @@ The **update-pipeline** command stops the pipeline. If a revision is being run t -### Update pipelines for push events (GitHub (via OAuth app) source actions) (AWS CloudFormation template) +### Update pipelines for push events (GitHub (via OAuth app) source actions) (CloudFormation template) @@ -3626 +3626 @@ To build an event-driven pipeline with AWS CodeCommit, you edit the `PollForSour -If you use AWS CloudFormation to create and manage your pipelines, your template has content like the following. +If you use CloudFormation to create and manage your pipelines, your template has content like the following. @@ -3724 +3724 @@ We strongly recommend that you use AWS Secrets Manager to store your credentials -When passing secret parameters, do not enter the value directly into the template. The value is rendered as plaintext and is therefore readable. For security reasons, do not use plaintext in your AWS CloudFormation template to store your credentials. +When passing secret parameters, do not enter the value directly into the template. The value is rendered as plaintext and is therefore readable. For security reasons, do not use plaintext in your CloudFormation template to store your credentials. @@ -3726 +3726 @@ When passing secret parameters, do not enter the value directly into the templat -When you use the CLI or AWS CloudFormation to create a pipeline and add a webhook, you must disable periodic checks. +When you use the CLI or CloudFormation to create a pipeline and add a webhook, you must disable periodic checks. @@ -3730 +3730 @@ When you use the CLI or AWS CloudFormation to create a pipeline and add a webhoo -To disable periodic checks, you must explicitly add the `PollForSourceChanges` parameter and set it to false, as detailed in the final procedure below. Otherwise, the default for a CLI or AWS CloudFormation pipeline is that `PollForSourceChanges` defaults to true and does not display in the pipeline structure output. For more information about PollForSourceChanges defaults, see [Valid settings for the PollForSourceChanges parameter](./PollForSourceChanges-defaults.html). +To disable periodic checks, you must explicitly add the `PollForSourceChanges` parameter and set it to false, as detailed in the final procedure below. Otherwise, the default for a CLI or CloudFormation pipeline is that `PollForSourceChanges` defaults to true and does not display in the pipeline structure output. For more information about PollForSourceChanges defaults, see [Valid settings for the PollForSourceChanges parameter](./PollForSourceChanges-defaults.html). @@ -3759 +3759 @@ JSON - 2. Use the `AWS::CodePipeline::Webhook` AWS CloudFormation resource to add a webhook. + 2. Use the `AWS::CodePipeline::Webhook` CloudFormation resource to add a webhook. @@ -3826 +3826 @@ JSON - 3. Save the updated template to your local computer, and then open the AWS CloudFormation console. + 3. Save the updated template to your local computer, and then open the CloudFormation console. @@ -3830 +3830 @@ JSON - 5. Upload the template, and then view the changes listed in AWS CloudFormation. These are the changes to be made to the stack. You should see your new resources in the list. + 5. Upload the template, and then view the changes listed in CloudFormation. These are the changes to be made to the stack. You should see your new resources in the list. @@ -3904 +3904 @@ JSON -When you create these resources with AWS CloudFormation, the webhook defined is created in the specified GitHub repository. Your pipeline is triggered on commit. +When you create these resources with CloudFormation, the webhook defined is created in the specified GitHub repository. Your pipeline is triggered on commit.