@aws-cdk_cli-lib-alpha.SynthOptions

interface SynthOptions ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.Cli.Lib.Alpha.SynthOptions
Gogithub.com/aws/aws-cdk-go/awscdkclilibalpha/v2#SynthOptions
Javasoftware.amazon.awscdk.cli.lib.alpha.SynthOptions
Pythonaws_cdk.cli_lib_alpha.SynthOptions
TypeScript (source)@aws-cdk/cli-lib-alpha ยป SynthOptions

Options to use with cdk synth.

Example

// await this asynchronous method call using a language feature
cli.synth({
  stacks: ['MyTestStack'],
});

Properties

NameTypeDescription
assetMetadata?๐Ÿ”นbooleanInclude "aws:asset:*" CloudFormation metadata for resources that use assets.
caBundlePath?๐Ÿ”นstringPath to CA certificate to use when validating HTTPS requests.
color?๐Ÿ”นbooleanShow colors and other style from console output.
context?๐Ÿ”น{ [string]: string }Additional context.
debug?๐Ÿ”นbooleanenable emission of additional debugging information, such as creation stack traces of tokens.
ec2Creds?๐Ÿ”นbooleanForce trying to fetch EC2 instance credentials.
exclusively?๐Ÿ”นbooleanOnly synthesize the given stack.
ignoreErrors?๐Ÿ”นbooleanIgnores synthesis errors, which will likely produce an invalid output.
json?๐Ÿ”นbooleanUse JSON output instead of YAML when templates are printed to STDOUT.
lookups?๐Ÿ”นbooleanPerform context lookups.
notices?๐Ÿ”นbooleanShow relevant notices.
pathMetadata?๐Ÿ”นbooleanInclude "aws:cdk:path" CloudFormation metadata for each resource.
profile?๐Ÿ”นstringUse the indicated AWS profile as the default environment.
proxy?๐Ÿ”นstringUse the indicated proxy.
quiet?๐Ÿ”นbooleanDo not output CloudFormation Template to stdout.
roleArn?๐Ÿ”นstringRole to pass to CloudFormation for deployment.
stacks?๐Ÿ”นstring[]List of stacks to deploy.
staging?๐Ÿ”นbooleanCopy assets to the output directory.
strict?๐Ÿ”นbooleanDo not construct stacks with warnings.
trace?๐Ÿ”นbooleanPrint trace for stack warnings.
validation?๐Ÿ”นbooleanAfter synthesis, validate stacks with the "validateOnSynth" attribute set (can also be controlled with CDK_VALIDATION).
verbose?๐Ÿ”นbooleanshow debug logs.
versionReporting?๐Ÿ”นbooleanInclude "AWS::CDK::Metadata" resource in synthesized templates.

assetMetadata?๐Ÿ”น

Type: boolean (optional, default: true)

Include "aws:asset:*" CloudFormation metadata for resources that use assets.


caBundlePath?๐Ÿ”น

Type: string (optional, default: read from AWS_CA_BUNDLE environment variable)

Path to CA certificate to use when validating HTTPS requests.


color?๐Ÿ”น

Type: boolean (optional, default: true unless the environment variable NO_COLOR is set)

Show colors and other style from console output.


context?๐Ÿ”น

Type: { [string]: string } (optional, default: no additional context)

Additional context.


debug?๐Ÿ”น

Type: boolean (optional, default: false)

enable emission of additional debugging information, such as creation stack traces of tokens.


ec2Creds?๐Ÿ”น

Type: boolean (optional, default: guess EC2 instance status)

Force trying to fetch EC2 instance credentials.


exclusively?๐Ÿ”น

Type: boolean (optional, default: false)

Only synthesize the given stack.


ignoreErrors?๐Ÿ”น

Type: boolean (optional, default: false)

Ignores synthesis errors, which will likely produce an invalid output.


json?๐Ÿ”น

Type: boolean (optional, default: false)

Use JSON output instead of YAML when templates are printed to STDOUT.


lookups?๐Ÿ”น

Type: boolean (optional, default: true)

Perform context lookups.

Synthesis fails if this is disabled and context lookups need to be performed


notices?๐Ÿ”น

Type: boolean (optional, default: true)

Show relevant notices.


pathMetadata?๐Ÿ”น

Type: boolean (optional, default: true)

Include "aws:cdk:path" CloudFormation metadata for each resource.


profile?๐Ÿ”น

Type: string (optional, default: no profile is used)

Use the indicated AWS profile as the default environment.


proxy?๐Ÿ”น

Type: string (optional, default: no proxy)

Use the indicated proxy.

Will read from HTTPS_PROXY environment if specified


quiet?๐Ÿ”น

Type: boolean (optional, default: false;)

Do not output CloudFormation Template to stdout.


roleArn?๐Ÿ”น

Type: string (optional, default: use the bootstrap cfn-exec role)

Role to pass to CloudFormation for deployment.


stacks?๐Ÿ”น

Type: string[] (optional, default: all stacks)

List of stacks to deploy.


staging?๐Ÿ”น

Type: boolean (optional, default: false)

Copy assets to the output directory.

Needed for local debugging the source files with SAM CLI


strict?๐Ÿ”น

Type: boolean (optional, default: false)

Do not construct stacks with warnings.


trace?๐Ÿ”น

Type: boolean (optional, default: false)

Print trace for stack warnings.


validation?๐Ÿ”น

Type: boolean (optional, default: true;)

After synthesis, validate stacks with the "validateOnSynth" attribute set (can also be controlled with CDK_VALIDATION).


verbose?๐Ÿ”น

Type: boolean (optional, default: false)

show debug logs.


versionReporting?๐Ÿ”น

Type: boolean (optional, default: true)

Include "AWS::CDK::Metadata" resource in synthesized templates.