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

Class SynthOptions.Builder

java.lang.Object

software.amazon.awscdk.cli.lib.alpha.SynthOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SynthOptions>

Enclosing interface:

SynthOptions

@Stability(Experimental)
public static final class SynthOptions.Builder
extends Object
implements software.amazon.jsii.Builder<SynthOptions>

A builder for SynthOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SynthOptions.Builder	assetMetadata(Boolean assetMetadata)	Sets the value of SharedOptions.getAssetMetadata()
SynthOptions	build()	Builds the configured instance.
SynthOptions.Builder	caBundlePath(String caBundlePath)	Sets the value of SharedOptions.getCaBundlePath()
SynthOptions.Builder	color(Boolean color)	Sets the value of SharedOptions.getColor()
SynthOptions.Builder	context(Map<String,String> context)	Sets the value of SharedOptions.getContext()
SynthOptions.Builder	debug(Boolean debug)	Sets the value of SharedOptions.getDebug()
SynthOptions.Builder	ec2Creds(Boolean ec2Creds)	Sets the value of SharedOptions.getEc2Creds()
SynthOptions.Builder	exclusively(Boolean exclusively)	Sets the value of SynthOptions.getExclusively()
SynthOptions.Builder	ignoreErrors(Boolean ignoreErrors)	Sets the value of SharedOptions.getIgnoreErrors()
SynthOptions.Builder	json(Boolean json)	Sets the value of SharedOptions.getJson()
SynthOptions.Builder	lookups(Boolean lookups)	Sets the value of SharedOptions.getLookups()
SynthOptions.Builder	notices(Boolean notices)	Sets the value of SharedOptions.getNotices()
SynthOptions.Builder	pathMetadata(Boolean pathMetadata)	Sets the value of SharedOptions.getPathMetadata()
SynthOptions.Builder	profile(String profile)	Sets the value of SharedOptions.getProfile()
SynthOptions.Builder	proxy(String proxy)	Sets the value of SharedOptions.getProxy()
SynthOptions.Builder	quiet(Boolean quiet)	Sets the value of SynthOptions.getQuiet()
SynthOptions.Builder	roleArn(String roleArn)	Sets the value of SharedOptions.getRoleArn()
SynthOptions.Builder	stacks(List<String> stacks)	Sets the value of SharedOptions.getStacks()
SynthOptions.Builder	staging(Boolean staging)	Sets the value of SharedOptions.getStaging()
SynthOptions.Builder	strict(Boolean strict)	Sets the value of SharedOptions.getStrict()
SynthOptions.Builder	trace(Boolean trace)	Sets the value of SharedOptions.getTrace()
SynthOptions.Builder	validation(Boolean validation)	Sets the value of SynthOptions.getValidation()
SynthOptions.Builder	verbose(Boolean verbose)	Sets the value of SharedOptions.getVerbose()
SynthOptions.Builder	versionReporting(Boolean versionReporting)	Sets the value of SharedOptions.getVersionReporting()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

exclusively

@Stability(Experimental)
public SynthOptions.Builder exclusively(Boolean exclusively)

Sets the value of SynthOptions.getExclusively()

Parameters:

exclusively - Only synthesize the given stack.

Returns:

this

quiet

@Stability(Experimental)
public SynthOptions.Builder quiet(Boolean quiet)

Sets the value of SynthOptions.getQuiet()

Parameters:

quiet - Do not output CloudFormation Template to stdout.

Returns:

this

validation

@Stability(Experimental)
public SynthOptions.Builder validation(Boolean validation)

Sets the value of SynthOptions.getValidation()

Parameters:

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

Returns:

this

assetMetadata

@Stability(Experimental)
public SynthOptions.Builder assetMetadata(Boolean assetMetadata)

Sets the value of SharedOptions.getAssetMetadata()

Parameters:

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

Returns:

this

caBundlePath

@Stability(Experimental)
public SynthOptions.Builder caBundlePath(String caBundlePath)

Sets the value of SharedOptions.getCaBundlePath()

Parameters:

caBundlePath - Path to CA certificate to use when validating HTTPS requests.

Returns:

this

color

@Stability(Experimental)
public SynthOptions.Builder color(Boolean color)

Sets the value of SharedOptions.getColor()

Parameters:

color - Show colors and other style from console output.

Returns:

this

context

@Stability(Experimental)
public SynthOptions.Builder context(Map<String,String> context)

Sets the value of SharedOptions.getContext()

Parameters:

context - Additional context.

Returns:

this

debug

@Stability(Experimental)
public SynthOptions.Builder debug(Boolean debug)

Sets the value of SharedOptions.getDebug()

Parameters:

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

Returns:

this

ec2Creds

@Stability(Experimental)
public SynthOptions.Builder ec2Creds(Boolean ec2Creds)

Sets the value of SharedOptions.getEc2Creds()

Parameters:

ec2Creds - Force trying to fetch EC2 instance credentials.

Returns:

this

ignoreErrors

@Stability(Experimental)
public SynthOptions.Builder ignoreErrors(Boolean ignoreErrors)

Sets the value of SharedOptions.getIgnoreErrors()

Parameters:

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

Returns:

this

json

@Stability(Experimental)
public SynthOptions.Builder json(Boolean json)

Sets the value of SharedOptions.getJson()

Parameters:

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

Returns:

this

lookups

@Stability(Experimental)
public SynthOptions.Builder lookups(Boolean lookups)

Sets the value of SharedOptions.getLookups()

Parameters:

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

Returns:

this

notices

@Stability(Experimental)
public SynthOptions.Builder notices(Boolean notices)

Sets the value of SharedOptions.getNotices()

Parameters:

notices - Show relevant notices.

Returns:

this

pathMetadata

@Stability(Experimental)
public SynthOptions.Builder pathMetadata(Boolean pathMetadata)

Sets the value of SharedOptions.getPathMetadata()

Parameters:

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

Returns:

this

profile

@Stability(Experimental)
public SynthOptions.Builder profile(String profile)

Sets the value of SharedOptions.getProfile()

Parameters:

profile - Use the indicated AWS profile as the default environment.

Returns:

this

proxy

@Stability(Experimental)
public SynthOptions.Builder proxy(String proxy)

Sets the value of SharedOptions.getProxy()

Parameters:

proxy - Use the indicated proxy. Will read from HTTPS_PROXY environment if specified

Returns:

this

roleArn

@Stability(Experimental)
public SynthOptions.Builder roleArn(String roleArn)

Sets the value of SharedOptions.getRoleArn()

Parameters:

roleArn - Role to pass to CloudFormation for deployment.

Returns:

this

stacks

@Stability(Experimental)
public SynthOptions.Builder stacks(List<String> stacks)

Sets the value of SharedOptions.getStacks()

Parameters:

stacks - List of stacks to deploy.

Returns:

this

staging

@Stability(Experimental)
public SynthOptions.Builder staging(Boolean staging)

Sets the value of SharedOptions.getStaging()

Parameters:

staging - Copy assets to the output directory. Needed for local debugging the source files with SAM CLI

Returns:

this

strict

@Stability(Experimental)
public SynthOptions.Builder strict(Boolean strict)

Sets the value of SharedOptions.getStrict()

Parameters:

strict - Do not construct stacks with warnings.

Returns:

this

trace

@Stability(Experimental)
public SynthOptions.Builder trace(Boolean trace)

Sets the value of SharedOptions.getTrace()

Parameters:

trace - Print trace for stack warnings.

Returns:

this

verbose

@Stability(Experimental)
public SynthOptions.Builder verbose(Boolean verbose)

Sets the value of SharedOptions.getVerbose()

Parameters:

verbose - show debug logs.

Returns:

this

versionReporting

@Stability(Experimental)
public SynthOptions.Builder versionReporting(Boolean versionReporting)

Sets the value of SharedOptions.getVersionReporting()

Parameters:

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

Returns:

this

build

@Stability(Experimental)
public SynthOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<SynthOptions>

Returns:

a new instance of SynthOptions

Throws:

NullPointerException - if any required attribute was not provided