DefaultStackSynthesizerProps (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: DefaultStackSynthesizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.887Z")
 @Stability(value=Stable)
public interface DefaultStackSynthesizerProps
extends software.amazon.jsii.JsiiSerializable

Configuration properties for DefaultStackSynthesizer.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 MyStack.Builder.create(app, "MyStack")
         .synthesizer(DefaultStackSynthesizer.Builder.create()
                 .fileAssetsBucketName("my-orgs-asset-bucket")
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DefaultStackSynthesizerProps.Builder` A builder for `DefaultStackSynthesizerProps`
`static class`	`DefaultStackSynthesizerProps.Jsii$Proxy` An implementation for `DefaultStackSynthesizerProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static DefaultStackSynthesizerProps.Builder`	`builder()`
`default String`	`getBootstrapStackVersionSsmParameter()` Bootstrap stack version SSM parameter.
`default String`	`getBucketPrefix()` bucketPrefix to use while storing S3 Assets.
`default String`	`getCloudFormationExecutionRole()` The role CloudFormation will assume when deploying the Stack.
`default String`	`getDeployRoleArn()` The role to assume to initiate a deployment in this environment.
`default String`	`getDeployRoleExternalId()` External ID to use when assuming role for cloudformation deployments.
`default String`	`getDockerTagPrefix()` A prefix to use while tagging and uploading Docker images to ECR.
`default String`	`getFileAssetPublishingExternalId()` External ID to use when assuming role for file asset publishing.
`default String`	`getFileAssetPublishingRoleArn()` The role to use to publish file assets to the S3 bucket in this environment.
`default String`	`getFileAssetsBucketName()` Name of the S3 bucket to hold file assets.
`default Boolean`	`getGenerateBootstrapVersionRule()` Whether to add a Rule to the stack template verifying the bootstrap stack version.
`default String`	`getImageAssetPublishingExternalId()` External ID to use when assuming role for image asset publishing.
`default String`	`getImageAssetPublishingRoleArn()` The role to use to publish image assets to the ECR repository in this environment.
`default String`	`getImageAssetsRepositoryName()` Name of the ECR repository to hold Docker Image assets.
`default String`	`getLookupRoleArn()` The role to use to look up values from the target AWS account during synthesis.
`default String`	`getLookupRoleExternalId()` External ID to use when assuming lookup role.
`default String`	`getQualifier()` Qualifier to disambiguate multiple environments in the same account.
`default Boolean`	`getUseLookupRoleForStackOperations()` Use the bootstrapped lookup role for (read-only) stack operations.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getBootstrapStackVersionSsmParameter
```
@Stability(value=Stable)
 @Nullable
default String getBootstrapStackVersionSsmParameter()
```
    Bootstrap stack version SSM parameter.
    The placeholder ${Qualifier} will be replaced with the value of qualifier.
    Default: DefaultStackSynthesizer.DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER
  - getBucketPrefix
```
@Stability(value=Stable)
 @Nullable
default String getBucketPrefix()
```
    bucketPrefix to use while storing S3 Assets.
    Default: - DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX
  - getCloudFormationExecutionRole
```
@Stability(value=Stable)
 @Nullable
default String getCloudFormationExecutionRole()
```
    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
  - getDeployRoleArn
```
@Stability(value=Stable)
 @Nullable
default String getDeployRoleArn()
```
    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
  - getDeployRoleExternalId
```
@Stability(value=Stable)
 @Nullable
default String getDeployRoleExternalId()
```
    External ID to use when assuming role for cloudformation deployments.
    Default: - No external ID
  - getDockerTagPrefix
```
@Stability(value=Stable)
 @Nullable
default String getDockerTagPrefix()
```
    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
  - getFileAssetPublishingExternalId
```
@Stability(value=Stable)
 @Nullable
default String getFileAssetPublishingExternalId()
```
    External ID to use when assuming role for file asset publishing.
    Default: - No external ID
  - getFileAssetPublishingRoleArn
```
@Stability(value=Stable)
 @Nullable
default String getFileAssetPublishingRoleArn()
```
    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
  - getFileAssetsBucketName
```
@Stability(value=Stable)
 @Nullable
default String getFileAssetsBucketName()
```
    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
  - getGenerateBootstrapVersionRule
```
@Stability(value=Stable)
 @Nullable
default Boolean getGenerateBootstrapVersionRule()
```
    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
  - getImageAssetPublishingExternalId
```
@Stability(value=Stable)
 @Nullable
default String getImageAssetPublishingExternalId()
```
    External ID to use when assuming role for image asset publishing.
    Default: - No external ID
  - getImageAssetPublishingRoleArn
```
@Stability(value=Stable)
 @Nullable
default String getImageAssetPublishingRoleArn()
```
    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
  - getImageAssetsRepositoryName
```
@Stability(value=Stable)
 @Nullable
default String getImageAssetsRepositoryName()
```
    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
  - getLookupRoleArn
```
@Stability(value=Stable)
 @Nullable
default String getLookupRoleArn()
```
    The role to use to look up values from the target AWS account during synthesis.
    Default: - None
  - getLookupRoleExternalId
```
@Stability(value=Stable)
 @Nullable
default String getLookupRoleExternalId()
```
    External ID to use when assuming lookup role.
    Default: - No external ID
  - getQualifier
```
@Stability(value=Stable)
 @Nullable
default String getQualifier()
```
    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 differnet qualifiers.
    Default: - Value of context key '
  - getUseLookupRoleForStackOperations
```
@Stability(value=Stable)
 @Nullable
default Boolean getUseLookupRoleForStackOperations()
```
    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
  - builder
```
@Stability(value=Stable)
static DefaultStackSynthesizerProps.Builder builder()
```
    Returns:
    
    a DefaultStackSynthesizerProps.Builder of DefaultStackSynthesizerProps

Interface DefaultStackSynthesizerProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getBootstrapStackVersionSsmParameter

getBucketPrefix

getCloudFormationExecutionRole

getDeployRoleArn

getDeployRoleExternalId

getDockerTagPrefix

getFileAssetPublishingExternalId

getFileAssetPublishingRoleArn

getFileAssetsBucketName

getGenerateBootstrapVersionRule

getImageAssetPublishingExternalId

getImageAssetPublishingRoleArn

getImageAssetsRepositoryName

getLookupRoleArn

getLookupRoleExternalId

getQualifier

getUseLookupRoleForStackOperations

builder