Package software.amazon.awscdk.services.codepipeline.actions

Class CloudFormationDeployStackInstancesActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudFormationDeployStackInstancesActionProps>

Enclosing interface:

CloudFormationDeployStackInstancesActionProps

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

A builder for CloudFormationDeployStackInstancesActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CloudFormationDeployStackInstancesActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
CloudFormationDeployStackInstancesActionProps	build()	Builds the configured instance.
CloudFormationDeployStackInstancesActionProps.Builder	failureTolerancePercentage(Number failureTolerancePercentage)	Sets the value of CommonCloudFormationStackSetOptions.getFailureTolerancePercentage()
CloudFormationDeployStackInstancesActionProps.Builder	maxAccountConcurrencyPercentage(Number maxAccountConcurrencyPercentage)	Sets the value of CommonCloudFormationStackSetOptions.getMaxAccountConcurrencyPercentage()
CloudFormationDeployStackInstancesActionProps.Builder	parameterOverrides(StackSetParameters parameterOverrides)	Sets the value of CloudFormationDeployStackInstancesActionProps.getParameterOverrides()
CloudFormationDeployStackInstancesActionProps.Builder	role(IRole role)	Sets the value of CommonAwsActionProps.getRole()
CloudFormationDeployStackInstancesActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
CloudFormationDeployStackInstancesActionProps.Builder	stackInstances(StackInstances stackInstances)	Sets the value of CloudFormationDeployStackInstancesActionProps.getStackInstances()
CloudFormationDeployStackInstancesActionProps.Builder	stackSetName(String stackSetName)	Sets the value of CloudFormationDeployStackInstancesActionProps.getStackSetName()
CloudFormationDeployStackInstancesActionProps.Builder	stackSetRegion(String stackSetRegion)	Sets the value of CommonCloudFormationStackSetOptions.getStackSetRegion()
CloudFormationDeployStackInstancesActionProps.Builder	variablesNamespace(String variablesNamespace)	Sets the value of CommonActionProps.getVariablesNamespace()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

stackInstances

@Stability(Stable)
public CloudFormationDeployStackInstancesActionProps.Builder stackInstances(StackInstances stackInstances)

Sets the value of CloudFormationDeployStackInstancesActionProps.getStackInstances()

Parameters:

stackInstances - Specify where to create or update Stack Instances. This parameter is required. You can specify either AWS Accounts Ids or AWS Organizations Organizational Units.

Returns:

this

stackSetName

@Stability(Stable)
public CloudFormationDeployStackInstancesActionProps.Builder stackSetName(String stackSetName)

Sets the value of CloudFormationDeployStackInstancesActionProps.getStackSetName()

Parameters:

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

Returns:

this

parameterOverrides

@Stability(Stable)
public CloudFormationDeployStackInstancesActionProps.Builder parameterOverrides(StackSetParameters parameterOverrides)

Sets the value of CloudFormationDeployStackInstancesActionProps.getParameterOverrides()

Parameters:

parameterOverrides - Parameter values that only apply to the current Stack Instances. These parameters are shared between all instances added by this action.

Returns:

this

role

@Stability(Stable)
public CloudFormationDeployStackInstancesActionProps.Builder role(IRole role)

Sets the value of CommonAwsActionProps.getRole()

Parameters:

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

Returns:

this

actionName

@Stability(Stable)
public CloudFormationDeployStackInstancesActionProps.Builder actionName(String actionName)

Sets the value of CommonActionProps.getActionName()

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required. Note that Action names must be unique within a single Stage.

Returns:

this

runOrder

@Stability(Stable)
public CloudFormationDeployStackInstancesActionProps.Builder runOrder(Number runOrder)

Sets the value of CommonActionProps.getRunOrder()

Parameters:

runOrder - The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Returns:

this

variablesNamespace

@Stability(Stable)
public CloudFormationDeployStackInstancesActionProps.Builder variablesNamespace(String variablesNamespace)

Sets the value of CommonActionProps.getVariablesNamespace()

Parameters:

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

Returns:

this

failureTolerancePercentage

@Stability(Stable)
public CloudFormationDeployStackInstancesActionProps.Builder failureTolerancePercentage(Number failureTolerancePercentage)

Sets the value of CommonCloudFormationStackSetOptions.getFailureTolerancePercentage()

Parameters:

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.

Returns:

this

maxAccountConcurrencyPercentage

@Stability(Stable)
public CloudFormationDeployStackInstancesActionProps.Builder maxAccountConcurrencyPercentage(Number maxAccountConcurrencyPercentage)

Sets the value of CommonCloudFormationStackSetOptions.getMaxAccountConcurrencyPercentage()

Parameters:

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.

Returns:

this

stackSetRegion

@Stability(Stable)
public CloudFormationDeployStackInstancesActionProps.Builder stackSetRegion(String stackSetRegion)

Sets the value of CommonCloudFormationStackSetOptions.getStackSetRegion()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CloudFormationDeployStackInstancesActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CloudFormationDeployStackInstancesActionProps

Throws:

NullPointerException - if any required attribute was not provided