Package software.amazon.awscdk.cli.lib.alpha

Interface SynthOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SharedOptions

All Known Implementing Classes:

SynthOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:11.248Z")
@Stability(Experimental)
public interface SynthOptions
extends software.amazon.jsii.JsiiSerializable, SharedOptions

(experimental) Options to use with cdk synth.

Example:

 // await this asynchronous method call using a language feature
 cli.synth(SynthOptions.builder()
         .stacks(List.of("MyTestStack"))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SynthOptions.Builder	A builder for SynthOptions
static final class	SynthOptions.Jsii$Proxy	An implementation for SynthOptions

Method Summary

Modifier and Type	Method	Description
static SynthOptions.Builder	builder()
default Boolean	getExclusively()	(experimental) Only synthesize the given stack.
default Boolean	getQuiet()	(experimental) Do not output CloudFormation Template to stdout.
default Boolean	getValidation()	(experimental) After synthesis, validate stacks with the "validateOnSynth" attribute set (can also be controlled with CDK_VALIDATION).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.cli.lib.alpha.SharedOptions

getAssetMetadata, getCaBundlePath, getColor, getContext, getDebug, getEc2Creds, getIgnoreErrors, getJson, getLookups, getNotices, getPathMetadata, getProfile, getProxy, getRoleArn, getStacks, getStaging, getStrict, getTrace, getVerbose, getVersionReporting

Method Details

getExclusively

@Stability(Experimental)
@Nullable
default Boolean getExclusively()

(experimental) Only synthesize the given stack.

Default: false

getQuiet

@Stability(Experimental)
@Nullable
default Boolean getQuiet()

(experimental) Do not output CloudFormation Template to stdout.

Default: false;

getValidation

@Stability(Experimental)
@Nullable
default Boolean getValidation()

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

Default: true;

builder

@Stability(Experimental)
static SynthOptions.Builder builder()

Returns:

a SynthOptions.Builder of SynthOptions