Implements IStackSynthesizer, IReusableStackSynthesizer, IBoundStackSynthesizer

Extends StackSynthesizer

Uses conventionally named roles and asset storage locations.

This synthesizer:

• Supports cross-account deployments (the CLI can have credentials to one account, and you can still deploy to another account by assuming roles with well-known names in the other account).
• Supports the CDK Pipelines library.

Requires the environment to have been bootstrapped with Bootstrap Stack V2 (also known as "modern bootstrap stack"). The synthesizer adds a version check to the template, to make sure the bootstrap stack is recent enough to support all features expected by this synthesizer.

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',
  }),
});

new DefaultStackSynthesizer(props?: DefaultStackSynthesizerProps)

Parameters

• props DefaultStackSynthesizerProps

Type: string

Returns the ARN of the CFN execution Role.

Type: string

Returns the ARN of the deploy Role.

Type: string (optional)

The qualifier used to bootstrap this stack.

Type: string (optional)

The role used to lookup for this stack.

⚠️ Deprecated: Use boundStack instead.

Type: Stack (optional)

Return the currently bound stack.

Type: string

Default bootstrap stack version SSM parameter.

Type: string

Default CloudFormation role ARN.

Type: string

Default deploy role ARN.

Type: string

Default Docker asset prefix.

Type: string

Default file assets bucket name.

Type: string

Name of the CloudFormation Export with the asset key name.

Type: string

Default file asset prefix.

Type: string

Default asset publishing role ARN for file (S3) assets.

Type: string

Default image assets repository name.

Type: string

Default asset publishing role ARN for image (ECR) assets.

Type: string

Default lookup role ARN for missing values.

Type: string

Default ARN qualifier.

public addDockerImageAsset(asset: DockerImageAssetSource): DockerImageAssetLocation

Parameters

• asset DockerImageAssetSource

Returns

• DockerImageAssetLocation

Register a Docker Image Asset.

Returns the parameters that can be used to refer to the asset inside the template.

The synthesizer must rely on some out-of-band mechanism to make sure the given files are actually placed in the returned location before the deployment happens. This can be by writing the instructions to the asset manifest (for use by the cdk-assets tool), by relying on the CLI to upload files (legacy behavior), or some other operator controlled mechanism.

public addFileAsset(asset: FileAssetSource): FileAssetLocation

Parameters

• asset FileAssetSource

Returns

• FileAssetLocation

Register a File Asset.

Returns the parameters that can be used to refer to the asset inside the template.

The synthesizer must rely on some out-of-band mechanism to make sure the given files are actually placed in the returned location before the deployment happens. This can be by writing the instructions to the asset manifest (for use by the cdk-assets tool), by relying on the CLI to upload files (legacy behavior), or some other operator controlled mechanism.

public bind(stack: Stack): void

Parameters

• stack Stack

Bind to the stack this environment is going to be used on.

Must be called before any of the other methods are called.

public reusableBind(stack: Stack): IBoundStackSynthesizer

Parameters

• stack Stack

Returns

• IBoundStackSynthesizer

Produce a bound Stack Synthesizer for the given stack.

This method may be called more than once on the same object.

public synthesize(session: ISynthesisSession): void

Parameters

• session ISynthesisSession

Synthesize the associated stack to the session.

protected synthesizeStackTemplate(stack: Stack, session: ISynthesisSession): void

Parameters

• stack Stack
• session ISynthesisSession

Synthesize the stack template to the given session, passing the configured lookup role ARN.