DefaultStackSynthesizerProps

All Known Implementing Classes:: DefaultStackSynthesizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:53.048Z")
public interface DefaultStackSynthesizerProps

Configuration properties for DefaultStackSynthesizer.

Example:

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

- Method Detail
  - getBootstrapStackVersionSsmParameter
```
default java.lang.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
```
default java.lang.String getBucketPrefix()
```
    bucketPrefix to use while storing S3 Assets.
    Default: - DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX
  - getCloudFormationExecutionRole
```
default java.lang.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
```
default java.lang.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
```
default java.lang.String getDeployRoleExternalId()
```
    External ID to use when assuming role for cloudformation deployments.
    Default: - No external ID
  - getDockerTagPrefix
```
default java.lang.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
  - getFileAssetKeyArnExportName
```
@Deprecated
default java.lang.String getFileAssetKeyArnExportName()
```
    Deprecated. This property is not used anymore
    
    (deprecated) Name of the CloudFormation Export with the asset key name.
    You must supply this if you have given a non-standard name to the KMS key export
    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_KEY_ARN_EXPORT_NAME
  - getFileAssetPublishingExternalId
```
default java.lang.String getFileAssetPublishingExternalId()
```
    External ID to use when assuming role for file asset publishing.
    Default: - No external ID
  - getFileAssetPublishingRoleArn
```
default java.lang.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
```
default java.lang.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
```
default java.lang.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
```
default java.lang.String getImageAssetPublishingExternalId()
```
    External ID to use when assuming role for image asset publishing.
    Default: - No external ID
  - getImageAssetPublishingRoleArn
```
default java.lang.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
```
default java.lang.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
```
default java.lang.String getLookupRoleArn()
```
    The role to use to look up values from the target AWS account during synthesis.
    Default: - None
  - getLookupRoleExternalId
```
default java.lang.String getLookupRoleExternalId()
```
    External ID to use when assuming lookup role.
    Default: - No external ID
  - getQualifier
```
default java.lang.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
```
default java.lang.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
```
static DefaultStackSynthesizerProps.Builder builder()
```
    Returns:
    
    a DefaultStackSynthesizerProps.Builder of DefaultStackSynthesizerProps

Interface DefaultStackSynthesizerProps

Nested Class Summary

Method Summary

Method Detail

getBootstrapStackVersionSsmParameter

getBucketPrefix

getCloudFormationExecutionRole

getDeployRoleArn

getDeployRoleExternalId

getDockerTagPrefix

getFileAssetKeyArnExportName

getFileAssetPublishingExternalId

getFileAssetPublishingRoleArn

getFileAssetsBucketName

getGenerateBootstrapVersionRule

getImageAssetPublishingExternalId

getImageAssetPublishingRoleArn

getImageAssetsRepositoryName

getLookupRoleArn

getLookupRoleExternalId

getQualifier

getUseLookupRoleForStackOperations

builder