2.184.1

interface CloudFormationDeployStackInstancesActionProps

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.Actions.CloudFormationDeployStackInstancesActionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#CloudFormationDeployStackInstancesActionProps
Javasoftware.amazon.awscdk.services.codepipeline.actions.CloudFormationDeployStackInstancesActionProps
Pythonaws_cdk.aws_codepipeline_actions.CloudFormationDeployStackInstancesActionProps
TypeScript (source)aws-cdk-lib » aws_codepipeline_actions » CloudFormationDeployStackInstancesActionProps

Properties for the CloudFormationDeployStackInstancesAction.

Example

declare const pipeline: codepipeline.Pipeline;
declare const sourceOutput: codepipeline.Artifact;

pipeline.addStage({
  stageName: 'DeployStackSets',
  actions: [
    // First, update the StackSet itself with the newest template
    new codepipeline_actions.CloudFormationDeployStackSetAction({
      actionName: 'UpdateStackSet',
      runOrder: 1,
      stackSetName: 'MyStackSet',
      template: codepipeline_actions.StackSetTemplate.fromArtifactPath(sourceOutput.atPath('template.yaml')),

      // Change this to 'StackSetDeploymentModel.organizations()' if you want to deploy to OUs
      deploymentModel: codepipeline_actions.StackSetDeploymentModel.selfManaged(),
      // This deploys to a set of accounts
      stackInstances: codepipeline_actions.StackInstances.inAccounts(['111111111111'], ['us-east-1', 'eu-west-1']),
    }),

    // Afterwards, update/create additional instances in other accounts
    new codepipeline_actions.CloudFormationDeployStackInstancesAction({
      actionName: 'AddMoreInstances',
      runOrder: 2,
      stackSetName: 'MyStackSet',
      stackInstances: codepipeline_actions.StackInstances.inAccounts(
        ['222222222222', '333333333333'],
        ['us-east-1', 'eu-west-1']
      ),
    }),
  ],
});

Properties

NameTypeDescription
actionNamestringThe physical, human-readable name of the Action.
stackInstancesStackInstancesSpecify where to create or update Stack Instances.
stackSetNamestringThe name of the StackSet we are adding instances to.
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.
parameterOverrides?StackSetParametersParameter values that only apply to the current Stack Instances.
role?IRoleThe Role in which context's this Action will be executing in.
runOrder?numberThe runOrder property for this Action.
stackSetRegion?stringThe AWS Region the StackSet is in.
variablesNamespace?stringThe name of the namespace to use for variables emitted by this action.

actionName

Type: string

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

stackInstances

Type: StackInstances

Specify where to create or update Stack Instances.

You can specify either AWS Accounts Ids or AWS Organizations Organizational Units.

stackSetName

Type: string

The name of the StackSet we are adding instances to.

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.

parameterOverrides?

Type: StackSetParameters (optional, default: no parameters will be overridden)

Parameter values that only apply to the current Stack Instances.

These parameters are shared between all instances added by this action.

role?

Type: IRole (optional, default: a new Role will be generated)

The Role in which context's this Action will be executing in.

The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property.

runOrder?

Type: number (optional, default: 1)

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

See also: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

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.

variablesNamespace?

Type: string (optional, default: a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set)

The name of the namespace to use for variables emitted by this action.

← PreviousNext →