software.amazon.awscdk.services.codepipeline.actions

Interface CloudFormationDeployStackSetActionProps

All Superinterfaces:

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

All Known Implementing Classes:

CloudFormationDeployStackSetActionProps.Jsii$Proxy

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

Properties for the CloudFormationDeployStackSetAction.

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	CloudFormationDeployStackSetActionProps.Builder A builder for CloudFormationDeployStackSetActionProps
static class	CloudFormationDeployStackSetActionProps.Jsii$Proxy An implementation for CloudFormationDeployStackSetActionProps

Method Summary

Modifier and Type	Method and Description
static CloudFormationDeployStackSetActionProps.Builder	builder()
default List<CfnCapabilities>	getCfnCapabilities() Indicates that the template can create and update resources, depending on the types of resources in the template.
default StackSetDeploymentModel	getDeploymentModel() Determines how IAM roles are created and managed.
default String	getDescription() A description of the stack set.
default StackSetParameters	getParameters() The template parameters for your stack set.
default StackInstances	getStackInstances() Specify where to create or update Stack Instances.
String	getStackSetName() The name to associate with the stack set.
StackSetTemplate	getTemplate() The location of the template that defines the resources in the stack set.

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

getStackSetName

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

The name to associate with the stack set.

This name must be unique in the Region where it is created.

The name may only contain alphanumeric and hyphen characters. It must begin with an alphabetic character and be 128 characters or fewer.

getTemplate

@Stability(value=Stable)
 @NotNull
StackSetTemplate getTemplate()

The location of the template that defines the resources in the stack set.

This must point to a template with a maximum size of 460,800 bytes.

Enter the path to the source artifact name and template file.

getCfnCapabilities

@Stability(value=Stable)
 @Nullable
default List<CfnCapabilities> getCfnCapabilities()

Indicates that the template can create and update resources, depending on the types of resources in the template.

You must use this property if you have IAM resources in your stack template or you create a stack directly from a template containing macros.

Default: - the StackSet will have no IAM capabilities

getDeploymentModel

@Stability(value=Stable)
 @Nullable
default StackSetDeploymentModel getDeploymentModel()

Determines how IAM roles are created and managed.

The choices are:

• Self Managed: you create IAM roles with the required permissions in the administration account and all target accounts.
• Service Managed: only available if the account and target accounts are part of an AWS Organization. The necessary roles will be created for you.

If you want to deploy to all accounts that are a member of AWS Organizations Organizational Units (OUs), you must select Service Managed permissions.

Note: This parameter can only be changed when no stack instances exist in the stack set.

Default: StackSetDeploymentModel.selfManaged()

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the stack set.

You can use this to describe the stack set’s purpose or other relevant information.

Default: - no description

getParameters

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

The template parameters for your stack set.

These parameters are shared between all instances of the stack set.

Default: - no parameters will be used

getStackInstances

@Stability(value=Stable)
 @Nullable
default StackInstances getStackInstances()

Specify where to create or update Stack Instances.

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

Default: - don't create or update any Stack Instances

builder

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

Specified by:

builder in interface CommonActionProps

Specified by:

builder in interface CommonAwsActionProps

Specified by:

builder in interface CommonCloudFormationStackSetOptions

Returns:

a CloudFormationDeployStackSetActionProps.Builder of CloudFormationDeployStackSetActionProps