CloudFormationDeployStackInstancesAction Class

CodePipeline action to create/update Stack Instances of a StackSet.

After the initial creation of a stack set, you can add new stack instances by using CloudFormationStackInstances. Template parameter values can be overridden at the stack instance level during create or update stack set instance operations.

Each stack set has one template and set of template parameters. When you update the template or template parameters, you update them for the entire set. Then all instance statuses are set to OUTDATED until the changes are deployed to that instance.

Source: aws-codepipeline-actions/lib/cloudformation/stackinstances-action.ts
Type last changed: v2.13.0 · 19 Feb 2022

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']
      ),
    }),
  ],
});

python

# pipeline: codepipeline.Pipeline
# source_output: codepipeline.Artifact


pipeline.add_stage(
    stage_name="DeployStackSets",
    actions=[
        # First, update the StackSet itself with the newest template
        codepipeline_actions.CloudFormationDeployStackSetAction(
            action_name="UpdateStackSet",
            run_order=1,
            stack_set_name="MyStackSet",
            template=codepipeline_actions.StackSetTemplate.from_artifact_path(source_output.at_path("template.yaml")),

            # Change this to 'StackSetDeploymentModel.organizations()' if you want to deploy to OUs
            deployment_model=codepipeline_actions.StackSetDeploymentModel.self_managed(),
            # This deploys to a set of accounts
            stack_instances=codepipeline_actions.StackInstances.in_accounts(["111111111111"], ["us-east-1", "eu-west-1"])
        ),

        # Afterwards, update/create additional instances in other accounts
        codepipeline_actions.CloudFormationDeployStackInstancesAction(
            action_name="AddMoreInstances",
            run_order=2,
            stack_set_name="MyStackSet",
            stack_instances=codepipeline_actions.StackInstances.in_accounts(["222222222222", "333333333333"], ["us-east-1", "eu-west-1"])
        )
    ]
)

java

Pipeline pipeline;
Artifact sourceOutput;


pipeline.addStage(StageOptions.builder()
        .stageName("DeployStackSets")
        .actions(List.of(
            // First, update the StackSet itself with the newest template
            CloudFormationDeployStackSetAction.Builder.create()
                    .actionName("UpdateStackSet")
                    .runOrder(1)
                    .stackSetName("MyStackSet")
                    .template(StackSetTemplate.fromArtifactPath(sourceOutput.atPath("template.yaml")))

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

            // Afterwards, update/create additional instances in other accounts
            CloudFormationDeployStackInstancesAction.Builder.create()
                    .actionName("AddMoreInstances")
                    .runOrder(2)
                    .stackSetName("MyStackSet")
                    .stackInstances(StackInstances.inAccounts(List.of("222222222222", "333333333333"), List.of("us-east-1", "eu-west-1")))
                    .build()))
        .build());

csharp

// Install: dotnet add package Amazon.CDK.Lib
Pipeline pipeline;
Artifact sourceOutput;


pipeline.AddStage(new StageOptions {
    StageName = "DeployStackSets",
    Actions = new [] {
        // First, update the StackSet itself with the newest template
        new CloudFormationDeployStackSetAction(new CloudFormationDeployStackSetActionProps {
            ActionName = "UpdateStackSet",
            RunOrder = 1,
            StackSetName = "MyStackSet",
            Template = StackSetTemplate.FromArtifactPath(sourceOutput.AtPath("template.yaml")),

            // Change this to 'StackSetDeploymentModel.organizations()' if you want to deploy to OUs
            DeploymentModel = StackSetDeploymentModel.SelfManaged(),
            // This deploys to a set of accounts
            StackInstances = StackInstances.InAccounts(new [] { "111111111111" }, new [] { "us-east-1", "eu-west-1" })
        }),

        // Afterwards, update/create additional instances in other accounts
        new CloudFormationDeployStackInstancesAction(new CloudFormationDeployStackInstancesActionProps {
            ActionName = "AddMoreInstances",
            RunOrder = 2,
            StackSetName = "MyStackSet",
            StackInstances = StackInstances.InAccounts(new [] { "222222222222", "333333333333" }, new [] { "us-east-1", "eu-west-1" })
        }) }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var pipeline Pipeline
var sourceOutput Artifact


pipeline.AddStage(&StageOptions{
	StageName: jsii.String("DeployStackSets"),
	Actions: []IAction{
		// First, update the StackSet itself with the newest template
		codepipeline_actions.NewCloudFormationDeployStackSetAction(&CloudFormationDeployStackSetActionProps{
			ActionName: jsii.String("UpdateStackSet"),
			RunOrder: jsii.Number(1),
			StackSetName: jsii.String("MyStackSet"),
			Template: codepipeline_actions.StackSetTemplate_FromArtifactPath(sourceOutput.AtPath(jsii.String("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([]*string{
				jsii.String("111111111111"),
			}, []*string{
				jsii.String("us-east-1"),
				jsii.String("eu-west-1"),
			}),
		}),

		// Afterwards, update/create additional instances in other accounts
		codepipeline_actions.NewCloudFormationDeployStackInstancesAction(&CloudFormationDeployStackInstancesActionProps{
			ActionName: jsii.String("AddMoreInstances"),
			RunOrder: jsii.Number(2),
			StackSetName: jsii.String("MyStackSet"),
			StackInstances: codepipeline_actions.StackInstances_*InAccounts([]*string{
				jsii.String("222222222222"),
				jsii.String("333333333333"),
			}, []*string{
				jsii.String("us-east-1"),
				jsii.String("eu-west-1"),
			}),
		}),
	},
})

Initializer

new CloudFormationDeployStackInstancesAction(props: CloudFormationDeployStackInstancesActionProps)

python

CloudFormationDeployStackInstancesAction(props: CloudFormationDeployStackInstancesActionProps)

java

new CloudFormationDeployStackInstancesAction(CloudFormationDeployStackInstancesActionProps props)

csharp

new CloudFormationDeployStackInstancesAction(CloudFormationDeployStackInstancesActionProps props)

NewCloudFormationDeployStackInstancesAction(Props CloudFormationDeployStackInstancesActionProps)

Properties

actionPropertiesActionPropertiesaction_propertiesActionPropertiesactionPropertiesActionPropertiesActionPropertiesActionPropertiesActionPropertiesActionPropertiesrequired#

The simple properties of the Action, like its Owner, name, etc.

Note that this accessor will be called before the bind callback.

Methods

bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfigdef bind(self, scope: Construct, stage: IStage, options: ActionBindOptions) -> ActionConfigpublic ActionConfig bind(Construct scope, IStage stage, ActionBindOptions options)public ActionConfig Bind(Construct scope, IStage stage, ActionBindOptions options)func Bind(Scope Construct, Stage IStage, Options ActionBindOptions) ActionConfig#

The callback invoked when this Action is added to a Pipeline.

onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Rule

def on_state_change(self, name: str, target: typing.Optional[IRuleTarget] = None, options: typing.Optional[RuleProps] = None) -> Rule

public Rule onStateChange(String name, IRuleTarget target, RuleProps options)public Rule OnStateChange(string name, IRuleTarget? target = null, RuleProps? options = null)func OnStateChange(Name *string, Target IRuleTarget, Options RuleProps) Rule#

Creates an Event that will be triggered whenever the state of this Action changes.

CloudFormationDeployStackInstancesAction Class ​

Example ​

Initializer ​

Properties ​

Methods ​

CloudFormationDeployStackInstancesAction Class

Example

Initializer

Properties

Methods