Skip to content
This repository was archived by the owner on Jun 15, 2023. It is now read-only.

Commit 9342aee

Browse files
committed
Periodic update - 07/25/22
1 parent ef9cbbd commit 9342aee

File tree

84 files changed

+733
-643
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+733
-643
lines changed

Diff for: doc_source/S3-artifact-encryption.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ For more information about AWS KMS, see the [AWS Key Management Service Develope
5252
+ [View your AWS managed key](#S3-view-default-keys)
5353
+ [Configure server\-side encryption for S3 buckets using AWS CloudFormation or the AWS CLI](#S3-rotate-customer-key)
5454

55-
### View your AWS managed key<a name="S3-view-default-keys"></a>
55+
## View your AWS managed key<a name="S3-view-default-keys"></a>
5656

5757
When you use the **Create Pipeline** wizard to create your first pipeline, an S3 bucket is created for you in the same Region you created the pipeline\. The bucket is used to store pipeline artifacts\. When a pipeline runs, artifacts are put into and retrieved from the S3 bucket\. By default, CodePipeline uses server\-side encryption with AWS KMS using the AWS managed key for Amazon S3 \(the `aws/s3` key\)\. This AWS managed key is created and stored in your AWS account\. When artifacts are retrieved from the S3 bucket, CodePipeline uses the same SSE\-KMS process to decrypt the artifact\.
5858

@@ -72,7 +72,7 @@ When you use the **Create Pipeline** wizard to create your first pipeline, an S3
7272

7373

7474

75-
### Configure server\-side encryption for S3 buckets using AWS CloudFormation or the AWS CLI<a name="S3-rotate-customer-key"></a>
75+
## Configure server\-side encryption for S3 buckets using AWS CloudFormation or the AWS CLI<a name="S3-rotate-customer-key"></a>
7676

7777
When you use AWS CloudFormation or the AWS CLI to create a pipeline, you must configure server\-side encryption manually\. Use the sample bucket policy above, and then create your owncustomer managed key\. You can also use your own keys instead of the AWS managed key\. Some reasons to choose your own key include:
7878
+ You want to rotate the key on a schedule to meet business or security requirements for your organization\.

Diff for: doc_source/action-reference-AppConfig.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Required: No
3333
The AWS AppConfig deployment strategy to use for deployment\.
3434

3535
## Input artifacts<a name="action-reference-AppConfig-input"></a>
36-
+ **Number of Artifacts:** `1`
36+
+ **Number of artifacts:** `1`
3737
+ **Description:** The input artifact for the deploy action\.
3838

3939
## Output artifacts<a name="action-reference-AppConfig-output"></a>

Diff for: doc_source/action-reference-CloudFormation.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
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\.
44

5+
**Note**
6+
57
**Topics**
68
+ [Action type](#action-reference-CloudFormation-type)
79
+ [Configuration parameters](#action-reference-CloudFormation-config)
@@ -107,14 +109,14 @@ The template configuration file name follows this format:
107109
```
108110

109111
## Input artifacts<a name="action-reference-CloudFormation-input"></a>
110-
+ **Number of Artifacts:** `0 to 10`
112+
+ **Number of artifacts:** `0 to 10`
111113
+ **Description:** As input, the AWS CloudFormation action optionally accepts artifacts for these purposes:
112114
+ To provide the stack template file to execute\. \(See the `TemplatePath` parameter\.\)
113115
+ To provide the template configuration file to use\. \(See the `TemplateConfiguration` parameter\.\) For more information about the template configuration file format, see [AWS CloudFormation Artifacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-cfn-artifacts.html)\.
114116
+ To provide the artifact for a Lambda function to be deployed as part of the AWS CloudFormation stack\.
115117

116118
## Output artifacts<a name="action-reference-CloudFormation-output"></a>
117-
+ **Number of Artifacts:** `0 to 1`
119+
+ **Number of artifacts:** `0 to 1`
118120
+ **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\.
119121

120122
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)\.

Diff for: doc_source/action-reference-CodeBuild.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ When you enter the `name`, `value`, and `type` for your environment variables co
5454
For more information, see [ EnvironmentVariable](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_EnvironmentVariable.html)\.
5555

5656
## Input artifacts<a name="action-reference-CodeBuild-input"></a>
57-
+ **Number of Artifacts:** `1 to 5`
57+
+ **Number of artifacts:** `1 to 5`
5858
+ **Description:** CodeBuild looks for the build spec file and runs the build spec commands from the directory of the primary source artifact\. When more than one input source is specified for the CodeBuild action, this artifact must be set using the `PrimarySource` action configuration parameter in CodePipeline\.
5959

6060
Each input artifact is extracted to its own directory, the locations of which are stored in environment variables\. The directory for the primary source artifact is made available with `$CODEBUILD_SRC_DIR`\. The directories for all other input artifacts are made available with `$CODEBUILD_SRC_DIR_yourInputArtifactName`\.
6161
**Note**
6262
The artifact configured in your CodeBuild project becomes the input artifact used by the CodeBuild action in your pipeline\.
6363

6464
## Output artifacts<a name="action-reference-CodeBuild-output"></a>
65-
+ **Number of Artifacts:** `0 to 5`
65+
+ **Number of artifacts:** `0 to 5`
6666
+ **Description:** These can be used to make the artifacts that are defined in the CodeBuild build spec file available to subsequent actions in the pipeline\. When only one output artifact is defined, this artifact can be defined directly under the `artifacts` section of the build spec file\. When more than one output artifact is specified, all artifacts referenced must be defined as secondary artifacts in the build spec file\. The names of the output artifacts in CodePipeline must match the artifact identifiers in the build spec file\.
6767
**Note**
6868
The artifact configured in your CodeBuild project becomes the CodePipeline input artifact in your pipeline action\.

Diff for: doc_source/action-reference-CodeCommit.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ The `CODEBUILD_CLONE_REF` option can only be used by CodeBuild downstream action
5454
If you choose this option, you need to add the `codecommit:GitPull` permission to your CodeBuild service role as shown in [Add CodeBuild GitClone permissions for CodeCommit source actions](troubleshooting.md#codebuild-role-codecommitclone)\. You also need to add the `codecommit:GetRepository` permission to your CodePipeline service role as shown in [Add permissions to the CodePipeline service role](security-iam.md#how-to-update-role-new-services)\. For a tutorial that shows you how to use the **Full clone** option, see [Tutorial: Use full clone with a CodeCommit pipeline source](tutorials-codecommit-gitclone.md)\.
5555

5656
## Input artifacts<a name="action-reference-CodeCommit-input"></a>
57-
+ **Number of Artifacts:** `0`
57+
+ **Number of artifacts:** `0`
5858
+ **Description:** Input artifacts do not apply for this action type\.
5959

6060
## Output artifacts<a name="action-reference-CodeCommit-output"></a>
61-
+ **Number of Artifacts:** `1`
61+
+ **Number of artifacts:** `1`
6262
+ **Description:** The output artifact of this action is a ZIP file that contains the contents of the configured repository and branch at the commit specified as the source revision for the pipeline execution\. The artifacts generated from the repository are the output artifacts for the CodeCommit action\. The source code commit ID is displayed in CodePipeline as the source revision for the triggered pipeline execution\.
6363

6464
## Output variables<a name="action-reference-CodeCommit-variables"></a>
@@ -89,7 +89,7 @@ For more information about the difference between an author and a committer in G
8989

9090
## Example action configuration<a name="action-reference-CodeCommit-example"></a>
9191

92-
### Example for default output artifact format<a name="w23aac44c29c25b3"></a>
92+
### Example for default output artifact format<a name="w23aac42c31c25b3"></a>
9393

9494
------
9595
#### [ YAML ]
@@ -147,7 +147,7 @@ Actions:
147147

148148
------
149149

150-
### Example for full clone output artifact format<a name="w23aac44c29c25b5"></a>
150+
### Example for full clone output artifact format<a name="w23aac42c31c25b5"></a>
151151

152152
------
153153
#### [ YAML ]

Diff for: doc_source/action-reference-CodeDeploy.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@
33
You use an AWS CodeDeploy action to deploy application code to your deployment fleet\. Your deployment fleet can consist of Amazon EC2 instances, on\-premises instances, or both\.
44

55
**Note**
6-
This reference topic describes the CodeDeploy deployment action for CodePipeline where the deployment platform is Amazon EC2\. For reference information about Amazon Elastic Container Service to CodeDeploy blue/green deployment actions in CodePipeline, see [Amazon Elastic Container Service and CodeDeploy Blue\-Green](action-reference-ECSbluegreen.md)\.
6+
This reference topic describes the CodeDeploy deployment action for CodePipeline where the deployment platform is Amazon EC2\. For reference information about Amazon Elastic Container Service to CodeDeploy blue/green deployment actions in CodePipeline, see [Amazon Elastic Container Service and CodeDeploy blue\-green](action-reference-ECSbluegreen.md)\.
77

88
**Topics**
9-
+ [Action Type](#action-reference-CodeDeploy-type)
10-
+ [Configuration Parameters](#action-reference-CodeDeploy-config)
11-
+ [Input Artifacts](#action-reference-CodeDeploy-input)
12-
+ [Output Artifacts](#action-reference-CodeDeploy-output)
13-
+ [Action Declaration](#action-reference-CodeDeploy-example)
14-
+ [See Also](#action-reference-CodeDeploy-links)
15-
16-
## Action Type<a name="action-reference-CodeDeploy-type"></a>
9+
+ [Action type](#action-reference-CodeDeploy-type)
10+
+ [Configuration parameters](#action-reference-CodeDeploy-config)
11+
+ [Input artifacts](#action-reference-CodeDeploy-input)
12+
+ [Output artifacts](#action-reference-CodeDeploy-output)
13+
+ [Action declaration](#action-reference-CodeDeploy-example)
14+
+ [See also](#action-reference-CodeDeploy-links)
15+
16+
## Action type<a name="action-reference-CodeDeploy-type"></a>
1717
+ Category: `Deploy`
1818
+ Owner: `AWS`
1919
+ Provider: `CodeDeploy`
2020
+ Version: `1`
2121

22-
## Configuration Parameters<a name="action-reference-CodeDeploy-config"></a>
22+
## Configuration parameters<a name="action-reference-CodeDeploy-config"></a>
2323

2424
**ApplicationName**
2525
Required: Yes
@@ -29,8 +29,8 @@ The name of the application that you created in CodeDeploy\.
2929
Required: Yes
3030
The deployment group that you created in CodeDeploy\.
3131

32-
## Input Artifacts<a name="action-reference-CodeDeploy-input"></a>
33-
+ **Number of Artifacts:** `1`
32+
## Input artifacts<a name="action-reference-CodeDeploy-input"></a>
33+
+ **Number of artifacts:** `1`
3434
+ **Description:** The AppSpec file that CodeDeploy uses to determine:
3535
+ What to install onto your instances from your application revision in Amazon S3 or GitHub\.
3636
+ Which lifecycle event hooks to run in response to deployment lifecycle events\.
@@ -39,11 +39,11 @@ The deployment group that you created in CodeDeploy\.
3939

4040

4141

42-
## Output Artifacts<a name="action-reference-CodeDeploy-output"></a>
43-
+ **Number of Artifacts:** `0`
42+
## Output artifacts<a name="action-reference-CodeDeploy-output"></a>
43+
+ **Number of artifacts:** `0`
4444
+ **Description:** Output artifacts do not apply for this action type\.
4545

46-
## Action Declaration<a name="action-reference-CodeDeploy-example"></a>
46+
## Action declaration<a name="action-reference-CodeDeploy-example"></a>
4747

4848
------
4949
#### [ YAML ]
@@ -103,7 +103,7 @@ Actions:
103103

104104
------
105105

106-
## See Also<a name="action-reference-CodeDeploy-links"></a>
106+
## See also<a name="action-reference-CodeDeploy-links"></a>
107107

108108
The following related resources can help you as you work with this action\.
109109
+ [Tutorial: Create a simple pipeline \(S3 bucket\)](tutorials-simple-s3.md) – This tutorial walks you through the creation of a source bucket, EC2 instances, and CodeDeploy resources to deploy a sample application\. You then build your pipeline with a CodeDeploy deployment action that deploys code maintained in your S3 bucket to your Amazon EC2 instance\.

Diff for: doc_source/action-reference-CodestarConnectionSource.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Triggers a pipeline when a new commit is made on a third\-party source code repository\. The source action retrieves code changes when a pipeline is manually run or when a webhook event is sent from the source provider\.
44

55
**Note**
6-
This feature is not available in the Asia Pacific \(Hong Kong\) or Europe \(Milan\) Region\. To use other source actions available in that Region, see [Source action integrations](integrations-action-type.md#integrations-source)\.
6+
This feature is not available in the Asia Pacific \(Hong Kong\) and Europe \(Milan\) Regions\. To reference other available actions, see [Product and service integrations with CodePipeline](integrations.md)\.
77

88
Connections can associate your AWS resources with the following third\-party repositories:
99
+ Bitbucket Cloud \(through the **Bitbucket** provider option in the CodePipeline console\)
@@ -72,11 +72,11 @@ Controls automatically starting your pipeline when a new commit is made on the c
7272
+ `false`: CodePipeline does not start your pipeline on new commits\.
7373

7474
## Input artifacts<a name="action-reference-CodestarConnectionSource-input"></a>
75-
+ **Number of Artifacts:** `0`
75+
+ **Number of artifacts:** `0`
7676
+ **Description:** Input artifacts do not apply for this action type\.
7777

7878
## Output artifacts<a name="action-reference-CodestarConnectionSource-output"></a>
79-
+ **Number of Artifacts:** `1`
79+
+ **Number of artifacts:** `1`
8080
+ **Description:** The artifacts generated from the repository are the output artifacts for the `CodeStarSourceConnection` action\. The source code commit ID is displayed in CodePipeline as the source revision for the triggered pipeline execution\. You can configure the output artifact of this action in:
8181
+ A ZIP file that contains the contents of the configured repository and branch at the commit specified as the source revision for the pipeline execution\.
8282
+ A JSON file that contains a URL reference to the repository so that downstream actions can perform Git commands directly\.

Diff for: doc_source/action-reference-DeviceFarm.md

+16-14
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,23 @@
22

33
In your pipeline, you can configure a test action that uses AWS Device Farm to run and test your application on devices\. Device Farm uses test pools of devices and testing frameworks to test applications on specific devices\. For information about the types of testing frameworks supported by the Device Farm action, see [Working with Test Types in AWS Device Farm](https://docs.aws.amazon.com/devicefarm/latest/developerguide/test-types.html)\.
44

5+
**Note**
6+
57
**Topics**
6-
+ [Action Type](#action-reference-DeviceFarm-type)
7-
+ [Configuration Parameters](#action-reference-DeviceFarm-config)
8-
+ [Input Artifacts](#action-reference-DeviceFarm-input)
9-
+ [Output Artifacts](#action-reference-DeviceFarm-output)
10-
+ [Action Declaration](#action-reference-DeviceFarm-example)
11-
+ [See Also](#action-reference-DeviceFarm-links)
12-
13-
## Action Type<a name="action-reference-DeviceFarm-type"></a>
8+
+ [Action type](#action-reference-DeviceFarm-type)
9+
+ [Configuration parameters](#action-reference-DeviceFarm-config)
10+
+ [Input artifacts](#action-reference-DeviceFarm-input)
11+
+ [Output artifacts](#action-reference-DeviceFarm-output)
12+
+ [Action declaration](#action-reference-DeviceFarm-example)
13+
+ [See also](#action-reference-DeviceFarm-links)
14+
15+
## Action type<a name="action-reference-DeviceFarm-type"></a>
1416
+ Category: `Test`
1517
+ Owner: `AWS`
1618
+ Provider: `DeviceFarm`
1719
+ Version: `1`
1820

19-
## Configuration Parameters<a name="action-reference-DeviceFarm-config"></a>
21+
## Configuration parameters<a name="action-reference-DeviceFarm-config"></a>
2022

2123
**AppType**
2224
Required: Yes
@@ -138,15 +140,15 @@ The latitude of the device expressed in geographic coordinate system degrees\.
138140
Required: No
139141
The longitude of the device expressed in geographic coordinate system degrees\.
140142

141-
## Input Artifacts<a name="action-reference-DeviceFarm-input"></a>
142-
+ **Number of Artifacts:** `1`
143+
## Input artifacts<a name="action-reference-DeviceFarm-input"></a>
144+
+ **Number of artifacts:** `1`
143145
+ **Description:** The set of artifacts to be made available to the test action\. Device Farm looks for the built application and test definitions to use\.
144146

145-
## Output Artifacts<a name="action-reference-DeviceFarm-output"></a>
147+
## Output artifacts<a name="action-reference-DeviceFarm-output"></a>
146148
+ **Number of Artifacts:** `0`
147149
+ **Description:** Output artifacts do not apply for this action type\.
148150

149-
## Action Declaration<a name="action-reference-DeviceFarm-example"></a>
151+
## Action declaration<a name="action-reference-DeviceFarm-example"></a>
150152

151153
------
152154
#### [ YAML ]
@@ -215,7 +217,7 @@ Actions:
215217

216218
------
217219

218-
## See Also<a name="action-reference-DeviceFarm-links"></a>
220+
## See also<a name="action-reference-DeviceFarm-links"></a>
219221

220222
The following related resources can help you as you work with this action\.
221223
+ [Working with Test Types in Device Farm](https://docs.aws.amazon.com/devicefarm/latest/developerguide/test-types.html) – This reference chapter in the *Device Farm Developer Guide* provides more description about the Android, iOS, and Web Application testing frameworks supported by Device Farm\.

Diff for: doc_source/action-reference-ECR.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ The tag used for the image\.
3333
If a value for `ImageTag` is not specified, the value defaults to `latest`\.
3434

3535
## Input artifacts<a name="action-reference-ECR-input"></a>
36-
+ **Number of Artifacts:** `0`
36+
+ **Number of artifacts:** `0`
3737
+ **Description:** Input artifacts do not apply for this action type\.
3838

3939
## Output artifacts<a name="action-reference-ECR-output"></a>
40-
+ **Number of Artifacts:** `1`
40+
+ **Number of artifacts:** `1`
4141
+ **Description:** This action produces an artifact that contains an `imageDetail.json` file that contains the URI for the image that triggered the pipeline execution\. For information about the `imageDetail.json` file, see [imageDetail\.json file for Amazon ECS blue/green deployment actions](file-reference.md#file-reference-ecs-bluegreen)\.
4242

4343
## Output variables<a name="action-reference-ECR-variables"></a>

0 commit comments

Comments
 (0)