software.amazon.awscdk.services.codepipeline.actions

Interface CommonCloudFormationStackSetOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

CloudFormationDeployStackInstancesActionProps, CloudFormationDeployStackSetActionProps

All Known Implementing Classes:

CloudFormationDeployStackInstancesActionProps.Jsii$Proxy, CloudFormationDeployStackSetActionProps.Jsii$Proxy, CommonCloudFormationStackSetOptions.Jsii$Proxy

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

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 software.amazon.awscdk.services.codepipeline.actions.*;
 CommonCloudFormationStackSetOptions commonCloudFormationStackSetOptions = CommonCloudFormationStackSetOptions.builder()
         .failureTolerancePercentage(123)
         .maxAccountConcurrencyPercentage(123)
         .stackSetRegion("stackSetRegion")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CommonCloudFormationStackSetOptions.Builder	builder()
default Number	getFailureTolerancePercentage() The percentage of accounts per Region for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.
default Number	getMaxAccountConcurrencyPercentage() The maximum percentage of accounts in which to perform this operation at one time.
default String	getStackSetRegion() The AWS Region the StackSet is in.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFailureTolerancePercentage

@Stability(value=Stable)
 @Nullable
default Number getFailureTolerancePercentage()

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.

Default: 0%

getMaxAccountConcurrencyPercentage

@Stability(value=Stable)
 @Nullable
default Number getMaxAccountConcurrencyPercentage()

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.

Default: 1%

getStackSetRegion

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

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.

Default: - same region as the Pipeline

builder

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

Returns:

a CommonCloudFormationStackSetOptions.Builder of CommonCloudFormationStackSetOptions