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

Class BootstrapOptions.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<BootstrapOptions>

Enclosing interface:

BootstrapOptions

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

A builder for BootstrapOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BootstrapOptions.Builder	assetMetadata(Boolean assetMetadata)	Sets the value of SharedOptions.getAssetMetadata()
BootstrapOptions.Builder	bootstrapBucketName(String bootstrapBucketName)	Sets the value of BootstrapOptions.getBootstrapBucketName()
BootstrapOptions.Builder	bootstrapCustomerKey(String bootstrapCustomerKey)	Sets the value of BootstrapOptions.getBootstrapCustomerKey()
BootstrapOptions.Builder	bootstrapKmsKeyId(String bootstrapKmsKeyId)	Sets the value of BootstrapOptions.getBootstrapKmsKeyId()
BootstrapOptions	build()	Builds the configured instance.
BootstrapOptions.Builder	caBundlePath(String caBundlePath)	Sets the value of SharedOptions.getCaBundlePath()
BootstrapOptions.Builder	cfnExecutionPolicy(String cfnExecutionPolicy)	Sets the value of BootstrapOptions.getCfnExecutionPolicy()
BootstrapOptions.Builder	color(Boolean color)	Sets the value of SharedOptions.getColor()
BootstrapOptions.Builder	context(Map<String,String> context)	Sets the value of SharedOptions.getContext()
BootstrapOptions.Builder	customPermissionsBoundary(String customPermissionsBoundary)	Sets the value of BootstrapOptions.getCustomPermissionsBoundary()
BootstrapOptions.Builder	debug(Boolean debug)	Sets the value of SharedOptions.getDebug()
BootstrapOptions.Builder	ec2Creds(Boolean ec2Creds)	Sets the value of SharedOptions.getEc2Creds()
BootstrapOptions.Builder	examplePermissionsBoundary(Boolean examplePermissionsBoundary)	Sets the value of BootstrapOptions.getExamplePermissionsBoundary()
BootstrapOptions.Builder	execute(Boolean execute)	Sets the value of BootstrapOptions.getExecute()
BootstrapOptions.Builder	force(Boolean force)	Sets the value of BootstrapOptions.getForce()
BootstrapOptions.Builder	ignoreErrors(Boolean ignoreErrors)	Sets the value of SharedOptions.getIgnoreErrors()
BootstrapOptions.Builder	json(Boolean json)	Sets the value of SharedOptions.getJson()
BootstrapOptions.Builder	lookups(Boolean lookups)	Sets the value of SharedOptions.getLookups()
BootstrapOptions.Builder	notices(Boolean notices)	Sets the value of SharedOptions.getNotices()
BootstrapOptions.Builder	pathMetadata(Boolean pathMetadata)	Sets the value of SharedOptions.getPathMetadata()
BootstrapOptions.Builder	profile(String profile)	Sets the value of SharedOptions.getProfile()
BootstrapOptions.Builder	proxy(String proxy)	Sets the value of SharedOptions.getProxy()
BootstrapOptions.Builder	publicAccessBlockConfiguration(String publicAccessBlockConfiguration)	Sets the value of BootstrapOptions.getPublicAccessBlockConfiguration()
BootstrapOptions.Builder	qualifier(String qualifier)	Sets the value of BootstrapOptions.getQualifier()
BootstrapOptions.Builder	roleArn(String roleArn)	Sets the value of SharedOptions.getRoleArn()
BootstrapOptions.Builder	showTemplate(Boolean showTemplate)	Sets the value of BootstrapOptions.getShowTemplate()
BootstrapOptions.Builder	stacks(List<String> stacks)	Sets the value of SharedOptions.getStacks()
BootstrapOptions.Builder	staging(Boolean staging)	Sets the value of SharedOptions.getStaging()
BootstrapOptions.Builder	strict(Boolean strict)	Sets the value of SharedOptions.getStrict()
BootstrapOptions.Builder	template(String template)	Sets the value of BootstrapOptions.getTemplate()
BootstrapOptions.Builder	terminationProtection(Boolean terminationProtection)	Sets the value of BootstrapOptions.getTerminationProtection()
BootstrapOptions.Builder	toolkitStackName(String toolkitStackName)	Sets the value of BootstrapOptions.getToolkitStackName()
BootstrapOptions.Builder	trace(Boolean trace)	Sets the value of SharedOptions.getTrace()
BootstrapOptions.Builder	trust(String trust)	Sets the value of BootstrapOptions.getTrust()
BootstrapOptions.Builder	trustForLookup(String trustForLookup)	Sets the value of BootstrapOptions.getTrustForLookup()
BootstrapOptions.Builder	usePreviousParameters(Boolean usePreviousParameters)	Sets the value of BootstrapOptions.getUsePreviousParameters()
BootstrapOptions.Builder	verbose(Boolean verbose)	Sets the value of SharedOptions.getVerbose()
BootstrapOptions.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

bootstrapBucketName

@Stability(Experimental)
public BootstrapOptions.Builder bootstrapBucketName(String bootstrapBucketName)

Sets the value of BootstrapOptions.getBootstrapBucketName()

Parameters:

bootstrapBucketName - The name of the CDK toolkit bucket;. bucket will be created and must not exist

Returns:

this

bootstrapCustomerKey

@Stability(Experimental)
public BootstrapOptions.Builder bootstrapCustomerKey(String bootstrapCustomerKey)

Sets the value of BootstrapOptions.getBootstrapCustomerKey()

Parameters:

bootstrapCustomerKey - Create a Customer Master Key (CMK) for the bootstrap bucket (you will be charged but can customize permissions, modern bootstrapping only).

Returns:

this

bootstrapKmsKeyId

@Stability(Experimental)
public BootstrapOptions.Builder bootstrapKmsKeyId(String bootstrapKmsKeyId)

Sets the value of BootstrapOptions.getBootstrapKmsKeyId()

Parameters:

bootstrapKmsKeyId - AWS KMS master key ID used for the SSE-KMS encryption.

Returns:

this

cfnExecutionPolicy

@Stability(Experimental)
public BootstrapOptions.Builder cfnExecutionPolicy(String cfnExecutionPolicy)

Sets the value of BootstrapOptions.getCfnExecutionPolicy()

Parameters:

cfnExecutionPolicy - The Managed Policy ARNs that should be attached to the role performing deployments into this environment (may be repeated, modern bootstrapping only).

Returns:

this

customPermissionsBoundary

@Stability(Experimental)
public BootstrapOptions.Builder customPermissionsBoundary(String customPermissionsBoundary)

Sets the value of BootstrapOptions.getCustomPermissionsBoundary()

Parameters:

customPermissionsBoundary - Use the permissions boundary specified by name.

Returns:

this

examplePermissionsBoundary

@Stability(Experimental)
public BootstrapOptions.Builder examplePermissionsBoundary(Boolean examplePermissionsBoundary)

Sets the value of BootstrapOptions.getExamplePermissionsBoundary()

Parameters:

examplePermissionsBoundary - Use the example permissions boundary.

Returns:

this

execute

@Stability(Experimental)
public BootstrapOptions.Builder execute(Boolean execute)

Sets the value of BootstrapOptions.getExecute()

Parameters:

execute - Whether to execute ChangeSet (--no-execute will NOT execute the ChangeSet).

Returns:

this

force

@Stability(Experimental)
public BootstrapOptions.Builder force(Boolean force)

Sets the value of BootstrapOptions.getForce()

Parameters:

force - Always bootstrap even if it would downgrade template version.

Returns:

this

publicAccessBlockConfiguration

@Stability(Experimental)
public BootstrapOptions.Builder publicAccessBlockConfiguration(String publicAccessBlockConfiguration)

Sets the value of BootstrapOptions.getPublicAccessBlockConfiguration()

Parameters:

publicAccessBlockConfiguration - Block public access configuration on CDK toolkit bucket (enabled by default).

Returns:

this

qualifier

@Stability(Experimental)
public BootstrapOptions.Builder qualifier(String qualifier)

Sets the value of BootstrapOptions.getQualifier()

Parameters:

qualifier - String which must be unique for each bootstrap stack. You must configure it on your CDK app if you change this from the default.

Returns:

this

showTemplate

@Stability(Experimental)
public BootstrapOptions.Builder showTemplate(Boolean showTemplate)

Sets the value of BootstrapOptions.getShowTemplate()

Parameters:

showTemplate - Instead of actual bootstrapping, print the current CLI's bootstrapping template to stdout for customization.

Returns:

this

template

@Stability(Experimental)
public BootstrapOptions.Builder template(String template)

Sets the value of BootstrapOptions.getTemplate()

Parameters:

template - Use the template from the given file instead of the built-in one (use --show-template to obtain an example).

Returns:

this

terminationProtection

@Stability(Experimental)
public BootstrapOptions.Builder terminationProtection(Boolean terminationProtection)

Sets the value of BootstrapOptions.getTerminationProtection()

Parameters:

terminationProtection - Toggle CloudFormation termination protection on the bootstrap stacks.

Returns:

this

toolkitStackName

@Stability(Experimental)
public BootstrapOptions.Builder toolkitStackName(String toolkitStackName)

Sets the value of BootstrapOptions.getToolkitStackName()

Parameters:

toolkitStackName - The name of the CDK toolkit stack to create.

Returns:

this

trust

@Stability(Experimental)
public BootstrapOptions.Builder trust(String trust)

Sets the value of BootstrapOptions.getTrust()

Parameters:

trust - The AWS account IDs that should be trusted to perform deployments into this environment (may be repeated, modern bootstrapping only).

Returns:

this

trustForLookup

@Stability(Experimental)
public BootstrapOptions.Builder trustForLookup(String trustForLookup)

Sets the value of BootstrapOptions.getTrustForLookup()

Parameters:

trustForLookup - The AWS account IDs that should be trusted to look up values in this environment (may be repeated, modern bootstrapping only).

Returns:

this

usePreviousParameters

@Stability(Experimental)
public BootstrapOptions.Builder usePreviousParameters(Boolean usePreviousParameters)

Sets the value of BootstrapOptions.getUsePreviousParameters()

Parameters:

usePreviousParameters - Use previous values for existing parameters (you must specify all parameters on every deployment if this is disabled).

Returns:

this

assetMetadata

@Stability(Experimental)
public BootstrapOptions.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 BootstrapOptions.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 BootstrapOptions.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 BootstrapOptions.Builder context(Map<String,String> context)

Sets the value of SharedOptions.getContext()

Parameters:

context - Additional context.

Returns:

this

debug

@Stability(Experimental)
public BootstrapOptions.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 BootstrapOptions.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 BootstrapOptions.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 BootstrapOptions.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 BootstrapOptions.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 BootstrapOptions.Builder notices(Boolean notices)

Sets the value of SharedOptions.getNotices()

Parameters:

notices - Show relevant notices.

Returns:

this

pathMetadata

@Stability(Experimental)
public BootstrapOptions.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 BootstrapOptions.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 BootstrapOptions.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 BootstrapOptions.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 BootstrapOptions.Builder stacks(List<String> stacks)

Sets the value of SharedOptions.getStacks()

Parameters:

stacks - List of stacks to deploy.

Returns:

this

staging

@Stability(Experimental)
public BootstrapOptions.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 BootstrapOptions.Builder strict(Boolean strict)

Sets the value of SharedOptions.getStrict()

Parameters:

strict - Do not construct stacks with warnings.

Returns:

this

trace

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

Sets the value of SharedOptions.getTrace()

Parameters:

trace - Print trace for stack warnings.

Returns:

this

verbose

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

Sets the value of SharedOptions.getVerbose()

Parameters:

verbose - show debug logs.

Returns:

this

versionReporting

@Stability(Experimental)
public BootstrapOptions.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 BootstrapOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BootstrapOptions

Throws:

NullPointerException - if any required attribute was not provided