The resource representing registering a custom Action with CodePipeline.

For the Action to be usable, it has to be registered for every region and every account it's used in.
In addition to this class, you should most likely also provide your clients a class
representing your custom Action, extending the Action class,
and taking the `actionProperties` as properly typed, construction properties.

CustomActionRegistration

artifactBounds

provider

The properties used for customizing the instance of your Action.

actionProperties

The URL shown for the entire Action in the Pipeline UI.

entityUrl

The URL shown for a particular execution of an Action in the Pipeline UI.

executionUrl

version

An AWS CodePipeline pipeline with its associated IAM role and S3 bucket.

Creates a new Stage, and adds it to this Pipeline.

addStage

addToRolePolicy

addTrigger

addVariable

Returns a source configuration for notification rule.

bindAsNotificationRuleSource

Defines a CodeStar notification rule triggered when the pipeline events emitted by you specified, it very similar to `onEvent` API.

You can also use the methods `notifyOnExecutionStateChange`, `notifyOnAnyStageStateChange`,
`notifyOnAnyActionStateChange` and `notifyOnAnyManualApprovalStateChange`
to define rules for these specific event emitted.

notifyOn

Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline.

notifyOnAnyActionStateChange

Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline.

notifyOnAnyManualApprovalStateChange

Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline.

notifyOnAnyStageStateChange

Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline.

notifyOnExecutionStateChange

Defines an event rule triggered by this CodePipeline.

onEvent

Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.

onStateChange

Access one of the pipeline's stages by stage name.

stage

Pipeline

The S3 bucket used by this Pipeline to store artifacts.

artifactBucket

Create KMS keys for cross-account deployments.

This controls whether the pipeline is enabled for cross-account deployments.

By default cross-account deployments are enabled, but this feature requires
that KMS Customer Master Keys are created which have a cost of $1/month.

If you do not need cross-account deployments, you can set this to `false` to
not create those keys and save on that cost (the artifact bucket will be
encrypted with an AWS-managed key). However, cross-account deployments will
no longer be possible.

crossAccountKeys

A map of region to S3 bucket name used for cross-region CodePipeline.

For every Action that you specify targeting a different region than the Pipeline itself,
if you don't provide an explicit Bucket for that region using this property,
the construct will automatically create a Stack containing an S3 Bucket in that region.

crossRegionReplicationBuckets

Enable KMS key rotation for the generated KMS keys.

By default KMS key rotation is disabled, but will add an additional $1/month
for each year the key exists when enabled.

enableKeyRotation

The method that the pipeline will use to handle multiple executions.

executionMode

pipelineName

pipelineType

Indicates whether to rerun the AWS CodePipeline pipeline after you update it.

restartExecutionOnUpdate

Reuse the same cross region support stack for all pipelines in the App.

reuseCrossRegionSupportStacks

The IAM role to be assumed by this Pipeline.

role

The list of Stages, in order, to create this Pipeline with.

You can always add more Stages later by calling `Pipeline#addStage`.

stages

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

When a trigger configuration is specified, default change detection for repository
and branch commits is disabled.

`triggers` can only be used when `pipelineType` is set to `PipelineType.V2`.
You can always add more triggers later by calling `Pipeline#addTrigger`.

triggers

Use pipeline service role for actions if no action role configured.

usePipelineRoleForActions

A list that defines the pipeline variables for a pipeline resource.

`variables` can only be used when `pipelineType` is set to `PipelineType.V2`.
You can always add more variables later by calling `Pipeline#addVariable`.

variables

The `AWS::CodePipeline::CustomActionType` resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite.

You can use these custom actions in the stage of a pipeline. For more information, see [Create and Add a Custom Action in AWS CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) in the *AWS CodePipeline User Guide* .

CfnCustomActionType

The category of the custom action, such as a build action or a test action.

The details of the input artifact for the action, such as its commit ID.

inputArtifactDetails

The details of the output artifact of the action, such as its commit ID.

outputArtifactDetails

The provider of the service used in the custom action, such as CodeDeploy.

The version identifier of the custom action.

The configuration properties for the custom action.

> You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see [Create a Custom Action for a Pipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) .

configurationProperties

URLs that provide users information about this custom action.

settings

CfnPipeline

The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no `actionRoleArn` , or to use to assume roles for actions with an `actionRoleArn` .

roleArn

Represents information about a stage and its definition.

The S3 bucket where artifacts for the pipeline are stored.

> You must include either `artifactStore` or `artifactStores` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use `artifactStores` .

artifactStore

A mapping of `artifactStore` objects and their corresponding AWS Regions.

There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

> You must include either `artifactStore` or `artifactStores` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use `artifactStores` .

artifactStores

Represents the input of a `DisableStageTransition` action.

disableInboundStageTransitions

The method that the pipeline will use to handle multiple executions.

The default mode is SUPERSEDED.

name

CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

- V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.
- V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

> Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

For information about pricing for CodePipeline, see [Pricing](https://docs.aws.amazon.com/codepipeline/pricing/) .

For information about which type of pipeline to choose, see [What type of pipeline is right for me?](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types-planning.html) .

Indicates whether to rerun the CodePipeline pipeline after you update it.

Specifies the tags applied to the pipeline.

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

> When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

A list that defines the pipeline variables for a pipeline resource.

Variable names can have alphanumeric and underscore characters, and the values must match `[A-Za-z0-9@\-_]+` .

The `AWS::CodePipeline::Webhook` resource creates and registers your webhook.

After the webhook is created and registered, it triggers your pipeline to start every time an external event occurs. For more information, see [Migrate polling pipelines to use event-based change detection](https://docs.aws.amazon.com/codepipeline/latest/userguide/update-change-detection.html) in the *AWS CodePipeline User Guide* .

We strongly recommend that you use AWS Secrets Manager to store your credentials. If you use Secrets Manager, you must have already configured and stored your secret parameters in Secrets Manager. For more information, see [Using Dynamic References to Specify Template Values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) .

> 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.

CfnWebhook

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

> When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities. > If a secret token was provided, it will be redacted in the response.

- For information about the authentication scheme implemented by GITHUB_HMAC, see [Securing your webhooks](https://docs.aws.amazon.com/https://developer.github.com/webhooks/securing/) on the GitHub Developer website.
- IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
- UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

authentication

Properties that configure the authentication applied to incoming webhook trigger requests.

The required properties depend on the authentication type. For GITHUB_HMAC, only the `SecretToken` property must be set. For IP, only the `AllowedIPRange` property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

authenticationConfiguration

A list of rules applied to the body/payload sent in the POST request to a webhook URL.

All defined rules must pass for the request to be accepted and the pipeline started.

filters

The name of the action in a pipeline you want to connect to the webhook.

The action must be from the source (first) stage of the pipeline.

targetAction

The name of the pipeline you want to connect to the webhook.

targetPipeline

Configures a connection between the webhook that was created and the external tool with events to be detected.

registerWithThirdParty

The version number of the pipeline to be connected to the trigger request.

Required: Yes

Type: Integer

Update requires: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

AWS CodePipeline

L2 Constructs2

CustomActionRegistration

Pipeline

L1 Constructs3

CfnCustomActionType

CfnPipeline

CfnWebhook

Learn AWS the Practical Way

Quick Facts

Related Links

More AWS CodePipeline deep dives