DefaultStackSynthesizerProps Struct
Configuration properties for DefaultStackSynthesizer.
| Source | core/lib/stack-synthesizers/default-synthesizer.ts |
|---|---|
| Type last changed |
Example
declare const app: App;
const prodStage = new Stage(app, 'ProdStage', {
permissionsBoundary: PermissionsBoundary.fromName('cdk-${Qualifier}-PermissionsBoundary-${AWS::AccountId}-${AWS::Region}'),
});
new Stack(prodStage, 'ProdStack', {
synthesizer: new DefaultStackSynthesizer({
qualifier: 'custom',
}),
});
# app: App
prod_stage = Stage(app, "ProdStage",
permissions_boundary=PermissionsBoundary.from_name("cdk-${Qualifier}-PermissionsBoundary-${AWS::AccountId}-${AWS::Region}")
)
Stack(prod_stage, "ProdStack",
synthesizer=DefaultStackSynthesizer(
qualifier="custom"
)
)
App app;
Stage prodStage = Stage.Builder.create(app, "ProdStage")
.permissionsBoundary(PermissionsBoundary.fromName("cdk-${Qualifier}-PermissionsBoundary-${AWS::AccountId}-${AWS::Region}"))
.build();
Stack.Builder.create(prodStage, "ProdStack")
.synthesizer(DefaultStackSynthesizer.Builder.create()
.qualifier("custom")
.build())
.build();
// Install: dotnet add package Amazon.CDK.Lib
App app;
var prodStage = new Stage(app, "ProdStage", new StageProps {
PermissionsBoundary = PermissionsBoundary.FromName("cdk-${Qualifier}-PermissionsBoundary-${AWS::AccountId}-${AWS::Region}")
});
new Stack(prodStage, "ProdStack", new StackProps {
Synthesizer = new DefaultStackSynthesizer(new DefaultStackSynthesizerProps {
Qualifier = "custom"
})
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var app App
prodStage := awscdk.NewStage(app, jsii.String("ProdStage"), &StageProps{
PermissionsBoundary: awscdk.PermissionsBoundary_FromName(jsii.String("cdk-${Qualifier}-PermissionsBoundary-${AWS::AccountId}-${AWS::Region}")),
})
awscdk.Newstack(prodStage, jsii.String("ProdStack"), &StackProps{
Synthesizer: awscdk.NewDefaultStackSynthesizer(&DefaultStackSynthesizerProps{
Qualifier: jsii.String("custom"),
}),
})
Properties
bootstrapStackVersionSsmParameteroptionalstringbootstrap_stack_version_ssm_parameteroptionalstrbootstrapStackVersionSsmParameteroptionalStringBootstrapStackVersionSsmParameteroptionalstringBootstrapStackVersionSsmParameteroptional*string #Default: DefaultStackSynthesizer.DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER
The placeholder ${Qualifier} will be replaced with the value of qualifier.
bucketPrefixoptionalstringbucket_prefixoptionalstrbucketPrefixoptionalStringBucketPrefixoptionalstringBucketPrefixoptional*string #Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX
cloudFormationExecutionRoleoptionalstringcloud_formation_execution_roleoptionalstrcloudFormationExecutionRoleoptionalStringCloudFormationExecutionRoleoptionalstringCloudFormationExecutionRoleoptional*string #Default: DefaultStackSynthesizer.DEFAULT_CLOUDFORMATION_ROLE_ARN
notes
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.
deployRoleAdditionalOptionsoptional{ [key: string]: any }deploy_role_additional_optionsoptionaltyping.Mapping[str, Any]deployRoleAdditionalOptionsoptionalMap<String, Object>DeployRoleAdditionalOptionsoptionalIDictionary<string, object>DeployRoleAdditionalOptionsoptional*map[string]interface{} #Default: No additional options.
notes
RoleArnshould not be used. Use the dedicateddeployRoleArnproperty instead.ExternalIdshould not be used. Use the dedicateddeployRoleExternalIdinstead.TransitiveTagKeysdefaults to use all keys (if any) specified inTags. E.g, all tags are transitive by default.
deployRoleArnoptionalstringdeploy_role_arnoptionalstrdeployRoleArnoptionalStringDeployRoleArnoptionalstringDeployRoleArnoptional*string #Default: DefaultStackSynthesizer.DEFAULT_DEPLOY_ROLE_ARN
notes
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.
deployRoleExternalIdoptionalstringdeploy_role_external_idoptionalstrdeployRoleExternalIdoptionalStringDeployRoleExternalIdoptionalstringDeployRoleExternalIdoptional*string #Default: No external ID
dockerTagPrefixoptionalstringdocker_tag_prefixoptionalstrdockerTagPrefixoptionalStringDockerTagPrefixoptionalstringDockerTagPrefixoptional*string #Default: DefaultStackSynthesizer.DEFAULT_DOCKER_ASSET_PREFIX
This does not add any separators - the source hash will be appended to this string directly.
fileAssetPublishingExternalIdoptionalstringfile_asset_publishing_external_idoptionalstrfileAssetPublishingExternalIdoptionalStringFileAssetPublishingExternalIdoptionalstringFileAssetPublishingExternalIdoptional*string #Default: No external ID
fileAssetPublishingRoleAdditionalOptionsoptional{ [key: string]: any }file_asset_publishing_role_additional_optionsoptionaltyping.Mapping[str, Any]fileAssetPublishingRoleAdditionalOptionsoptionalMap<String, Object>FileAssetPublishingRoleAdditionalOptionsoptionalIDictionary<string, object>FileAssetPublishingRoleAdditionalOptionsoptional*map[string]interface{} #Default: No additional options.
notes
RoleArnshould not be used. Use the dedicatedfileAssetPublishingRoleArnproperty instead.ExternalIdshould not be used. Use the dedicatedfileAssetPublishingExternalIdinstead.TransitiveTagKeysdefaults to use all keys (if any) specified inTags. E.g, all tags are transitive by default.
fileAssetPublishingRoleArnoptionalstringfile_asset_publishing_role_arnoptionalstrfileAssetPublishingRoleArnoptionalStringFileAssetPublishingRoleArnoptionalstringFileAssetPublishingRoleArnoptional*string #Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN
notes
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.
fileAssetsBucketNameoptionalstringfile_assets_bucket_nameoptionalstrfileAssetsBucketNameoptionalStringFileAssetsBucketNameoptionalstringFileAssetsBucketNameoptional*string #Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSETS_BUCKET_NAME
notes
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.
generateBootstrapVersionRuleoptionalbooleangenerate_bootstrap_version_ruleoptionalboolgenerateBootstrapVersionRuleoptionalBooleanGenerateBootstrapVersionRuleoptionalboolGenerateBootstrapVersionRuleoptional*bool = true #This generally should be left set to true, unless you explicitly want to be able to deploy to an unbootstrapped environment.
imageAssetPublishingExternalIdoptionalstringimage_asset_publishing_external_idoptionalstrimageAssetPublishingExternalIdoptionalStringImageAssetPublishingExternalIdoptionalstringImageAssetPublishingExternalIdoptional*string #Default: No external ID
imageAssetPublishingRoleAdditionalOptionsoptional{ [key: string]: any }image_asset_publishing_role_additional_optionsoptionaltyping.Mapping[str, Any]imageAssetPublishingRoleAdditionalOptionsoptionalMap<String, Object>ImageAssetPublishingRoleAdditionalOptionsoptionalIDictionary<string, object>ImageAssetPublishingRoleAdditionalOptionsoptional*map[string]interface{} #Default: No additional options.
notes
RoleArnshould not be used. Use the dedicatedimageAssetPublishingRoleArnproperty instead.ExternalIdshould not be used. Use the dedicatedimageAssetPublishingExternalIdinstead.TransitiveTagKeysdefaults to use all keys (if any) specified inTags. E.g, all tags are transitive by default.
imageAssetPublishingRoleArnoptionalstringimage_asset_publishing_role_arnoptionalstrimageAssetPublishingRoleArnoptionalStringImageAssetPublishingRoleArnoptionalstringImageAssetPublishingRoleArnoptional*string #Default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN
notes
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.
imageAssetsRepositoryNameoptionalstringimage_assets_repository_nameoptionalstrimageAssetsRepositoryNameoptionalStringImageAssetsRepositoryNameoptionalstringImageAssetsRepositoryNameoptional*string #Default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME
notes
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.
lookupRoleAdditionalOptionsoptional{ [key: string]: any }lookup_role_additional_optionsoptionaltyping.Mapping[str, Any]lookupRoleAdditionalOptionsoptionalMap<String, Object>LookupRoleAdditionalOptionsoptionalIDictionary<string, object>LookupRoleAdditionalOptionsoptional*map[string]interface{} #Default: No additional options.
notes
RoleArnshould not be used. Use the dedicatedlookupRoleArnproperty instead.ExternalIdshould not be used. Use the dedicatedlookupRoleExternalIdinstead.TransitiveTagKeysdefaults to use all keys (if any) specified inTags. E.g, all tags are transitive by default.
lookupRoleArnoptionalstringlookup_role_arnoptionalstrlookupRoleArnoptionalStringLookupRoleArnoptionalstringLookupRoleArnoptional*string = None #lookupRoleExternalIdoptionalstringlookup_role_external_idoptionalstrlookupRoleExternalIdoptionalStringLookupRoleExternalIdoptionalstringLookupRoleExternalIdoptional*string #Default: No external ID
qualifieroptionalstringqualifieroptionalstrqualifieroptionalStringQualifieroptionalstringQualifieroptional*string #Default: Value of context key '@aws-cdk/core:bootstrapQualifier' if set, otherwise DefaultStackSynthesizer.DEFAULT_QUALIFIER
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.
useLookupRoleForStackOperationsoptionalbooleanuse_lookup_role_for_stack_operationsoptionalbooluseLookupRoleForStackOperationsoptionalBooleanUseLookupRoleForStackOperationsoptionalboolUseLookupRoleForStackOperationsoptional*bool = true #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.