software.amazon.awscdk.appdelivery

Interface PipelineDeployStackActionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PipelineDeployStackActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/0.20.2 (build faba0be)",
           date="2019-11-11T17:18:01.663Z")
 @Stability(value=Experimental)
public interface PipelineDeployStackActionProps
extends software.amazon.jsii.JsiiSerializable

EXPERIMENTAL

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PipelineDeployStackActionProps.Builder A builder for PipelineDeployStackActionProps
static class	PipelineDeployStackActionProps.Jsii$Proxy An implementation for PipelineDeployStackActionProps

Method Summary

Modifier and Type	Method and Description
static PipelineDeployStackActionProps.Builder	builder()
Boolean	getAdminPermissions() Whether to grant admin permissions to CloudFormation while deploying this template.
default List<CloudFormationCapabilities>	getCapabilities() Acknowledge certain changes made as part of deployment.
default String	getChangeSetName() The name to use when creating a ChangeSet for the stack.
default Number	getCreateChangeSetRunOrder() The runOrder for the CodePipeline action creating the ChangeSet.
default Number	getExecuteChangeSetRunOrder() The runOrder for the CodePipeline action executing the ChangeSet.
Artifact	getInput() The CodePipeline artifact that holds the synthesized app, which is the contents of the ```` when running ``cdk synth -o ``.
default IRole	getRole() IAM role to assume when deploying changes.
Stack	getStack() The CDK stack to be deployed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAdminPermissions

@Stability(value=Experimental)
Boolean getAdminPermissions()

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. EXPERIMENTAL

getInput

@Stability(value=Experimental)
Artifact getInput()

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

getStack

@Stability(value=Experimental)
Stack getStack()

The CDK stack to be deployed. EXPERIMENTAL

getCapabilities

@Stability(value=Experimental)
default List<CloudFormationCapabilities> getCapabilities()

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 EXPERIMENTAL

See Also:

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

getChangeSetName

@Stability(value=Experimental)
default String getChangeSetName()

The name to use when creating a ChangeSet for the stack. Default: CDK-CodePipeline-ChangeSet EXPERIMENTAL

getCreateChangeSetRunOrder

@Stability(value=Experimental)
default Number getCreateChangeSetRunOrder()

The runOrder for the CodePipeline action creating the ChangeSet. Default: 1 EXPERIMENTAL

getExecuteChangeSetRunOrder

@Stability(value=Experimental)
default Number getExecuteChangeSetRunOrder()

The runOrder for the CodePipeline action executing the ChangeSet. Default: ``createChangeSetRunOrder + 1`` EXPERIMENTAL

getRole

@Stability(value=Experimental)
default IRole getRole()

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`). EXPERIMENTAL

builder

@Stability(value=Experimental)
static PipelineDeployStackActionProps.Builder builder()

Returns:

a PipelineDeployStackActionProps.Builder of PipelineDeployStackActionProps