software.amazon.awscdk.pipelines

Class DeployCdkStackActionProps.Builder

java.lang.Object

software.amazon.awscdk.pipelines.DeployCdkStackActionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DeployCdkStackActionProps>

Enclosing interface:

DeployCdkStackActionProps

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

A builder for DeployCdkStackActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DeployCdkStackActionProps.Builder	actionRole(IRole actionRole) Sets the value of DeployCdkStackActionProps.getActionRole()
DeployCdkStackActionProps.Builder	baseActionName(String baseActionName) Sets the value of DeployCdkStackActionOptions.getBaseActionName()
DeployCdkStackActionProps	build() Builds the configured instance.
DeployCdkStackActionProps.Builder	changeSetName(String changeSetName) Sets the value of DeployCdkStackActionOptions.getChangeSetName()
DeployCdkStackActionProps.Builder	cloudAssemblyInput(Artifact cloudAssemblyInput) Sets the value of DeployCdkStackActionOptions.getCloudAssemblyInput()
DeployCdkStackActionProps.Builder	cloudFormationExecutionRole(IRole cloudFormationExecutionRole) Sets the value of DeployCdkStackActionProps.getCloudFormationExecutionRole()
DeployCdkStackActionProps.Builder	dependencyStackArtifactIds(List<String> dependencyStackArtifactIds) Sets the value of DeployCdkStackActionProps.getDependencyStackArtifactIds()
DeployCdkStackActionProps.Builder	executeRunOrder(Number executeRunOrder) Sets the value of DeployCdkStackActionOptions.getExecuteRunOrder()
DeployCdkStackActionProps.Builder	output(Artifact output) Sets the value of DeployCdkStackActionOptions.getOutput()
DeployCdkStackActionProps.Builder	outputFileName(String outputFileName) Sets the value of DeployCdkStackActionOptions.getOutputFileName()
DeployCdkStackActionProps.Builder	prepareRunOrder(Number prepareRunOrder) Sets the value of DeployCdkStackActionOptions.getPrepareRunOrder()
DeployCdkStackActionProps.Builder	region(String region) Sets the value of DeployCdkStackActionProps.getRegion()
DeployCdkStackActionProps.Builder	stackArtifactId(String stackArtifactId) Sets the value of DeployCdkStackActionProps.getStackArtifactId()
DeployCdkStackActionProps.Builder	stackName(String stackName) Sets the value of DeployCdkStackActionProps.getStackName()
DeployCdkStackActionProps.Builder	templateConfigurationPath(String templateConfigurationPath) Sets the value of DeployCdkStackActionProps.getTemplateConfigurationPath()
DeployCdkStackActionProps.Builder	templatePath(String templatePath) Sets the value of DeployCdkStackActionProps.getTemplatePath()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

actionRole

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

Sets the value of DeployCdkStackActionProps.getActionRole()

Parameters:

actionRole - Role for the action to assume. This parameter is required. This controls the account to deploy into

Returns:

this

stackName

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

Sets the value of DeployCdkStackActionProps.getStackName()

Parameters:

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

Returns:

this

templatePath

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

Sets the value of DeployCdkStackActionProps.getTemplatePath()

Parameters:

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

Returns:

this

cloudFormationExecutionRole

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

Sets the value of DeployCdkStackActionProps.getCloudFormationExecutionRole()

Parameters:

cloudFormationExecutionRole - Role to execute CloudFormation under.

Returns:

this

dependencyStackArtifactIds

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

Sets the value of DeployCdkStackActionProps.getDependencyStackArtifactIds()

Parameters:

dependencyStackArtifactIds - Artifact ID for the stacks this stack depends on. Used for pipeline order checking.

Returns:

this

region

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

Sets the value of DeployCdkStackActionProps.getRegion()

Parameters:

region - Region to deploy into.

Returns:

this

stackArtifactId

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

Sets the value of DeployCdkStackActionProps.getStackArtifactId()

Parameters:

stackArtifactId - Artifact ID for the stack deployed here. Used for pipeline order checking.

Returns:

this

templateConfigurationPath

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

Sets the value of DeployCdkStackActionProps.getTemplateConfigurationPath()

Parameters:

templateConfigurationPath - Template configuration path relative to the input artifact.

Returns:

this

cloudAssemblyInput

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

Sets the value of DeployCdkStackActionOptions.getCloudAssemblyInput()

Parameters:

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

Returns:

this

baseActionName

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

Sets the value of DeployCdkStackActionOptions.getBaseActionName()

Parameters:

baseActionName - Base name of the action.

Returns:

this

changeSetName

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

Sets the value of DeployCdkStackActionOptions.getChangeSetName()

Parameters:

changeSetName - Name of the change set to create and deploy.

Returns:

this

executeRunOrder

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

Sets the value of DeployCdkStackActionOptions.getExecuteRunOrder()

Parameters:

executeRunOrder - Run order for the Execute action.

Returns:

this

output

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

Sets the value of DeployCdkStackActionOptions.getOutput()

Parameters:

output - Artifact to write Stack Outputs to.

Returns:

this

outputFileName

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

Sets the value of DeployCdkStackActionOptions.getOutputFileName()

Parameters:

outputFileName - Filename in output to write Stack outputs to.

Returns:

this

prepareRunOrder

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

Sets the value of DeployCdkStackActionOptions.getPrepareRunOrder()

Parameters:

prepareRunOrder - Run order for the Prepare action.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DeployCdkStackActionProps

Throws:

NullPointerException - if any required attribute was not provided