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

Class CloudFormationDeployStackSetActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudFormationDeployStackSetActionProps>

Enclosing interface:

CloudFormationDeployStackSetActionProps

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

A builder for CloudFormationDeployStackSetActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CloudFormationDeployStackSetActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
CloudFormationDeployStackSetActionProps	build()	Builds the configured instance.
CloudFormationDeployStackSetActionProps.Builder	cfnCapabilities(List<? extends CfnCapabilities> cfnCapabilities)	Sets the value of CloudFormationDeployStackSetActionProps.getCfnCapabilities()
CloudFormationDeployStackSetActionProps.Builder	deploymentModel(StackSetDeploymentModel deploymentModel)	Sets the value of CloudFormationDeployStackSetActionProps.getDeploymentModel()
CloudFormationDeployStackSetActionProps.Builder	description(String description)	Sets the value of CloudFormationDeployStackSetActionProps.getDescription()
CloudFormationDeployStackSetActionProps.Builder	failureTolerancePercentage(Number failureTolerancePercentage)	Sets the value of CommonCloudFormationStackSetOptions.getFailureTolerancePercentage()
CloudFormationDeployStackSetActionProps.Builder	maxAccountConcurrencyPercentage(Number maxAccountConcurrencyPercentage)	Sets the value of CommonCloudFormationStackSetOptions.getMaxAccountConcurrencyPercentage()
CloudFormationDeployStackSetActionProps.Builder	parameters(StackSetParameters parameters)	Sets the value of CloudFormationDeployStackSetActionProps.getParameters()
CloudFormationDeployStackSetActionProps.Builder	role(IRole role)	Sets the value of CommonAwsActionProps.getRole()
CloudFormationDeployStackSetActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
CloudFormationDeployStackSetActionProps.Builder	stackInstances(StackInstances stackInstances)	Sets the value of CloudFormationDeployStackSetActionProps.getStackInstances()
CloudFormationDeployStackSetActionProps.Builder	stackSetName(String stackSetName)	Sets the value of CloudFormationDeployStackSetActionProps.getStackSetName()
CloudFormationDeployStackSetActionProps.Builder	stackSetRegion(String stackSetRegion)	Sets the value of CommonCloudFormationStackSetOptions.getStackSetRegion()
CloudFormationDeployStackSetActionProps.Builder	template(StackSetTemplate template)	Sets the value of CloudFormationDeployStackSetActionProps.getTemplate()
CloudFormationDeployStackSetActionProps.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

stackSetName

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

Sets the value of CloudFormationDeployStackSetActionProps.getStackSetName()

Parameters:

stackSetName - The name to associate with the stack set. This parameter is required. 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.

Returns:

this

template

@Stability(Stable)
public CloudFormationDeployStackSetActionProps.Builder template(StackSetTemplate template)

Sets the value of CloudFormationDeployStackSetActionProps.getTemplate()

Parameters:

template - The location of the template that defines the resources in the stack set. This parameter is required. 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.

Returns:

this

cfnCapabilities

@Stability(Stable)
public CloudFormationDeployStackSetActionProps.Builder cfnCapabilities(List<? extends CfnCapabilities> cfnCapabilities)

Sets the value of CloudFormationDeployStackSetActionProps.getCfnCapabilities()

Parameters:

cfnCapabilities - 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.

Returns:

this

deploymentModel

@Stability(Stable)
public CloudFormationDeployStackSetActionProps.Builder deploymentModel(StackSetDeploymentModel deploymentModel)

Sets the value of CloudFormationDeployStackSetActionProps.getDeploymentModel()

Parameters:

deploymentModel - 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.

Returns:

this

description

@Stability(Stable)
public CloudFormationDeployStackSetActionProps.Builder description(String description)

Sets the value of CloudFormationDeployStackSetActionProps.getDescription()

Parameters:

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

Returns:

this

parameters

@Stability(Stable)
public CloudFormationDeployStackSetActionProps.Builder parameters(StackSetParameters parameters)

Sets the value of CloudFormationDeployStackSetActionProps.getParameters()

Parameters:

parameters - The template parameters for your stack set. These parameters are shared between all instances of the stack set.

Returns:

this

stackInstances

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

Sets the value of CloudFormationDeployStackSetActionProps.getStackInstances()

Parameters:

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

Returns:

this

role

@Stability(Stable)
public CloudFormationDeployStackSetActionProps.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 CloudFormationDeployStackSetActionProps.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 CloudFormationDeployStackSetActionProps.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 CloudFormationDeployStackSetActionProps.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 CloudFormationDeployStackSetActionProps.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 CloudFormationDeployStackSetActionProps.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 CloudFormationDeployStackSetActionProps.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 CloudFormationDeployStackSetActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CloudFormationDeployStackSetActionProps

Throws:

NullPointerException - if any required attribute was not provided