Class AwsCloudFormationStackProperties.Jsii$Proxy
- java.lang.Object
-
- software.amazon.jsii.JsiiObject
-
- software.amazon.awscdk.cloudassembly.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 forAwsCloudFormationStackProperties
-
-
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.cloudassembly.schema.AwsCloudFormationStackProperties
AwsCloudFormationStackProperties.Builder, AwsCloudFormationStackProperties.Jsii$Proxy
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedJsii$Proxy(AwsCloudFormationStackProperties.Builder builder)Constructor that initializes the object based on literal property values passed by theAwsCloudFormationStackProperties.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)Constructor that initializes the object based on values retrieved from the JsiiObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNode$jsii$toJson()booleanequals(Object o)Map<String,Object>getAssumeRoleAdditionalOptions()Additional options to pass to STS when assuming the role.StringgetAssumeRoleArn()The role that needs to be assumed to deploy the stack.StringgetAssumeRoleExternalId()External ID to use when assuming role for cloudformation deployments.StringgetBootstrapStackVersionSsmParameter()SSM parameter where the bootstrap stack version number can be found.StringgetCloudFormationExecutionRoleArn()The role that is passed to CloudFormation to execute the change set.BootstrapRolegetLookupRole()The role to use to look up values from the target AWS account.List<String>getNotificationArns()SNS Notification ARNs that should receive CloudFormation Stack Events.Map<String,String>getParameters()Values for CloudFormation stack parameters that should be passed when the stack is deployed.NumbergetRequiresBootstrapStackVersion()Version of bootstrap stack required to deploy this stack.StringgetStackName()The name to use for the CloudFormation stack.StringgetStackTemplateAssetObjectUrl()If the stack template has already been included in the asset manifest, its asset URL.Map<String,String>getTags()Values for CloudFormation stack tags that should be passed when the stack is deployed.StringgetTemplateFile()A file relative to the assembly root which contains the CloudFormation template for this stack.BooleangetTerminationProtection()Whether to enable termination protection for this stack.BooleangetValidateOnSynth()Whether this stack should be validated by the CLI after synthesis.inthashCode()
-
-
-
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(AwsCloudFormationStackProperties.Builder builder)
Constructor that initializes the object based on literal property values passed by theAwsCloudFormationStackProperties.Builder.
-
-
Method Detail
-
getTemplateFile
public final String getTemplateFile()
Description copied from interface:AwsCloudFormationStackPropertiesA file relative to the assembly root which contains the CloudFormation template for this stack.- Specified by:
getTemplateFilein interfaceAwsCloudFormationStackProperties
-
getAssumeRoleAdditionalOptions
public final Map<String,Object> getAssumeRoleAdditionalOptions()
Description copied from interface:AwsCloudFormationStackPropertiesAdditional options to pass to STS when assuming the role.RoleArnshould not be used. Use the dedicatedassumeRoleArnproperty instead.ExternalIdshould not be used. Use the dedicatedassumeRoleExternalIdinstead.
Default: - No additional options.
- Specified by:
getAssumeRoleAdditionalOptionsin interfaceAwsCloudFormationStackProperties- See Also:
- https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property
-
getAssumeRoleArn
public final String getAssumeRoleArn()
Description copied from interface:AwsCloudFormationStackPropertiesThe role that needs to be assumed to deploy the stack.Default: - No role is assumed (current credentials are used)
- Specified by:
getAssumeRoleArnin interfaceAwsCloudFormationStackProperties
-
getAssumeRoleExternalId
public final String getAssumeRoleExternalId()
Description copied from interface:AwsCloudFormationStackPropertiesExternal ID to use when assuming role for cloudformation deployments.Default: - No external ID
- Specified by:
getAssumeRoleExternalIdin interfaceAwsCloudFormationStackProperties
-
getBootstrapStackVersionSsmParameter
public final String getBootstrapStackVersionSsmParameter()
Description copied from interface:AwsCloudFormationStackPropertiesSSM parameter where the bootstrap stack version number can be found.Only used if
requiresBootstrapStackVersionis 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:
getBootstrapStackVersionSsmParameterin interfaceAwsCloudFormationStackProperties
-
getCloudFormationExecutionRoleArn
public final String getCloudFormationExecutionRoleArn()
Description copied from interface:AwsCloudFormationStackPropertiesThe role that is passed to CloudFormation to execute the change set.Default: - No role is passed (currently assumed role/credentials are used)
- Specified by:
getCloudFormationExecutionRoleArnin interfaceAwsCloudFormationStackProperties
-
getLookupRole
public final BootstrapRole getLookupRole()
Description copied from interface:AwsCloudFormationStackPropertiesThe role to use to look up values from the target AWS account.Default: - No role is assumed (current credentials are used)
- Specified by:
getLookupRolein interfaceAwsCloudFormationStackProperties
-
getNotificationArns
public final List<String> getNotificationArns()
Description copied from interface:AwsCloudFormationStackPropertiesSNS Notification ARNs that should receive CloudFormation Stack Events.Default: - No notification arns
- Specified by:
getNotificationArnsin interfaceAwsCloudFormationStackProperties
-
getParameters
public final Map<String,String> getParameters()
Description copied from interface:AwsCloudFormationStackPropertiesValues for CloudFormation stack parameters that should be passed when the stack is deployed.Default: - No parameters
- Specified by:
getParametersin interfaceAwsCloudFormationStackProperties
-
getRequiresBootstrapStackVersion
public final Number getRequiresBootstrapStackVersion()
Description copied from interface:AwsCloudFormationStackPropertiesVersion of bootstrap stack required to deploy this stack.Default: - No bootstrap stack required
- Specified by:
getRequiresBootstrapStackVersionin interfaceAwsCloudFormationStackProperties
-
getStackName
public final String getStackName()
Description copied from interface:AwsCloudFormationStackPropertiesThe name to use for the CloudFormation stack.Default: - name derived from artifact ID
- Specified by:
getStackNamein interfaceAwsCloudFormationStackProperties
-
getStackTemplateAssetObjectUrl
public final String getStackTemplateAssetObjectUrl()
Description copied from interface:AwsCloudFormationStackPropertiesIf the stack template has already been included in the asset manifest, its asset URL.Default: - Not uploaded yet, upload just before deploying
- Specified by:
getStackTemplateAssetObjectUrlin interfaceAwsCloudFormationStackProperties
-
getTags
public final Map<String,String> getTags()
Description copied from interface:AwsCloudFormationStackPropertiesValues for CloudFormation stack tags that should be passed when the stack is deployed.Default: - No tags
- Specified by:
getTagsin interfaceAwsCloudFormationStackProperties
-
getTerminationProtection
public final Boolean getTerminationProtection()
Description copied from interface:AwsCloudFormationStackPropertiesWhether to enable termination protection for this stack.Default: false
- Specified by:
getTerminationProtectionin interfaceAwsCloudFormationStackProperties
-
getValidateOnSynth
public final Boolean getValidateOnSynth()
Description copied from interface:AwsCloudFormationStackPropertiesWhether this stack should be validated by the CLI after synthesis.Default: - false
- Specified by:
getValidateOnSynthin interfaceAwsCloudFormationStackProperties
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
-