Package software.amazon.awscdk

Class DefaultStackSynthesizerProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.DefaultStackSynthesizerProps.Jsii$Proxy

All Implemented Interfaces:

DefaultStackSynthesizerProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

DefaultStackSynthesizerProps

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

An implementation for DefaultStackSynthesizerProps

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

DefaultStackSynthesizerProps.Builder, DefaultStackSynthesizerProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(DefaultStackSynthesizerProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the DefaultStackSynthesizerProps.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 String	getBootstrapStackVersionSsmParameter()	Bootstrap stack version SSM parameter.
final String	getBucketPrefix()	bucketPrefix to use while storing S3 Assets.
final String	getCloudFormationExecutionRole()	The role CloudFormation will assume when deploying the Stack.
final Map<String,Object>	getDeployRoleAdditionalOptions()	Additional options to pass to STS when assuming the deploy role.
final String	getDeployRoleArn()	The role to assume to initiate a deployment in this environment.
final String	getDeployRoleExternalId()	External ID to use when assuming role for cloudformation deployments.
final String	getDockerTagPrefix()	A prefix to use while tagging and uploading Docker images to ECR.
final String	getFileAssetPublishingExternalId()	External ID to use when assuming role for file asset publishing.
final Map<String,Object>	getFileAssetPublishingRoleAdditionalOptions()	Additional options to pass to STS when assuming the file asset publishing.
final String	getFileAssetPublishingRoleArn()	The role to use to publish file assets to the S3 bucket in this environment.
final String	getFileAssetsBucketName()	Name of the S3 bucket to hold file assets.
final Boolean	getGenerateBootstrapVersionRule()	Whether to add a Rule to the stack template verifying the bootstrap stack version.
final String	getImageAssetPublishingExternalId()	External ID to use when assuming role for image asset publishing.
final Map<String,Object>	getImageAssetPublishingRoleAdditionalOptions()	Additional options to pass to STS when assuming the image asset publishing.
final String	getImageAssetPublishingRoleArn()	The role to use to publish image assets to the ECR repository in this environment.
final String	getImageAssetsRepositoryName()	Name of the ECR repository to hold Docker Image assets.
final Map<String,Object>	getLookupRoleAdditionalOptions()	Additional options to pass to STS when assuming the lookup role.
final String	getLookupRoleArn()	The role to use to look up values from the target AWS account during synthesis.
final String	getLookupRoleExternalId()	External ID to use when assuming lookup role.
final String	getQualifier()	Qualifier to disambiguate multiple environments in the same account.
final Boolean	getUseLookupRoleForStackOperations()	Use the bootstrapped lookup role for (read-only) stack operations.
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(DefaultStackSynthesizerProps.Builder builder)

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

Method Details

getBootstrapStackVersionSsmParameter

public final String getBootstrapStackVersionSsmParameter()

Description copied from interface: DefaultStackSynthesizerProps

Bootstrap stack version SSM parameter.

The placeholder ${Qualifier} will be replaced with the value of qualifier.

Default: DefaultStackSynthesizer.DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER

Specified by:

getBootstrapStackVersionSsmParameter in interface DefaultStackSynthesizerProps

getBucketPrefix

public final String getBucketPrefix()

Description copied from interface: DefaultStackSynthesizerProps

bucketPrefix to use while storing S3 Assets.

Default: - DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX

Specified by:

getBucketPrefix in interface DefaultStackSynthesizerProps

getCloudFormationExecutionRole

public final String getCloudFormationExecutionRole()

Description copied from interface: DefaultStackSynthesizerProps

The role CloudFormation will assume when deploying the Stack.

You must supply this if you have given a non-standard name to the execution role.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

Default: DefaultStackSynthesizer.DEFAULT_CLOUDFORMATION_ROLE_ARN

Specified by:

getCloudFormationExecutionRole in interface DefaultStackSynthesizerProps

getDeployRoleAdditionalOptions

public final Map<String,Object> getDeployRoleAdditionalOptions()

Description copied from interface: DefaultStackSynthesizerProps

Additional options to pass to STS when assuming the deploy role.

• RoleArn should not be used. Use the dedicated deployRoleArn property instead.
• ExternalId should not be used. Use the dedicated deployRoleExternalId instead.
• TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default.

Default: - No additional options.

Specified by:

getDeployRoleAdditionalOptions in interface DefaultStackSynthesizerProps

See Also:

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

getDeployRoleArn

public final String getDeployRoleArn()

Description copied from interface: DefaultStackSynthesizerProps

The role to assume to initiate a deployment in this environment.

You must supply this if you have given a non-standard name to the publishing role.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

Default: DefaultStackSynthesizer.DEFAULT_DEPLOY_ROLE_ARN

Specified by:

getDeployRoleArn in interface DefaultStackSynthesizerProps

getDeployRoleExternalId

public final String getDeployRoleExternalId()

Description copied from interface: DefaultStackSynthesizerProps

External ID to use when assuming role for cloudformation deployments.

Default: - No external ID

Specified by:

getDeployRoleExternalId in interface DefaultStackSynthesizerProps

getDockerTagPrefix

public final String getDockerTagPrefix()

Description copied from interface: DefaultStackSynthesizerProps

A prefix to use while tagging and uploading Docker images to ECR.

This does not add any separators - the source hash will be appended to this string directly.

Default: - DefaultStackSynthesizer.DEFAULT_DOCKER_ASSET_PREFIX

Specified by:

getDockerTagPrefix in interface DefaultStackSynthesizerProps

getFileAssetPublishingExternalId

public final String getFileAssetPublishingExternalId()

Description copied from interface: DefaultStackSynthesizerProps

External ID to use when assuming role for file asset publishing.

Default: - No external ID

Specified by:

getFileAssetPublishingExternalId in interface DefaultStackSynthesizerProps

getFileAssetPublishingRoleAdditionalOptions

public final Map<String,Object> getFileAssetPublishingRoleAdditionalOptions()

Description copied from interface: DefaultStackSynthesizerProps

Additional options to pass to STS when assuming the file asset publishing.

• RoleArn should not be used. Use the dedicated fileAssetPublishingRoleArn property instead.
• ExternalId should not be used. Use the dedicated fileAssetPublishingExternalId instead.
• TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default.

Default: - No additional options.

Specified by:

getFileAssetPublishingRoleAdditionalOptions in interface DefaultStackSynthesizerProps

See Also:

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

getFileAssetPublishingRoleArn

public final String getFileAssetPublishingRoleArn()

Description copied from interface: DefaultStackSynthesizerProps

The role to use to publish file assets to the S3 bucket in this environment.

You must supply this if you have given a non-standard name to the publishing role.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN

Specified by:

getFileAssetPublishingRoleArn in interface DefaultStackSynthesizerProps

getFileAssetsBucketName

public final String getFileAssetsBucketName()

Description copied from interface: DefaultStackSynthesizerProps

Name of the S3 bucket to hold file assets.

You must supply this if you have given a non-standard name to the staging bucket.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSETS_BUCKET_NAME

Specified by:

getFileAssetsBucketName in interface DefaultStackSynthesizerProps

getGenerateBootstrapVersionRule

public final Boolean getGenerateBootstrapVersionRule()

Description copied from interface: DefaultStackSynthesizerProps

Whether to add a Rule to the stack template verifying the bootstrap stack version.

This generally should be left set to true, unless you explicitly want to be able to deploy to an unbootstrapped environment.

Default: true

Specified by:

getGenerateBootstrapVersionRule in interface DefaultStackSynthesizerProps

getImageAssetPublishingExternalId

public final String getImageAssetPublishingExternalId()

Description copied from interface: DefaultStackSynthesizerProps

External ID to use when assuming role for image asset publishing.

Default: - No external ID

Specified by:

getImageAssetPublishingExternalId in interface DefaultStackSynthesizerProps

getImageAssetPublishingRoleAdditionalOptions

public final Map<String,Object> getImageAssetPublishingRoleAdditionalOptions()

Description copied from interface: DefaultStackSynthesizerProps

Additional options to pass to STS when assuming the image asset publishing.

• RoleArn should not be used. Use the dedicated imageAssetPublishingRoleArn property instead.
• ExternalId should not be used. Use the dedicated imageAssetPublishingExternalId instead.
• TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default.

Default: - No additional options.

Specified by:

getImageAssetPublishingRoleAdditionalOptions in interface DefaultStackSynthesizerProps

See Also:

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

getImageAssetPublishingRoleArn

public final String getImageAssetPublishingRoleArn()

Description copied from interface: DefaultStackSynthesizerProps

The role to use to publish image assets to the ECR repository in this environment.

You must supply this if you have given a non-standard name to the publishing role.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

Default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN

Specified by:

getImageAssetPublishingRoleArn in interface DefaultStackSynthesizerProps

getImageAssetsRepositoryName

public final String getImageAssetsRepositoryName()

Description copied from interface: DefaultStackSynthesizerProps

Name of the ECR repository to hold Docker Image assets.

You must supply this if you have given a non-standard name to the ECR repository.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

Default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME

Specified by:

getImageAssetsRepositoryName in interface DefaultStackSynthesizerProps

getLookupRoleAdditionalOptions

public final Map<String,Object> getLookupRoleAdditionalOptions()

Description copied from interface: DefaultStackSynthesizerProps

Additional options to pass to STS when assuming the lookup role.

• RoleArn should not be used. Use the dedicated lookupRoleArn property instead.
• ExternalId should not be used. Use the dedicated lookupRoleExternalId instead.
• TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default.

Default: - No additional options.

Specified by:

getLookupRoleAdditionalOptions in interface DefaultStackSynthesizerProps

See Also:

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

getLookupRoleArn

public final String getLookupRoleArn()

Description copied from interface: DefaultStackSynthesizerProps

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

Default: - None

Specified by:

getLookupRoleArn in interface DefaultStackSynthesizerProps

getLookupRoleExternalId

public final String getLookupRoleExternalId()

Description copied from interface: DefaultStackSynthesizerProps

External ID to use when assuming lookup role.

Default: - No external ID

Specified by:

getLookupRoleExternalId in interface DefaultStackSynthesizerProps

getQualifier

public final String getQualifier()

Description copied from interface: DefaultStackSynthesizerProps

Qualifier to disambiguate multiple environments in the same account.

You can use this and leave the other naming properties empty if you have deployed the bootstrap environment with standard names but only different qualifiers.

Default: - Value of context key '@aws-cdk/core:bootstrapQualifier' if set, otherwise `DefaultStackSynthesizer.DEFAULT_QUALIFIER`

Specified by:

getQualifier in interface DefaultStackSynthesizerProps

getUseLookupRoleForStackOperations

public final Boolean getUseLookupRoleForStackOperations()

Description copied from interface: DefaultStackSynthesizerProps

Use the bootstrapped lookup role for (read-only) stack operations.

Use the lookup role when performing a cdk diff. If set to false, the deploy role credentials will be used to perform a cdk diff.

Requires bootstrap stack version 8.

Default: true

Specified by:

getUseLookupRoleForStackOperations in interface DefaultStackSynthesizerProps

$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