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

Commit 5e718c4

Browse files
committed
Periodic update for the CodePipeline User Guide July 6 2021
1 parent 956cea2 commit 5e718c4

35 files changed

+638
-128
lines changed

doc_source/action-reference-CloudFormation.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,17 +60,13 @@ Required: Conditional
6060
**RoleArn**
6161
Required: Conditional
6262
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\.
63+
This role must be in the same account as the role for the action that is running, as configured in the action declaration `RoleArn`\.
6364
This property is required for the following action modes:
6465
+ CREATE\_UPDATE
6566
+ REPLACE\_ON\_FAILURE
6667
+ DELETE\_ONLY
6768
+ CHANGE\_SET\_REPLACE
68-
69-
**Note**
70-
This role must be in the same account as the role that the action is running as, configured in the action declaration `RoleArn`\.
71-
72-
**Note**
73-
CloudFormation is given an S3 signed URL to the template, and 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\.
69+
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\.
7470

7571
**TemplatePath**
7672
Required: Conditional
@@ -200,4 +196,4 @@ InputArtifacts:
200196

201197
The following related resources can help you as you work with this action\.
202198
+ [Configuration Properties Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html) – This reference chapter in the *AWS CloudFormation User Guide* provides more descriptions and examples for these CodePipeline parameters\.
203-
+ [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\.
199+
+ [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\.

doc_source/action-reference-CodeCommit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -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="w23aac45c29c25b3"></a>
92+
### Example for default output artifact format<a name="w23aac43c29c25b3"></a>
9393

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

148148
------
149149

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

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

doc_source/action-reference-CodestarConnectionSource.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# CodeStarSourceConnection for Bitbucket, GitHub, and GitHub Enterprise Server actions<a name="action-reference-CodestarConnectionSource"></a>
22

3-
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\.
3+
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**
66
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)\.
77

88
Connections can associate your AWS resources with the following third\-party repositories:
9-
+ Bitbucket \(through the **Bitbucket** provider option in the CodePipeline console\)
9+
+ Bitbucket Cloud \(through the **Bitbucket** provider option in the CodePipeline console\)
10+
**Note**
11+
You can create connections to a Bitbucket Cloud repository\. Installed Bitbucket provider types, such as Bitbucket Server, are not supported\.
1012
+ GitHub and GitHub Enterprise Cloud \(through the **GitHub \(Version 2\)** provider option in the CodePipeline console\)
1113
+ GitHub Enterprise Server \(through the **GitHub Enterprise Server** provider option in the CodePipeline console\)
1214

1315
**Note**
1416
Each connection supports all of the repositories you have with that provider\. You only need to create a new connection for each provider type\.
1517

18+
Connections allow your pipeline to detect source changes through the third\-party provider's installation app\. For example, webhooks are used to subscribe to GitHub event types and can be installed on an organization, a repository, or a GitHub App\. Your connection installs a repository webhook on your GitHub App that subscribes to GitHub push type events\.
19+
1620
After a code change is detected, you have the following options for passing the code to subsequent actions:
1721
+ Default: Like other existing CodePipeline source actions, `CodeStarSourceConnection` can output a ZIP file with a shallow copy of your commit\.
1822
+ Full clone: `CodeStarSourceConnection` can also be configured to output a URL reference to the repo for subsequent actions\.

doc_source/action-reference-Snyk.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Snyk action structure reference<a name="action-reference-Snyk"></a>
2+
3+
The **Snyk** action in CodePipeline automates detecting and fixing security vulnerabilities in your open source code\. You can use Snyk with application source code in your third\-party repository, such as GitHub or Bitbucket, or with images for container applications\. Your action will scan and report on vulnerability levels and alerts that you configure\.
4+
5+
**Topics**
6+
+ [Action type ID](#action-reference-Snyk-type)
7+
+ [Input artifacts](#action-reference-Snyk-input)
8+
+ [Output artifacts](#action-reference-Snyk-output)
9+
+ [See also](#action-reference-Snyk-links)
10+
11+
## Action type ID<a name="action-reference-Snyk-type"></a>
12+
+ Category: `Invoke`
13+
+ Owner: `ThirdParty`
14+
+ Provider: `Snyk`
15+
+ Version: `1`
16+
17+
Example:
18+
19+
```
20+
{
21+
"Category": "Invoke",
22+
"Owner": "ThirdParty",
23+
"Provider": "Snyk",
24+
"Version": "1"
25+
},
26+
```
27+
28+
## Input artifacts<a name="action-reference-Snyk-input"></a>
29+
+ **Number of Artifacts:** `1`
30+
+ **Description:** The files that make up the input artifact for the invoke action\.
31+
32+
## Output artifacts<a name="action-reference-Snyk-output"></a>
33+
+ **Number of Artifacts:** `1`
34+
+ **Description:** The files that make up the output artifact for the invoke action\.
35+
36+
## See also<a name="action-reference-Snyk-links"></a>
37+
38+
The following related resources can help you as you work with this action\.
39+
+ For more information about using Snyk actions in CodePipeline, refer to [Automate vulnerability scanning in CodePipeline with Snyk](https://snyk.io/blog/automate-vulnerability-scanning-in-aws-codepipeline-with-snyk/)\.

doc_source/action-reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,5 @@ This section is updated periodically with more action providers\. Reference info
2323
+ [CodeStarSourceConnection for Bitbucket, GitHub, and GitHub Enterprise Server actions](action-reference-CodestarConnectionSource.md)
2424
+ [AWS Device Farm](action-reference-DeviceFarm.md)
2525
+ [AWS Lambda](action-reference-Lambda.md)
26+
+ [Snyk](action-reference-Snyk.md)
2627
+ [AWS Step Functions](action-reference-StepFunctions.md)

doc_source/action-types.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,18 @@ Before you create your action definition file, executor resources, and action ty
4747

4848
### Step 1: Choose your integration model<a name="action-types-choose-model"></a>
4949

50-
Choose your integration model and then create the configuration for that model\. After you choose the integration model, you must configure your integration resources\.
51-
+ For the Lambda integration model, you create a Lambda function and add permissions\. Add permissions to your integrator Lambda function to provide the CodePipeline service with permissions to invoke it using the CodePipeline service principal: `codepipeline.amazonaws.com`\. The permissions can be added using CloudFormation or the command line\.
52-
+ [Sample code for adding permission via CloudFormation](https://code.amazon.com/packages/DuckHawkJobInvokerServiceInfrastructure/blobs/b9f9fa508c0c901e87e0909d05ad61ea49757b9b/--/configuration/cloudFormation/lambdaBasedTestRoles.template.yml#L72-L77)
50+
Choose your integration model and then create the configuration for that model\. After you choose the integration model, you must configure your integration resources\.
51+
+ For the Lambda integration model, you create a Lambda function and add permissions\. Add permissions to your integrator Lambda function to provide the CodePipeline service with permissions to invoke it using the CodePipeline service principal: `codepipeline.amazonaws.com`\. The permissions can be added using AWS CloudFormation or the command line\.
52+
+ Example for adding permissions using AWS CloudFormation:
53+
54+
```
55+
CodePipelineLambdaBasedActionPermission:
56+
Type: 'AWS::Lambda::Permission'
57+
Properties:
58+
Action: 'lambda:invokeFunction'
59+
FunctionName: {"Fn::Sub": "arn:${AWS::Partition}:lambda:${AWS::Region}:${AWS::AccountId}:function:function-name"}
60+
Principal: codepipeline.amazonaws.com
61+
```
5362
+ [Documentation for command line](https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html)
5463
+ For the job worker integration model, you create an integration with a list of allowed accounts where the job worker polls for jobs with the CodePipeline APIs\.
5564
@@ -265,7 +274,7 @@ Your customers can optionally use the CLI to add the action type to their pipeli
265274
266275
1. To test your action, commit a change to the source specified in the source stage of the pipeline or follow the steps in [Manually Start a Pipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-manually-start.html)\.
267276
268-
To create a pipeline with your action type, follow the steps in [Create a Pipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-pipelines) and choose your action type from as many stages as you will test\.
277+
To create a pipeline with your action type, follow the steps in [Create a pipeline in CodePipeline](pipelines-create.md) and choose your action type from as many stages as you will test\.
269278
270279
## View an action type<a name="action-types-view-cli"></a>
271280

doc_source/actions-invoke-lambda-function.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,11 +140,11 @@ The event object, under the CodePipeline\.job key, contains the [job details](ht
140140
// Retrieve the Job ID from the Lambda action
141141
var jobId = event["CodePipeline.job"].id;
142142
143-
// Retrieve the value of UserParameters from the Lambda action configuration in AWS CodePipeline, in this case a URL which will be
143+
// Retrieve the value of UserParameters from the Lambda action configuration in CodePipeline, in this case a URL which will be
144144
// health checked by this function.
145145
var url = event["CodePipeline.job"].data.actionConfiguration.configuration.UserParameters;
146146
147-
// Notify AWS CodePipeline of a successful job
147+
// Notify CodePipeline of a successful job
148148
var putJobSuccess = function(message) {
149149
var params = {
150150
jobId: jobId
@@ -158,7 +158,7 @@ The event object, under the CodePipeline\.job key, contains the [job details](ht
158158
});
159159
};
160160
161-
// Notify AWS CodePipeline of a failed job
161+
// Notify CodePipeline of a failed job
162162
var putJobFailure = function(message) {
163163
var params = {
164164
jobId: jobId,

doc_source/actions-retry.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,19 @@ In AWS CodePipeline, an action is a task performed on an artifact in a stage\. A
44

55
You can retry the latest failed actions in a stage without having to run a pipeline again from the beginning\. You do this by retrying the stage that contains the actions\. You can retry a stage immediately after any of actions fail\. All actions that are still in progress continue their work, and failed actions are triggered once again\.
66

7+
**Note**
8+
In the following cases, you may not be able to retry actions:
9+
The overall pipeline structure changed after an action failed\.
10+
Another retry attempt in the stage is already in progress\.
11+
12+
In cases where you have edited your pipeline structure and so the failed action cannot be retried, choose **Release change** to manually start the pipeline\.
13+
714
If you are using the console to view a pipeline, a **Retry** button appears on the stage where the failed actions can be retried\.
815

916
![\[A stage that contains one or more failed actions displays a Retry button\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/images/actions-retry-button.png)![\[A stage that contains one or more failed actions displays a Retry button\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/)![\[A stage that contains one or more failed actions displays a Retry button\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/)
1017

1118
If you are using the AWS CLI, you can use the get\-pipeline\-state command to determine whether any actions have failed\.
1219

13-
**Note**
14-
In the following cases, you may not be able to retry actions:
15-
The overall pipeline structure changed after an action failed\.
16-
Another retry attempt in the stage is already in progress\.
17-
1820
**Topics**
1921
+ [Retry failed actions \(console\)](#actions-retry-console)
2022
+ [Retry failed actions \(CLI\)](#actions-retry-cli)

doc_source/best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ At any time, you can integrate your preferred IDE into your AWS CodeStar dashboa
8181

8282
### Use CodePipeline to compile, build, and test code with CodeBuild<a name="use-cases-codebuild"></a>
8383

84-
CodeBuild is a managed build service in the cloud that lets you build and test your code without a server or system\. Use CodePipeline with CodeBuild to automate running revisions through the pipeline for continuous delivery of software builds whenever there is a change to the source code\. For more information, see [Use AWS CodePipeline with CodeBuild to test code and run builds](https://docs.aws.amazon.com/codebuild/latest/userguide/how-to-create-pipeline.html)\.
84+
CodeBuild is a managed build service in the cloud that lets you build and test your code without a server or system\. Use CodePipeline with CodeBuild to automate running revisions through the pipeline for continuous delivery of software builds whenever there is a change to the source code\. For more information, see [Use CodePipeline with CodeBuild to test code and run builds](https://docs.aws.amazon.com/codebuild/latest/userguide/how-to-create-pipeline.html)\.
8585

8686
### Use CodePipeline with Amazon ECS for continuous delivery of container\-based applications to the cloud<a name="use-cases-ecs"></a>
8787

doc_source/connections-bitbucket.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ Connections allow you to authorize and establish configurations that associate y
55
**Note**
66
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)\.
77

8-
To add a Bitbucket source action in CodePipeline, you can choose either to:
8+
To add a Bitbucket Cloud source action in CodePipeline, you can choose either to:
99
+ Use the CodePipeline console **Create pipeline** wizard or **Edit action** page to choose the **Bitbucket** provider option\. See [Create a connection to Bitbucket \(console\)](#connections-bitbucket-console) to add the action\. The console helps you create a connections resource\.
10+
**Note**
11+
You can create connections to a Bitbucket Cloud repository\. Installed Bitbucket provider types, such as Bitbucket Server, are not supported\.
1012
+ Use the CLI to add the action configuration for the `CreateSourceConnection` action with the `Bitbucket` provider as follows:
1113
+ To create your connections resources, see [Create a connection to Bitbucket \(CLI\)](#connections-bitbucket-cli) to create a connections resource with the CLI\.
1214
+ Use the `CreateSourceConnection` example action configuration in [CodeStarSourceConnection for Bitbucket, GitHub, and GitHub Enterprise Server actions](action-reference-CodestarConnectionSource.md) to add your action as shown in [Create a pipeline \(CLI\)](pipelines-create.md#pipelines-create-cli)\.
@@ -18,6 +20,9 @@ Before you begin:
1820
+ You must have created an account with the provider of the third\-party repository, such as Bitbucket\.
1921
+ You must have already created a third\-party code repository, such as a Bitbucket repository\.
2022

23+
**Note**
24+
Bitbucket connections only provide access to repositories owned by the Bitbucket account that was used to create the connection\.
25+
2126
**Topics**
2227
+ [Create a connection to Bitbucket \(console\)](#connections-bitbucket-console)
2328
+ [Create a connection to Bitbucket \(CLI\)](#connections-bitbucket-cli)
@@ -27,7 +32,7 @@ Before you begin:
2732
Use these steps to use the CodePipeline console to add a connections action for your Bitbucket repository\.
2833

2934
**Note**
30-
Bitbucket connections only provide access to repositories owned by the Bitbucket account that was used to create the connection\.
35+
You can create connections to a Bitbucket Cloud repository\. Installed Bitbucket provider types, such as Bitbucket Server, are not supported\.
3136

3237
### Step 1: Create or edit your pipeline<a name="connections-bitbucket-console-action"></a>
3338

@@ -62,10 +67,10 @@ You install one app for all of your connections to a particular provider\. If yo
6267
1. If the login page for Bitbucket displays, log in with your credentials and then choose to continue\.
6368

6469
1. On the app installation page, a message shows that the AWS CodeStar app is trying to connect to your Bitbucket account\. Choose **Grant access**\.
65-
![\[Console screenshot showing AWS CodeStar requests access.\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/images/bitbucket-access-popup.png)![\[Console screenshot showing AWS CodeStar requests access.\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/)![\[Console screenshot showing AWS CodeStar requests access.\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/)
70+
![\[Console screenshot showing request for access.\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/images/bitbucket-access-popup.png)![\[Console screenshot showing request for access.\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/)![\[Console screenshot showing request for access.\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/)
6671

6772
1. In **Bitbucket apps**, the connection ID for your new installation is displayed\. Choose **Connect**\. The created connection displays in the connections list\.
68-
![\[Console screenshot showing AWS CodeStar requests access.\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/images/create-connection-bitbucket-app-ID.png)![\[Console screenshot showing AWS CodeStar requests access.\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/)![\[Console screenshot showing AWS CodeStar requests access.\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/)
73+
![\[Console screenshot showing request for access.\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/images/create-connection-bitbucket-app-ID.png)![\[Console screenshot showing request for access.\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/)![\[Console screenshot showing request for access.\]](http://docs.aws.amazon.com/codepipeline/latest/userguide/)
6974

7075
### Step 3: Save your Bitbucket source action<a name="connections-bitbucket-console-save"></a>
7176

@@ -87,6 +92,9 @@ Use these steps on the wizard or **Edit action** page to save your source action
8792

8893
You can use the AWS Command Line Interface \(AWS CLI\) to create a connection\.
8994

95+
**Note**
96+
You can create connections to a Bitbucket Cloud repository\. Installed Bitbucket provider types, such as Bitbucket Server, are not supported\.
97+
9098
To do this, use the create\-connection command\.
9199

92100
**Important**

0 commit comments

Comments
 (0)