Package software.amazon.awscdk.cloudassembly.schema

Class DeployOptions.Builder

java.lang.Object

software.amazon.awscdk.cloudassembly.schema.DeployOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DeployOptions>

Enclosing interface:

DeployOptions

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

A builder for DeployOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeployOptions.Builder	all(Boolean all)	Sets the value of DefaultCdkOptions.getAll()
DeployOptions.Builder	app(String app)	Sets the value of DefaultCdkOptions.getApp()
DeployOptions.Builder	assetMetadata(Boolean assetMetadata)	Sets the value of DefaultCdkOptions.getAssetMetadata()
DeployOptions	build()	Builds the configured instance.
DeployOptions.Builder	caBundlePath(String caBundlePath)	Sets the value of DefaultCdkOptions.getCaBundlePath()
DeployOptions.Builder	changeSetName(String changeSetName)	Sets the value of DeployOptions.getChangeSetName()
DeployOptions.Builder	ci(Boolean ci)	Sets the value of DeployOptions.getCi()
DeployOptions.Builder	color(Boolean color)	Sets the value of DefaultCdkOptions.getColor()
DeployOptions.Builder	context(Map<String,String> context)	Sets the value of DefaultCdkOptions.getContext()
DeployOptions.Builder	debug(Boolean debug)	Sets the value of DefaultCdkOptions.getDebug()
DeployOptions.Builder	ec2Creds(Boolean ec2Creds)	Sets the value of DefaultCdkOptions.getEc2Creds()
DeployOptions.Builder	exclusively(Boolean exclusively)	Sets the value of DeployOptions.getExclusively()
DeployOptions.Builder	execute(Boolean execute)	Sets the value of DeployOptions.getExecute()
DeployOptions.Builder	force(Boolean force)	Sets the value of DeployOptions.getForce()
DeployOptions.Builder	ignoreErrors(Boolean ignoreErrors)	Sets the value of DefaultCdkOptions.getIgnoreErrors()
DeployOptions.Builder	json(Boolean json)	Sets the value of DefaultCdkOptions.getJson()
DeployOptions.Builder	lookups(Boolean lookups)	Sets the value of DefaultCdkOptions.getLookups()
DeployOptions.Builder	notices(Boolean notices)	Sets the value of DefaultCdkOptions.getNotices()
DeployOptions.Builder	notificationArns(List<String> notificationArns)	Sets the value of DeployOptions.getNotificationArns()
DeployOptions.Builder	output(String output)	Sets the value of DefaultCdkOptions.getOutput()
DeployOptions.Builder	outputsFile(String outputsFile)	Sets the value of DeployOptions.getOutputsFile()
DeployOptions.Builder	parameters(Map<String,String> parameters)	Sets the value of DeployOptions.getParameters()
DeployOptions.Builder	pathMetadata(Boolean pathMetadata)	Sets the value of DefaultCdkOptions.getPathMetadata()
DeployOptions.Builder	profile(String profile)	Sets the value of DefaultCdkOptions.getProfile()
DeployOptions.Builder	proxy(String proxy)	Sets the value of DefaultCdkOptions.getProxy()
DeployOptions.Builder	requireApproval(RequireApproval requireApproval)	Sets the value of DeployOptions.getRequireApproval()
DeployOptions.Builder	reuseAssets(List<String> reuseAssets)	Sets the value of DeployOptions.getReuseAssets()
DeployOptions.Builder	roleArn(String roleArn)	Sets the value of DefaultCdkOptions.getRoleArn()
DeployOptions.Builder	rollback(Boolean rollback)	Sets the value of DeployOptions.getRollback()
DeployOptions.Builder	stacks(List<String> stacks)	Sets the value of DefaultCdkOptions.getStacks()
DeployOptions.Builder	staging(Boolean staging)	Sets the value of DefaultCdkOptions.getStaging()
DeployOptions.Builder	strict(Boolean strict)	Sets the value of DefaultCdkOptions.getStrict()
DeployOptions.Builder	toolkitStackName(String toolkitStackName)	Sets the value of DeployOptions.getToolkitStackName()
DeployOptions.Builder	trace(Boolean trace)	Sets the value of DefaultCdkOptions.getTrace()
DeployOptions.Builder	usePreviousParameters(Boolean usePreviousParameters)	Sets the value of DeployOptions.getUsePreviousParameters()
DeployOptions.Builder	verbose(Boolean verbose)	Sets the value of DefaultCdkOptions.getVerbose()
DeployOptions.Builder	versionReporting(Boolean versionReporting)	Sets the value of DefaultCdkOptions.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

changeSetName

@Stability(Stable)
public DeployOptions.Builder changeSetName(String changeSetName)

Sets the value of DeployOptions.getChangeSetName()

Parameters:

changeSetName - Optional name to use for the CloudFormation change set. If not provided, a name will be generated automatically.

Returns:

this

ci

@Stability(Stable)
public DeployOptions.Builder ci(Boolean ci)

Sets the value of DeployOptions.getCi()

Parameters:

ci - Whether we are on a CI system.

Returns:

this

exclusively

@Stability(Stable)
public DeployOptions.Builder exclusively(Boolean exclusively)

Sets the value of DeployOptions.getExclusively()

Parameters:

exclusively - Only perform action on the given stack.

Returns:

this

execute

@Stability(Stable)
public DeployOptions.Builder execute(Boolean execute)

Sets the value of DeployOptions.getExecute()

Parameters:

execute - Whether to execute the ChangeSet Not providing execute parameter will result in execution of ChangeSet.

Returns:

this

force

@Stability(Stable)
public DeployOptions.Builder force(Boolean force)

Sets the value of DeployOptions.getForce()

Parameters:

force - Always deploy, even if templates are identical.

Returns:

this

notificationArns

@Stability(Stable)
public DeployOptions.Builder notificationArns(List<String> notificationArns)

Sets the value of DeployOptions.getNotificationArns()

Parameters:

notificationArns - ARNs of SNS topics that CloudFormation will notify with stack related events.

Returns:

this

outputsFile

@Stability(Stable)
public DeployOptions.Builder outputsFile(String outputsFile)

Sets the value of DeployOptions.getOutputsFile()

Parameters:

outputsFile - Path to file where stack outputs will be written after a successful deploy as JSON.

Returns:

this

parameters

@Stability(Stable)
public DeployOptions.Builder parameters(Map<String,String> parameters)

Sets the value of DeployOptions.getParameters()

Parameters:

parameters - Additional parameters for CloudFormation at deploy time.

Returns:

this

requireApproval

@Stability(Stable)
public DeployOptions.Builder requireApproval(RequireApproval requireApproval)

Sets the value of DeployOptions.getRequireApproval()

Parameters:

requireApproval - What kind of security changes require approval.

Returns:

this

reuseAssets

@Stability(Stable)
public DeployOptions.Builder reuseAssets(List<String> reuseAssets)

Sets the value of DeployOptions.getReuseAssets()

Parameters:

reuseAssets - Reuse the assets with the given asset IDs.

Returns:

this

rollback

@Stability(Stable)
public DeployOptions.Builder rollback(Boolean rollback)

Sets the value of DeployOptions.getRollback()

Parameters:

rollback - Rollback failed deployments.

Returns:

this

toolkitStackName

@Stability(Stable)
public DeployOptions.Builder toolkitStackName(String toolkitStackName)

Sets the value of DeployOptions.getToolkitStackName()

Parameters:

toolkitStackName - Name of the toolkit stack to use/deploy.

Returns:

this

usePreviousParameters

@Stability(Stable)
public DeployOptions.Builder usePreviousParameters(Boolean usePreviousParameters)

Sets the value of DeployOptions.getUsePreviousParameters()

Parameters:

usePreviousParameters - Use previous values for unspecified parameters. If not set, all parameters must be specified for every deployment.

Returns:

this

all

@Stability(Stable)
public DeployOptions.Builder all(Boolean all)

Sets the value of DefaultCdkOptions.getAll()

Parameters:

all - Deploy all stacks. Requried if stacks is not set

Returns:

this

app

@Stability(Stable)
public DeployOptions.Builder app(String app)

Sets the value of DefaultCdkOptions.getApp()

Parameters:

app - command-line for executing your app or a cloud assembly directory e.g. "node bin/my-app.js" or "cdk.out".

Returns:

this

assetMetadata

@Stability(Stable)
public DeployOptions.Builder assetMetadata(Boolean assetMetadata)

Sets the value of DefaultCdkOptions.getAssetMetadata()

Parameters:

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

Returns:

this

caBundlePath

@Stability(Stable)
public DeployOptions.Builder caBundlePath(String caBundlePath)

Sets the value of DefaultCdkOptions.getCaBundlePath()

Parameters:

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

Returns:

this

color

@Stability(Stable)
public DeployOptions.Builder color(Boolean color)

Sets the value of DefaultCdkOptions.getColor()

Parameters:

color - Show colors and other style from console output.

Returns:

this

context

@Stability(Stable)
public DeployOptions.Builder context(Map<String,String> context)

Sets the value of DefaultCdkOptions.getContext()

Parameters:

context - Additional context.

Returns:

this

debug

@Stability(Stable)
public DeployOptions.Builder debug(Boolean debug)

Sets the value of DefaultCdkOptions.getDebug()

Parameters:

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

Returns:

this

ec2Creds

@Stability(Stable)
public DeployOptions.Builder ec2Creds(Boolean ec2Creds)

Sets the value of DefaultCdkOptions.getEc2Creds()

Parameters:

ec2Creds - Force trying to fetch EC2 instance credentials.

Returns:

this

ignoreErrors

@Stability(Stable)
public DeployOptions.Builder ignoreErrors(Boolean ignoreErrors)

Sets the value of DefaultCdkOptions.getIgnoreErrors()

Parameters:

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

Returns:

this

json

@Stability(Stable)
public DeployOptions.Builder json(Boolean json)

Sets the value of DefaultCdkOptions.getJson()

Parameters:

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

Returns:

this

lookups

@Stability(Stable)
public DeployOptions.Builder lookups(Boolean lookups)

Sets the value of DefaultCdkOptions.getLookups()

Parameters:

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

Returns:

this

notices

@Stability(Stable)
public DeployOptions.Builder notices(Boolean notices)

Sets the value of DefaultCdkOptions.getNotices()

Parameters:

notices - Show relevant notices.

Returns:

this

output

@Stability(Stable)
public DeployOptions.Builder output(String output)

Sets the value of DefaultCdkOptions.getOutput()

Parameters:

output - Emits the synthesized cloud assembly into a directory.

Returns:

this

pathMetadata

@Stability(Stable)
public DeployOptions.Builder pathMetadata(Boolean pathMetadata)

Sets the value of DefaultCdkOptions.getPathMetadata()

Parameters:

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

Returns:

this

profile

@Stability(Stable)
public DeployOptions.Builder profile(String profile)

Sets the value of DefaultCdkOptions.getProfile()

Parameters:

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

Returns:

this

proxy

@Stability(Stable)
public DeployOptions.Builder proxy(String proxy)

Sets the value of DefaultCdkOptions.getProxy()

Parameters:

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

Returns:

this

roleArn

@Stability(Stable)
public DeployOptions.Builder roleArn(String roleArn)

Sets the value of DefaultCdkOptions.getRoleArn()

Parameters:

roleArn - Role to pass to CloudFormation for deployment.

Returns:

this

stacks

@Stability(Stable)
public DeployOptions.Builder stacks(List<String> stacks)

Sets the value of DefaultCdkOptions.getStacks()

Parameters:

stacks - List of stacks to deploy. Requried if all is not set

Returns:

this

staging

@Stability(Stable)
public DeployOptions.Builder staging(Boolean staging)

Sets the value of DefaultCdkOptions.getStaging()

Parameters:

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

Returns:

this

strict

@Stability(Stable)
public DeployOptions.Builder strict(Boolean strict)

Sets the value of DefaultCdkOptions.getStrict()

Parameters:

strict - Do not construct stacks with warnings.

Returns:

this

trace

@Stability(Stable)
public DeployOptions.Builder trace(Boolean trace)

Sets the value of DefaultCdkOptions.getTrace()

Parameters:

trace - Print trace for stack warnings.

Returns:

this

verbose

@Stability(Stable)
public DeployOptions.Builder verbose(Boolean verbose)

Sets the value of DefaultCdkOptions.getVerbose()

Parameters:

verbose - show debug logs.

Returns:

this

versionReporting

@Stability(Stable)
public DeployOptions.Builder versionReporting(Boolean versionReporting)

Sets the value of DefaultCdkOptions.getVersionReporting()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public DeployOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DeployOptions

Throws:

NullPointerException - if any required attribute was not provided