software.amazon.awscdk.pipelines

Class DeployCdkStackAction.Builder

java.lang.Object

software.amazon.awscdk.pipelines.DeployCdkStackAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DeployCdkStackAction>

Enclosing class:

DeployCdkStackAction

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

(experimental) A fluent builder for DeployCdkStackAction.

Method Summary

Modifier and Type	Method and Description
DeployCdkStackAction.Builder	actionRole(IRole actionRole) (experimental) Role for the action to assume.
DeployCdkStackAction.Builder	baseActionName(String baseActionName) (experimental) Base name of the action.
DeployCdkStackAction	build()
DeployCdkStackAction.Builder	changeSetName(String changeSetName) (experimental) Name of the change set to create and deploy.
DeployCdkStackAction.Builder	cloudAssemblyInput(Artifact cloudAssemblyInput) (experimental) The CodePipeline artifact that holds the Cloud Assembly.
DeployCdkStackAction.Builder	cloudFormationExecutionRole(IRole cloudFormationExecutionRole) (experimental) Role to execute CloudFormation under.
static DeployCdkStackAction.Builder	create()
DeployCdkStackAction.Builder	dependencyStackArtifactIds(List<String> dependencyStackArtifactIds) (experimental) Artifact ID for the stacks this stack depends on.
DeployCdkStackAction.Builder	executeRunOrder(Number executeRunOrder) (experimental) Run order for the Execute action.
DeployCdkStackAction.Builder	output(Artifact output) (experimental) Artifact to write Stack Outputs to.
DeployCdkStackAction.Builder	outputFileName(String outputFileName) (experimental) Filename in output to write Stack outputs to.
DeployCdkStackAction.Builder	prepareRunOrder(Number prepareRunOrder) (experimental) Run order for the Prepare action.
DeployCdkStackAction.Builder	region(String region) (experimental) Region to deploy into.
DeployCdkStackAction.Builder	stackArtifactId(String stackArtifactId) (experimental) Artifact ID for the stack deployed here.
DeployCdkStackAction.Builder	stackName(String stackName) (experimental) The name of the stack that should be created/updated.
DeployCdkStackAction.Builder	templateConfigurationPath(String templateConfigurationPath) (experimental) Template configuration path relative to the input artifact.
DeployCdkStackAction.Builder	templatePath(String templatePath) (experimental) Relative path of template in the input artifact.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static DeployCdkStackAction.Builder create()

Returns:

a new instance of DeployCdkStackAction.Builder.

cloudAssemblyInput

@Stability(value=Experimental)
public DeployCdkStackAction.Builder cloudAssemblyInput(Artifact cloudAssemblyInput)

(experimental) The CodePipeline artifact that holds the Cloud Assembly.

Parameters:

cloudAssemblyInput - The CodePipeline artifact that holds the Cloud Assembly. This parameter is required.

Returns:

this

baseActionName

@Stability(value=Experimental)
public DeployCdkStackAction.Builder baseActionName(String baseActionName)

(experimental) Base name of the action.

Default: stackName

Parameters:

baseActionName - Base name of the action. This parameter is required.

Returns:

this

changeSetName

@Stability(value=Experimental)
public DeployCdkStackAction.Builder changeSetName(String changeSetName)

(experimental) Name of the change set to create and deploy.

Default: 'PipelineChange'

Parameters:

changeSetName - Name of the change set to create and deploy. This parameter is required.

Returns:

this

executeRunOrder

@Stability(value=Experimental)
public DeployCdkStackAction.Builder executeRunOrder(Number executeRunOrder)

(experimental) Run order for the Execute action.

Default: - prepareRunOrder + 1

Parameters:

executeRunOrder - Run order for the Execute action. This parameter is required.

Returns:

this

output

@Stability(value=Experimental)
public DeployCdkStackAction.Builder output(Artifact output)

(experimental) Artifact to write Stack Outputs to.

Default: - No outputs

Parameters:

output - Artifact to write Stack Outputs to. This parameter is required.

Returns:

this

outputFileName

@Stability(value=Experimental)
public DeployCdkStackAction.Builder outputFileName(String outputFileName)

(experimental) Filename in output to write Stack outputs to.

Default: - Required when 'output' is set

Parameters:

outputFileName - Filename in output to write Stack outputs to. This parameter is required.

Returns:

this

prepareRunOrder

@Stability(value=Experimental)
public DeployCdkStackAction.Builder prepareRunOrder(Number prepareRunOrder)

(experimental) Run order for the Prepare action.

Default: 1

Parameters:

prepareRunOrder - Run order for the Prepare action. This parameter is required.

Returns:

this

actionRole

@Stability(value=Experimental)
public DeployCdkStackAction.Builder actionRole(IRole actionRole)

(experimental) Role for the action to assume.

This controls the account to deploy into

Parameters:

actionRole - Role for the action to assume. This parameter is required.

Returns:

this

stackName

@Stability(value=Experimental)
public DeployCdkStackAction.Builder stackName(String stackName)

(experimental) The name of the stack that should be created/updated.

Parameters:

stackName - The name of the stack that should be created/updated. This parameter is required.

Returns:

this

templatePath

@Stability(value=Experimental)
public DeployCdkStackAction.Builder templatePath(String templatePath)

(experimental) Relative path of template in the input artifact.

Parameters:

templatePath - Relative path of template in the input artifact. This parameter is required.

Returns:

this

cloudFormationExecutionRole

@Stability(value=Experimental)
public DeployCdkStackAction.Builder cloudFormationExecutionRole(IRole cloudFormationExecutionRole)

(experimental) Role to execute CloudFormation under.

Default: - Execute CloudFormation using the action role

Parameters:

cloudFormationExecutionRole - Role to execute CloudFormation under. This parameter is required.

Returns:

this

dependencyStackArtifactIds

@Stability(value=Experimental)
public DeployCdkStackAction.Builder dependencyStackArtifactIds(List<String> dependencyStackArtifactIds)

(experimental) Artifact ID for the stacks this stack depends on.

Used for pipeline order checking.

Default: - No dependencies

Parameters:

dependencyStackArtifactIds - Artifact ID for the stacks this stack depends on. This parameter is required.

Returns:

this

region

@Stability(value=Experimental)
public DeployCdkStackAction.Builder region(String region)

(experimental) Region to deploy into.

Default: - Same region as pipeline

Parameters:

region - Region to deploy into. This parameter is required.

Returns:

this

stackArtifactId

@Stability(value=Experimental)
public DeployCdkStackAction.Builder stackArtifactId(String stackArtifactId)

(experimental) Artifact ID for the stack deployed here.

Used for pipeline order checking.

Default: - Order will not be checked

Parameters:

stackArtifactId - Artifact ID for the stack deployed here. This parameter is required.

Returns:

this

templateConfigurationPath

@Stability(value=Experimental)
public DeployCdkStackAction.Builder templateConfigurationPath(String templateConfigurationPath)

(experimental) Template configuration path relative to the input artifact.

Default: - No template configuration

Parameters:

templateConfigurationPath - Template configuration path relative to the input artifact. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public DeployCdkStackAction build()

Specified by:

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