software.amazon.awscdk.appdelivery

Class PipelineDeployStackAction.Builder

java.lang.Object

software.amazon.awscdk.appdelivery.PipelineDeployStackAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PipelineDeployStackAction>

Enclosing class:

PipelineDeployStackAction

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

(experimental) A fluent builder for PipelineDeployStackAction.

Method Summary

Modifier and Type	Method and Description
PipelineDeployStackAction.Builder	adminPermissions(Boolean adminPermissions) (experimental) Whether to grant admin permissions to CloudFormation while deploying this template.
PipelineDeployStackAction	build()
PipelineDeployStackAction.Builder	capabilities(List<? extends CloudFormationCapabilities> capabilities) (experimental) Acknowledge certain changes made as part of deployment.
PipelineDeployStackAction.Builder	changeSetName(String changeSetName) (experimental) The name to use when creating a ChangeSet for the stack.
static PipelineDeployStackAction.Builder	create()
PipelineDeployStackAction.Builder	createChangeSetActionName(String createChangeSetActionName) (experimental) The name of the CodePipeline action creating the ChangeSet.
PipelineDeployStackAction.Builder	createChangeSetRunOrder(Number createChangeSetRunOrder) (experimental) The runOrder for the CodePipeline action creating the ChangeSet.
PipelineDeployStackAction.Builder	executeChangeSetActionName(String executeChangeSetActionName) (experimental) The name of the CodePipeline action creating the ChangeSet.
PipelineDeployStackAction.Builder	executeChangeSetRunOrder(Number executeChangeSetRunOrder) (experimental) The runOrder for the CodePipeline action executing the ChangeSet.
PipelineDeployStackAction.Builder	input(Artifact input) (experimental) The CodePipeline artifact that holds the synthesized app, which is the contents of the ```` when running ``cdk synth -o ``.
PipelineDeployStackAction.Builder	role(IRole role) (experimental) IAM role to assume when deploying changes.
PipelineDeployStackAction.Builder	stack(Stack stack) (experimental) The CDK stack to be deployed.

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

Returns:

a new instance of PipelineDeployStackAction.Builder.

adminPermissions

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

(experimental) Whether to grant admin permissions to CloudFormation while deploying this template.

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.

Parameters:

adminPermissions - Whether to grant admin permissions to CloudFormation while deploying this template. This parameter is required.

Returns:

this

input

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

(experimental) The CodePipeline artifact that holds the synthesized app, which is the contents of the ```` when running ``cdk synth -o ``.

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 PipelineDeployStackAction.Builder stack(Stack stack)

(experimental) The CDK stack to be deployed.

Parameters:

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

Returns:

this

capabilities

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

(experimental) 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

Default: [AnonymousIAM, AutoExpand], unless `adminPermissions` is true

Parameters:

capabilities - Acknowledge certain changes made as part of deployment. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities

changeSetName

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

(experimental) The name to use when creating a ChangeSet for the stack.

Default: CDK-CodePipeline-ChangeSet

Parameters:

changeSetName - The name to use when creating a ChangeSet for the stack. This parameter is required.

Returns:

this

createChangeSetActionName

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

(experimental) The name of the CodePipeline action creating the ChangeSet.

Default: 'ChangeSet'

Parameters:

createChangeSetActionName - The name of the CodePipeline action creating the ChangeSet. This parameter is required.

Returns:

this

createChangeSetRunOrder

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

(experimental) The runOrder for the CodePipeline action creating the ChangeSet.

Default: 1

Parameters:

createChangeSetRunOrder - The runOrder for the CodePipeline action creating the ChangeSet. This parameter is required.

Returns:

this

executeChangeSetActionName

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

(experimental) The name of the CodePipeline action creating the ChangeSet.

Default: 'Execute'

Parameters:

executeChangeSetActionName - The name of the CodePipeline action creating the ChangeSet. This parameter is required.

Returns:

this

executeChangeSetRunOrder

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

(experimental) The runOrder for the CodePipeline action executing the ChangeSet.

Default: ``createChangeSetRunOrder + 1``

Parameters:

executeChangeSetRunOrder - The runOrder for the CodePipeline action executing the ChangeSet. This parameter is required.

Returns:

this

role

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

(experimental) 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.

Default: A fresh role with admin or no permissions (depending on the value of `adminPermissions`).

Parameters:

role - IAM role to assume when deploying changes. This parameter is required.

Returns:

this

build

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

Specified by:

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