software.amazon.awscdk.services.codepipeline.actions

Interface CloudFormationDeployStackInstancesActionProps

All Superinterfaces:

CommonActionProps, CommonAwsActionProps, CommonCloudFormationStackSetOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CloudFormationDeployStackInstancesActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.518Z")
 @Stability(value=Stable)
public interface CloudFormationDeployStackInstancesActionProps
extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps, CommonCloudFormationStackSetOptions

Properties for the CloudFormationDeployStackInstancesAction.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 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());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CloudFormationDeployStackInstancesActionProps.Builder A builder for CloudFormationDeployStackInstancesActionProps
static class	CloudFormationDeployStackInstancesActionProps.Jsii$Proxy An implementation for CloudFormationDeployStackInstancesActionProps

Method Summary

Modifier and Type	Method and Description
static CloudFormationDeployStackInstancesActionProps.Builder	builder()
default StackSetParameters	getParameterOverrides() Parameter values that only apply to the current Stack Instances.
StackInstances	getStackInstances() Specify where to create or update Stack Instances.
String	getStackSetName() The name of the StackSet we are adding instances to.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonAwsActionProps

getRole

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.codepipeline.actions.CommonCloudFormationStackSetOptions

getFailureTolerancePercentage, getMaxAccountConcurrencyPercentage, getStackSetRegion

Method Detail

getStackInstances

@Stability(value=Stable)
 @NotNull
StackInstances getStackInstances()

Specify where to create or update Stack Instances.

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

getStackSetName

@Stability(value=Stable)
 @NotNull
String getStackSetName()

The name of the StackSet we are adding instances to.

getParameterOverrides

@Stability(value=Stable)
 @Nullable
default StackSetParameters getParameterOverrides()

Parameter values that only apply to the current Stack Instances.

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

Default: - no parameters will be overridden

builder

@Stability(value=Stable)
static CloudFormationDeployStackInstancesActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Specified by:

builder in interface CommonAwsActionProps

Specified by:

builder in interface CommonCloudFormationStackSetOptions

Returns:

a CloudFormationDeployStackInstancesActionProps.Builder of CloudFormationDeployStackInstancesActionProps