Package software.amazon.awscdk.cloud_assembly_schema

Class AwsCloudFormationStackProperties.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cloud_assembly_schema.AwsCloudFormationStackProperties.Jsii$Proxy

All Implemented Interfaces:

AwsCloudFormationStackProperties, software.amazon.jsii.JsiiSerializable

Enclosing interface:

AwsCloudFormationStackProperties

@Stability(Stable)
@Internal
public static final class AwsCloudFormationStackProperties.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements AwsCloudFormationStackProperties

An implementation for AwsCloudFormationStackProperties

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.cloud_assembly_schema.AwsCloudFormationStackProperties

AwsCloudFormationStackProperties.Builder, AwsCloudFormationStackProperties.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(AwsCloudFormationStackProperties.Builder builder)	Constructor that initializes the object based on literal property values passed by the AwsCloudFormationStackProperties.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	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Map<String,Object>	getAssumeRoleAdditionalOptions()	Additional options to pass to STS when assuming the role.
final String	getAssumeRoleArn()	The role that needs to be assumed to deploy the stack.
final String	getAssumeRoleExternalId()	External ID to use when assuming role for cloudformation deployments.
final String	getBootstrapStackVersionSsmParameter()	SSM parameter where the bootstrap stack version number can be found.
final String	getCloudFormationExecutionRoleArn()	The role that is passed to CloudFormation to execute the change set.
final BootstrapRole	getLookupRole()	The role to use to look up values from the target AWS account.
final List<String>	getNotificationArns()	SNS Notification ARNs that should receive CloudFormation Stack Events.
final Map<String,String>	getParameters()	Values for CloudFormation stack parameters that should be passed when the stack is deployed.
final Number	getRequiresBootstrapStackVersion()	Version of bootstrap stack required to deploy this stack.
final String	getStackName()	The name to use for the CloudFormation stack.
final String	getStackTemplateAssetObjectUrl()	If the stack template has already been included in the asset manifest, its asset URL.
final Map<String,String>	getTags()	Values for CloudFormation stack tags that should be passed when the stack is deployed.
final String	getTemplateFile()	A file relative to the assembly root which contains the CloudFormation template for this stack.
final Boolean	getTerminationProtection()	Whether to enable termination protection for this stack.
final Boolean	getValidateOnSynth()	Whether this stack should be validated by the CLI after synthesis.
final 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

Constructor Details

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(AwsCloudFormationStackProperties.Builder builder)

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

Method Details

getTemplateFile

public final String getTemplateFile()

Description copied from interface: AwsCloudFormationStackProperties

A file relative to the assembly root which contains the CloudFormation template for this stack.

Specified by:

getTemplateFile in interface AwsCloudFormationStackProperties

getAssumeRoleAdditionalOptions

public final Map<String,Object> getAssumeRoleAdditionalOptions()

Description copied from interface: AwsCloudFormationStackProperties

Additional options to pass to STS when assuming the role.

• RoleArn should not be used. Use the dedicated assumeRoleArn property instead.
• ExternalId should not be used. Use the dedicated assumeRoleExternalId instead.

Default: - No additional options.

Specified by:

getAssumeRoleAdditionalOptions in interface AwsCloudFormationStackProperties

See Also:

• https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

getAssumeRoleArn

public final String getAssumeRoleArn()

Description copied from interface: AwsCloudFormationStackProperties

The role that needs to be assumed to deploy the stack.

Default: - No role is assumed (current credentials are used)

Specified by:

getAssumeRoleArn in interface AwsCloudFormationStackProperties

getAssumeRoleExternalId

public final String getAssumeRoleExternalId()

Description copied from interface: AwsCloudFormationStackProperties

External ID to use when assuming role for cloudformation deployments.

Default: - No external ID

Specified by:

getAssumeRoleExternalId in interface AwsCloudFormationStackProperties

getBootstrapStackVersionSsmParameter

public final String getBootstrapStackVersionSsmParameter()

Description copied from interface: AwsCloudFormationStackProperties

SSM parameter where the bootstrap stack version number can be found.

Only used if requiresBootstrapStackVersion is set.

• If this value is not set, the bootstrap stack name must be known at deployment time so the stack version can be looked up from the stack outputs.
• If this value is set, the bootstrap stack can have any name because we won't need to look it up.

Default: - Bootstrap stack version number looked up

Specified by:

getBootstrapStackVersionSsmParameter in interface AwsCloudFormationStackProperties

getCloudFormationExecutionRoleArn

public final String getCloudFormationExecutionRoleArn()

Description copied from interface: AwsCloudFormationStackProperties

The role that is passed to CloudFormation to execute the change set.

Default: - No role is passed (currently assumed role/credentials are used)

Specified by:

getCloudFormationExecutionRoleArn in interface AwsCloudFormationStackProperties

getLookupRole

public final BootstrapRole getLookupRole()

Description copied from interface: AwsCloudFormationStackProperties

The role to use to look up values from the target AWS account.

Default: - No role is assumed (current credentials are used)

Specified by:

getLookupRole in interface AwsCloudFormationStackProperties

getNotificationArns

public final List<String> getNotificationArns()

Description copied from interface: AwsCloudFormationStackProperties

SNS Notification ARNs that should receive CloudFormation Stack Events.

Default: - No notification arns

Specified by:

getNotificationArns in interface AwsCloudFormationStackProperties

getParameters

public final Map<String,String> getParameters()

Description copied from interface: AwsCloudFormationStackProperties

Values for CloudFormation stack parameters that should be passed when the stack is deployed.

Default: - No parameters

Specified by:

getParameters in interface AwsCloudFormationStackProperties

getRequiresBootstrapStackVersion

public final Number getRequiresBootstrapStackVersion()

Description copied from interface: AwsCloudFormationStackProperties

Version of bootstrap stack required to deploy this stack.

Default: - No bootstrap stack required

Specified by:

getRequiresBootstrapStackVersion in interface AwsCloudFormationStackProperties

getStackName

public final String getStackName()

Description copied from interface: AwsCloudFormationStackProperties

The name to use for the CloudFormation stack.

Default: - name derived from artifact ID

Specified by:

getStackName in interface AwsCloudFormationStackProperties

getStackTemplateAssetObjectUrl

public final String getStackTemplateAssetObjectUrl()

Description copied from interface: AwsCloudFormationStackProperties

If the stack template has already been included in the asset manifest, its asset URL.

Default: - Not uploaded yet, upload just before deploying

Specified by:

getStackTemplateAssetObjectUrl in interface AwsCloudFormationStackProperties

getTags

public final Map<String,String> getTags()

Description copied from interface: AwsCloudFormationStackProperties

Values for CloudFormation stack tags that should be passed when the stack is deployed.

Default: - No tags

Specified by:

getTags in interface AwsCloudFormationStackProperties

getTerminationProtection

public final Boolean getTerminationProtection()

Description copied from interface: AwsCloudFormationStackProperties

Whether to enable termination protection for this stack.

Default: false

Specified by:

getTerminationProtection in interface AwsCloudFormationStackProperties

getValidateOnSynth

public final Boolean getValidateOnSynth()

Description copied from interface: AwsCloudFormationStackProperties

Whether this stack should be validated by the CLI after synthesis.

Default: - false

Specified by:

getValidateOnSynth in interface AwsCloudFormationStackProperties

$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