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

Class CloudFormationExecuteChangeSetActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudFormationExecuteChangeSetActionProps>

Enclosing interface:

CloudFormationExecuteChangeSetActionProps

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

A builder for CloudFormationExecuteChangeSetActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CloudFormationExecuteChangeSetActionProps.Builder	account(String account)	Sets the value of CloudFormationExecuteChangeSetActionProps.getAccount()
CloudFormationExecuteChangeSetActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
CloudFormationExecuteChangeSetActionProps	build()	Builds the configured instance.
CloudFormationExecuteChangeSetActionProps.Builder	changeSetName(String changeSetName)	Sets the value of CloudFormationExecuteChangeSetActionProps.getChangeSetName()
CloudFormationExecuteChangeSetActionProps.Builder	output(Artifact output)	Sets the value of CloudFormationExecuteChangeSetActionProps.getOutput()
CloudFormationExecuteChangeSetActionProps.Builder	outputFileName(String outputFileName)	Sets the value of CloudFormationExecuteChangeSetActionProps.getOutputFileName()
CloudFormationExecuteChangeSetActionProps.Builder	region(String region)	Sets the value of CloudFormationExecuteChangeSetActionProps.getRegion()
CloudFormationExecuteChangeSetActionProps.Builder	role(IRole role)	Sets the value of CommonAwsActionProps.getRole()
CloudFormationExecuteChangeSetActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
CloudFormationExecuteChangeSetActionProps.Builder	stackName(String stackName)	Sets the value of CloudFormationExecuteChangeSetActionProps.getStackName()
CloudFormationExecuteChangeSetActionProps.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

changeSetName

@Stability(Stable)
public CloudFormationExecuteChangeSetActionProps.Builder changeSetName(String changeSetName)

Sets the value of CloudFormationExecuteChangeSetActionProps.getChangeSetName()

Parameters:

changeSetName - Name of the change set to execute. This parameter is required.

Returns:

this

stackName

@Stability(Stable)
public CloudFormationExecuteChangeSetActionProps.Builder stackName(String stackName)

Sets the value of CloudFormationExecuteChangeSetActionProps.getStackName()

Parameters:

stackName - The name of the stack to apply this action to. This parameter is required.

Returns:

this

account

@Stability(Stable)
public CloudFormationExecuteChangeSetActionProps.Builder account(String account)

Sets the value of CloudFormationExecuteChangeSetActionProps.getAccount()

Parameters:

account - The AWS account this Action is supposed to operate in. Note: if you specify the role property, this is ignored - the action will operate in the same region the passed role does.

Returns:

this

output

@Stability(Stable)
public CloudFormationExecuteChangeSetActionProps.Builder output(Artifact output)

Sets the value of CloudFormationExecuteChangeSetActionProps.getOutput()

Parameters:

output - The name of the output artifact to generate. Only applied if outputFileName is set as well.

Returns:

this

outputFileName

@Stability(Stable)
public CloudFormationExecuteChangeSetActionProps.Builder outputFileName(String outputFileName)

Sets the value of CloudFormationExecuteChangeSetActionProps.getOutputFileName()

Parameters:

outputFileName - A name for the filename in the output artifact to store the AWS CloudFormation call's result. The file will contain the result of the call to AWS CloudFormation (for example the call to UpdateStack or CreateChangeSet).

AWS CodePipeline adds the file to the output artifact after performing the specified action.

Returns:

this

region

@Stability(Stable)
public CloudFormationExecuteChangeSetActionProps.Builder region(String region)

Sets the value of CloudFormationExecuteChangeSetActionProps.getRegion()

Parameters:

region - The AWS region the given Action resides 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

role

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

build

@Stability(Stable)
public CloudFormationExecuteChangeSetActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CloudFormationExecuteChangeSetActionProps

Throws:

NullPointerException - if any required attribute was not provided