software.amazon.awscdk.services.codepipeline.actions

Class CloudFormationDeployStackInstancesAction.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.actions.CloudFormationDeployStackInstancesAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudFormationDeployStackInstancesAction>

Enclosing class:

CloudFormationDeployStackInstancesAction

@Stability(value=Stable)
public static final class CloudFormationDeployStackInstancesAction.Builder
extends Object
implements software.amazon.jsii.Builder<CloudFormationDeployStackInstancesAction>

A fluent builder for CloudFormationDeployStackInstancesAction.

Method Summary

Modifier and Type	Method and Description
CloudFormationDeployStackInstancesAction.Builder	actionName(String actionName) The physical, human-readable name of the Action.
CloudFormationDeployStackInstancesAction	build()
static CloudFormationDeployStackInstancesAction.Builder	create()
CloudFormationDeployStackInstancesAction.Builder	failureTolerancePercentage(Number failureTolerancePercentage) The percentage of accounts per Region for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.
CloudFormationDeployStackInstancesAction.Builder	maxAccountConcurrencyPercentage(Number maxAccountConcurrencyPercentage) The maximum percentage of accounts in which to perform this operation at one time.
CloudFormationDeployStackInstancesAction.Builder	parameterOverrides(StackSetParameters parameterOverrides) Parameter values that only apply to the current Stack Instances.
CloudFormationDeployStackInstancesAction.Builder	role(IRole role) The Role in which context's this Action will be executing in.
CloudFormationDeployStackInstancesAction.Builder	runOrder(Number runOrder) The runOrder property for this Action.
CloudFormationDeployStackInstancesAction.Builder	stackInstances(StackInstances stackInstances) Specify where to create or update Stack Instances.
CloudFormationDeployStackInstancesAction.Builder	stackSetName(String stackSetName) The name of the StackSet we are adding instances to.
CloudFormationDeployStackInstancesAction.Builder	stackSetRegion(String stackSetRegion) The AWS Region the StackSet is in.
CloudFormationDeployStackInstancesAction.Builder	variablesNamespace(String variablesNamespace) The name of the namespace to use for variables emitted by this action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CloudFormationDeployStackInstancesAction.Builder create()

Returns:

a new instance of CloudFormationDeployStackInstancesAction.Builder.

actionName

@Stability(value=Stable)
public CloudFormationDeployStackInstancesAction.Builder actionName(String actionName)

The physical, human-readable name of the Action.

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

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required.

Returns:

this

runOrder

@Stability(value=Stable)
public CloudFormationDeployStackInstancesAction.Builder runOrder(Number runOrder)

The runOrder property for this Action.

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

Default: 1

Parameters:

runOrder - The runOrder property for this Action. This parameter is required.

Returns:

this

See Also:

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

variablesNamespace

@Stability(value=Stable)
public CloudFormationDeployStackInstancesAction.Builder variablesNamespace(String variablesNamespace)

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

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

Parameters:

variablesNamespace - The name of the namespace to use for variables emitted by this action. This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public CloudFormationDeployStackInstancesAction.Builder role(IRole role)

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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

Default: a new Role will be generated

Parameters:

role - The Role in which context's this Action will be executing in. This parameter is required.

Returns:

this

failureTolerancePercentage

@Stability(value=Stable)
public CloudFormationDeployStackInstancesAction.Builder failureTolerancePercentage(Number failureTolerancePercentage)

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%

Parameters:

failureTolerancePercentage - The percentage of accounts per Region for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. This parameter is required.

Returns:

this

maxAccountConcurrencyPercentage

@Stability(value=Stable)
public CloudFormationDeployStackInstancesAction.Builder maxAccountConcurrencyPercentage(Number maxAccountConcurrencyPercentage)

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%

Parameters:

maxAccountConcurrencyPercentage - The maximum percentage of accounts in which to perform this operation at one time. This parameter is required.

Returns:

this

stackSetRegion

@Stability(value=Stable)
public CloudFormationDeployStackInstancesAction.Builder stackSetRegion(String stackSetRegion)

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

Parameters:

stackSetRegion - The AWS Region the StackSet is in. This parameter is required.

Returns:

this

stackInstances

@Stability(value=Stable)
public CloudFormationDeployStackInstancesAction.Builder stackInstances(StackInstances stackInstances)

Specify where to create or update Stack Instances.

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

Parameters:

stackInstances - Specify where to create or update Stack Instances. This parameter is required.

Returns:

this

stackSetName

@Stability(value=Stable)
public CloudFormationDeployStackInstancesAction.Builder stackSetName(String stackSetName)

The name of the StackSet we are adding instances to.

Parameters:

stackSetName - The name of the StackSet we are adding instances to. This parameter is required.

Returns:

this

parameterOverrides

@Stability(value=Stable)
public CloudFormationDeployStackInstancesAction.Builder parameterOverrides(StackSetParameters parameterOverrides)

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

Parameters:

parameterOverrides - Parameter values that only apply to the current Stack Instances. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CloudFormationDeployStackInstancesAction build()

Specified by:

build in interface software.amazon.jsii.Builder<CloudFormationDeployStackInstancesAction>