software.amazon.awscdk.services.codepipeline.actions

Class CloudFormationExecuteChangeSetAction.Builder

java.lang.Object

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

Enclosing class:

CloudFormationExecuteChangeSetAction

@Stability(value=Stable)
public static final class CloudFormationExecuteChangeSetAction.Builder
extends Object

A fluent builder for CloudFormationExecuteChangeSetAction.

Method Summary

Modifier and Type	Method and Description
CloudFormationExecuteChangeSetAction.Builder	account(String account)
CloudFormationExecuteChangeSetAction.Builder	actionName(String actionName)
CloudFormationExecuteChangeSetAction	build()
CloudFormationExecuteChangeSetAction.Builder	changeSetName(String changeSetName)
static CloudFormationExecuteChangeSetAction.Builder	create()
CloudFormationExecuteChangeSetAction.Builder	output(Artifact output)
CloudFormationExecuteChangeSetAction.Builder	outputFileName(String outputFileName)
CloudFormationExecuteChangeSetAction.Builder	region(String region)
CloudFormationExecuteChangeSetAction.Builder	role(IRole role)
CloudFormationExecuteChangeSetAction.Builder	runOrder(Number runOrder)
CloudFormationExecuteChangeSetAction.Builder	stackName(String stackName)

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 CloudFormationExecuteChangeSetAction.Builder create()

Returns:

a new instance of CloudFormationExecuteChangeSetAction.Builder.

actionName

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

Parameters:

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

Returns:

this

runOrder

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

Parameters:

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

Returns:

this

role

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

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. This parameter is required.

Returns:

this

changeSetName

@Stability(value=Stable)
public CloudFormationExecuteChangeSetAction.Builder changeSetName(String changeSetName)

Parameters:

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

Returns:

this

stackName

@Stability(value=Stable)
public CloudFormationExecuteChangeSetAction.Builder stackName(String stackName)

Parameters:

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

Returns:

this

account

@Stability(value=Stable)
public CloudFormationExecuteChangeSetAction.Builder account(String account)

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. This parameter is required.

Returns:

this

output

@Stability(value=Stable)
public CloudFormationExecuteChangeSetAction.Builder output(Artifact output)

Parameters:

output - The name of the output artifact to generate. This parameter is required.

Returns:

this

outputFileName

@Stability(value=Stable)
public CloudFormationExecuteChangeSetAction.Builder outputFileName(String outputFileName)

Parameters:

outputFileName - A name for the filename in the output artifact to store the AWS CloudFormation call's result. This parameter is required.

Returns:

this

region

@Stability(value=Stable)
public CloudFormationExecuteChangeSetAction.Builder region(String region)

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. This parameter is required.

Returns:

this

build

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