software.amazon.awscdk.appdelivery

Class PipelineDeployStackActionProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.appdelivery.PipelineDeployStackActionProps.Jsii$Proxy

All Implemented Interfaces:

PipelineDeployStackActionProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

PipelineDeployStackActionProps

@Stability(value=Experimental)
 @Internal
public static final class PipelineDeployStackActionProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements PipelineDeployStackActionProps

An implementation for PipelineDeployStackActionProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.appdelivery.PipelineDeployStackActionProps

PipelineDeployStackActionProps.Builder, PipelineDeployStackActionProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(Boolean adminPermissions, Artifact input, Stack stack, List<? extends CloudFormationCapabilities> capabilities, String changeSetName, String createChangeSetActionName, Number createChangeSetRunOrder, String executeChangeSetActionName, Number executeChangeSetRunOrder, IRole role) Constructor that initializes the object based on literal property values passed by the PipelineDeployStackActionProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
Boolean	getAdminPermissions() (experimental) Whether to grant admin permissions to CloudFormation while deploying this template.
List<CloudFormationCapabilities>	getCapabilities() (experimental) Acknowledge certain changes made as part of deployment.
String	getChangeSetName() (experimental) The name to use when creating a ChangeSet for the stack.
String	getCreateChangeSetActionName() (experimental) The name of the CodePipeline action creating the ChangeSet.
Number	getCreateChangeSetRunOrder() (experimental) The runOrder for the CodePipeline action creating the ChangeSet.
String	getExecuteChangeSetActionName() (experimental) The name of the CodePipeline action creating the ChangeSet.
Number	getExecuteChangeSetRunOrder() (experimental) The runOrder for the CodePipeline action executing the ChangeSet.
Artifact	getInput() (experimental) The CodePipeline artifact that holds the synthesized app, which is the contents of the ```` when running ``cdk synth -o ``.
IRole	getRole() (experimental) IAM role to assume when deploying changes.
Stack	getStack() (experimental) The CDK stack to be deployed.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.appdelivery.PipelineDeployStackActionProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(Boolean adminPermissions,
                     Artifact input,
                     Stack stack,
                     List<? extends CloudFormationCapabilities> capabilities,
                     String changeSetName,
                     String createChangeSetActionName,
                     Number createChangeSetRunOrder,
                     String executeChangeSetActionName,
                     Number executeChangeSetRunOrder,
                     IRole role)

Constructor that initializes the object based on literal property values passed by the PipelineDeployStackActionProps.Builder.

Method Detail

getAdminPermissions

public final Boolean getAdminPermissions()

Description copied from interface: PipelineDeployStackActionProps

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

Specified by:

getAdminPermissions in interface PipelineDeployStackActionProps

getInput

public final Artifact getInput()

Description copied from interface: PipelineDeployStackActionProps

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

Specified by:

getInput in interface PipelineDeployStackActionProps

getStack

public final Stack getStack()

Description copied from interface: PipelineDeployStackActionProps

(experimental) The CDK stack to be deployed.

Specified by:

getStack in interface PipelineDeployStackActionProps

getCapabilities

public final List<CloudFormationCapabilities> getCapabilities()

Description copied from interface: PipelineDeployStackActionProps

(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

Specified by:

getCapabilities in interface PipelineDeployStackActionProps

See Also:

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

getChangeSetName

public final String getChangeSetName()

Description copied from interface: PipelineDeployStackActionProps

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

Default: CDK-CodePipeline-ChangeSet

Specified by:

getChangeSetName in interface PipelineDeployStackActionProps

getCreateChangeSetActionName

public final String getCreateChangeSetActionName()

Description copied from interface: PipelineDeployStackActionProps

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

Default: 'ChangeSet'

Specified by:

getCreateChangeSetActionName in interface PipelineDeployStackActionProps

getCreateChangeSetRunOrder

public final Number getCreateChangeSetRunOrder()

Description copied from interface: PipelineDeployStackActionProps

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

Default: 1

Specified by:

getCreateChangeSetRunOrder in interface PipelineDeployStackActionProps

getExecuteChangeSetActionName

public final String getExecuteChangeSetActionName()

Description copied from interface: PipelineDeployStackActionProps

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

Default: 'Execute'

Specified by:

getExecuteChangeSetActionName in interface PipelineDeployStackActionProps

getExecuteChangeSetRunOrder

public final Number getExecuteChangeSetRunOrder()

Description copied from interface: PipelineDeployStackActionProps

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

Default: ``createChangeSetRunOrder + 1``

Specified by:

getExecuteChangeSetRunOrder in interface PipelineDeployStackActionProps

getRole

public final IRole getRole()

Description copied from interface: PipelineDeployStackActionProps

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

Specified by:

getRole in interface PipelineDeployStackActionProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object