1.204.0

interface CommonCloudFormationStackSetOptions

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.Actions.CommonCloudFormationStackSetOptions
Javasoftware.amazon.awscdk.services.codepipeline.actions.CommonCloudFormationStackSetOptions
Pythonaws_cdk.aws_codepipeline_actions.CommonCloudFormationStackSetOptions
TypeScript (source)@aws-cdk/aws-codepipeline-actions » CommonCloudFormationStackSetOptions

Options in common between both StackSet actions.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codepipeline_actions from '@aws-cdk/aws-codepipeline-actions';
const commonCloudFormationStackSetOptions: codepipeline_actions.CommonCloudFormationStackSetOptions = {
  failureTolerancePercentage: 123,
  maxAccountConcurrencyPercentage: 123,
  stackSetRegion: 'stackSetRegion',
};

Properties

NameTypeDescription
failureTolerancePercentage?numberThe percentage of accounts per Region for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.
maxAccountConcurrencyPercentage?numberThe maximum percentage of accounts in which to perform this operation at one time.
stackSetRegion?stringThe AWS Region the StackSet is in.

failureTolerancePercentage?

Type: number (optional, default: 0%)

The percentage of accounts per Region for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.

If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in subsequent Regions. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.

maxAccountConcurrencyPercentage?

Type: number (optional, default: 1%)

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. If rounding down would result in zero, AWS CloudFormation sets the number as one instead. Although you use this setting to specify the maximum, for large deployments the actual number of accounts acted upon concurrently may be lower due to service throttling.

stackSetRegion?

Type: string (optional, default: same region as the Pipeline)

The AWS Region the StackSet is in.

Note that a cross-region Pipeline requires replication buckets to function correctly. You can provide their names with the PipelineProps.crossRegionReplicationBuckets property. If you don't, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets, that you will need to cdk deploy before deploying the main, Pipeline-containing Stack.

← PreviousNext →