software.amazon.awscdk.appdelivery

Class PipelineDeployStackActionProps.Builder

java.lang.Object

software.amazon.awscdk.appdelivery.PipelineDeployStackActionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PipelineDeployStackActionProps>

Enclosing interface:

PipelineDeployStackActionProps

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

A builder for PipelineDeployStackActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PipelineDeployStackActionProps.Builder	adminPermissions(Boolean adminPermissions) Sets the value of PipelineDeployStackActionProps.getAdminPermissions()
PipelineDeployStackActionProps	build() Builds the configured instance.
PipelineDeployStackActionProps.Builder	capabilities(List<? extends CloudFormationCapabilities> capabilities) Sets the value of PipelineDeployStackActionProps.getCapabilities()
PipelineDeployStackActionProps.Builder	changeSetName(String changeSetName) Sets the value of PipelineDeployStackActionProps.getChangeSetName()
PipelineDeployStackActionProps.Builder	createChangeSetActionName(String createChangeSetActionName) Sets the value of PipelineDeployStackActionProps.getCreateChangeSetActionName()
PipelineDeployStackActionProps.Builder	createChangeSetRunOrder(Number createChangeSetRunOrder) Sets the value of PipelineDeployStackActionProps.getCreateChangeSetRunOrder()
PipelineDeployStackActionProps.Builder	executeChangeSetActionName(String executeChangeSetActionName) Sets the value of PipelineDeployStackActionProps.getExecuteChangeSetActionName()
PipelineDeployStackActionProps.Builder	executeChangeSetRunOrder(Number executeChangeSetRunOrder) Sets the value of PipelineDeployStackActionProps.getExecuteChangeSetRunOrder()
PipelineDeployStackActionProps.Builder	input(Artifact input) Sets the value of PipelineDeployStackActionProps.getInput()
PipelineDeployStackActionProps.Builder	role(IRole role) Sets the value of PipelineDeployStackActionProps.getRole()
PipelineDeployStackActionProps.Builder	stack(Stack stack) Sets the value of PipelineDeployStackActionProps.getStack()

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

adminPermissions

@Stability(value=Experimental)
public PipelineDeployStackActionProps.Builder adminPermissions(Boolean adminPermissions)

Sets the value of PipelineDeployStackActionProps.getAdminPermissions()

Parameters:

adminPermissions - Whether to grant admin permissions to CloudFormation while deploying this template. This parameter is required. Setting this to true affects the defaults for role and capabilities, if you don't specify any alternatives.

The default role that will be created for you will have admin (i.e., *) permissions on all resources, and the deployment will have named IAM capabilities (i.e., able to create all IAM resources).

This is a shorthand that you can use if you fully trust the templates that are deployed in this pipeline. If you want more fine-grained permissions, use addToRolePolicy and capabilities to control what the CloudFormation deployment is allowed to do.

Returns:

this

input

@Stability(value=Experimental)
public PipelineDeployStackActionProps.Builder input(Artifact input)

Sets the value of PipelineDeployStackActionProps.getInput()

Parameters:

input - The CodePipeline artifact that holds the synthesized app, which is the contents of the ```` when running ``cdk synth -o ``. This parameter is required.

Returns:

this

stack

@Stability(value=Experimental)
public PipelineDeployStackActionProps.Builder stack(Stack stack)

Sets the value of PipelineDeployStackActionProps.getStack()

Parameters:

stack - The CDK stack to be deployed. This parameter is required.

Returns:

this

capabilities

@Stability(value=Experimental)
public PipelineDeployStackActionProps.Builder capabilities(List<? extends CloudFormationCapabilities> capabilities)

Sets the value of PipelineDeployStackActionProps.getCapabilities()

Parameters:

capabilities - Acknowledge certain changes made as part of deployment. For stacks that contain certain resources, explicit acknowledgement that AWS CloudFormation might create or update those resources. For example, you must specify AnonymousIAM if your stack template contains AWS Identity and Access Management (IAM) resources. For more information

Returns:

this

changeSetName

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

Sets the value of PipelineDeployStackActionProps.getChangeSetName()

Parameters:

changeSetName - The name to use when creating a ChangeSet for the stack.

Returns:

this

createChangeSetActionName

@Stability(value=Experimental)
public PipelineDeployStackActionProps.Builder createChangeSetActionName(String createChangeSetActionName)

Sets the value of PipelineDeployStackActionProps.getCreateChangeSetActionName()

Parameters:

createChangeSetActionName - The name of the CodePipeline action creating the ChangeSet.

Returns:

this

createChangeSetRunOrder

@Stability(value=Experimental)
public PipelineDeployStackActionProps.Builder createChangeSetRunOrder(Number createChangeSetRunOrder)

Sets the value of PipelineDeployStackActionProps.getCreateChangeSetRunOrder()

Parameters:

createChangeSetRunOrder - The runOrder for the CodePipeline action creating the ChangeSet.

Returns:

this

executeChangeSetActionName

@Stability(value=Experimental)
public PipelineDeployStackActionProps.Builder executeChangeSetActionName(String executeChangeSetActionName)

Sets the value of PipelineDeployStackActionProps.getExecuteChangeSetActionName()

Parameters:

executeChangeSetActionName - The name of the CodePipeline action creating the ChangeSet.

Returns:

this

executeChangeSetRunOrder

@Stability(value=Experimental)
public PipelineDeployStackActionProps.Builder executeChangeSetRunOrder(Number executeChangeSetRunOrder)

Sets the value of PipelineDeployStackActionProps.getExecuteChangeSetRunOrder()

Parameters:

executeChangeSetRunOrder - The runOrder for the CodePipeline action executing the ChangeSet.

Returns:

this

role

@Stability(value=Experimental)
public PipelineDeployStackActionProps.Builder role(IRole role)

Sets the value of PipelineDeployStackActionProps.getRole()

Parameters:

role - IAM role to assume when deploying changes. If not specified, a fresh role is created. The role is created with zero permissions unless adminPermissions is true, in which case the role will have admin permissions.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PipelineDeployStackActionProps

Throws:

NullPointerException - if any required attribute was not provided