interface BootstrapOptions 🔹

Language	Type name
.NET	Amazon.CDK.Cli.Lib.Alpha.BootstrapOptions
Go	github.com/aws/aws-cdk-go/awscdkclilibalpha/v2#BootstrapOptions
Java	software.amazon.awscdk.cli.lib.alpha.BootstrapOptions
Python	aws_cdk.cli_lib_alpha.BootstrapOptions
TypeScript (source)	@aws-cdk/cli-lib-alpha » BootstrapOptions

Options to use with cdk bootstrap.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cli_lib_alpha from '@aws-cdk/cli-lib-alpha';
const bootstrapOptions: cli_lib_alpha.BootstrapOptions = {
  assetMetadata: false,
  bootstrapBucketName: 'bootstrapBucketName',
  bootstrapCustomerKey: 'bootstrapCustomerKey',
  bootstrapKmsKeyId: 'bootstrapKmsKeyId',
  caBundlePath: 'caBundlePath',
  cfnExecutionPolicy: 'cfnExecutionPolicy',
  color: false,
  context: {
    contextKey: 'context',
  },
  customPermissionsBoundary: 'customPermissionsBoundary',
  debug: false,
  ec2Creds: false,
  environments: ['environments'],
  examplePermissionsBoundary: false,
  execute: false,
  force: false,
  ignoreErrors: false,
  json: false,
  lookups: false,
  notices: false,
  pathMetadata: false,
  profile: 'profile',
  proxy: 'proxy',
  publicAccessBlockConfiguration: 'publicAccessBlockConfiguration',
  qualifier: 'qualifier',
  roleArn: 'roleArn',
  showTemplate: false,
  stacks: ['stacks'],
  staging: false,
  strict: false,
  template: 'template',
  terminationProtection: false,
  toolkitStackName: 'toolkitStackName',
  trace: false,
  trust: 'trust',
  trustForLookup: 'trustForLookup',
  usePreviousParameters: false,
  verbose: false,
  versionReporting: false,
};

Properties

Name	Type	Description
assetMetadata?🔹	boolean	Include "aws:asset:*" CloudFormation metadata for resources that use assets.
bootstrapBucketName?🔹	string	The name of the CDK toolkit bucket;
bootstrapCustomerKey?🔹	string	Create a Customer Master Key (CMK) for the bootstrap bucket (you will be charged but can customize permissions, modern bootstrapping only).
bootstrapKmsKeyId?🔹	string	AWS KMS master key ID used for the SSE-KMS encryption.
caBundlePath?🔹	string	Path to CA certificate to use when validating HTTPS requests.
cfnExecutionPolicy?🔹	string	The Managed Policy ARNs that should be attached to the role performing deployments into this environment (may be repeated, modern bootstrapping only).
color?🔹	boolean	Show colors and other style from console output.
context?🔹	{ [string]: string }	Additional context.
customPermissionsBoundary?🔹	string	Use the permissions boundary specified by name.
debug?🔹	boolean	enable emission of additional debugging information, such as creation stack traces of tokens.
ec2Creds?🔹	boolean	Force trying to fetch EC2 instance credentials.
environments?🔹	string[]	The target AWS environments to deploy the bootstrap stack to.
examplePermissionsBoundary?🔹	boolean	Use the example permissions boundary.
execute?🔹	boolean	Whether to execute ChangeSet (--no-execute will NOT execute the ChangeSet).
force?🔹	boolean	Always bootstrap even if it would downgrade template version.
ignoreErrors?🔹	boolean	Ignores synthesis errors, which will likely produce an invalid output.
json?🔹	boolean	Use JSON output instead of YAML when templates are printed to STDOUT.
lookups?🔹	boolean	Perform context lookups.
notices?🔹	boolean	Show relevant notices.
pathMetadata?🔹	boolean	Include "aws:cdk:path" CloudFormation metadata for each resource.
profile?🔹	string	Use the indicated AWS profile as the default environment.
proxy?🔹	string	Use the indicated proxy.
publicAccessBlockConfiguration?🔹	string	Block public access configuration on CDK toolkit bucket (enabled by default).
qualifier?🔹	string	String which must be unique for each bootstrap stack.
roleArn?🔹	string	Role to pass to CloudFormation for deployment.
showTemplate?🔹	boolean	Instead of actual bootstrapping, print the current CLI's bootstrapping template to stdout for customization.
stacks?🔹	string[]	List of stacks to deploy.
staging?🔹	boolean	Copy assets to the output directory.
strict?🔹	boolean	Do not construct stacks with warnings.
template?🔹	string	Use the template from the given file instead of the built-in one (use --show-template to obtain an example).
terminationProtection?🔹	boolean	Toggle CloudFormation termination protection on the bootstrap stacks.
toolkitStackName?🔹	string	The name of the CDK toolkit stack to create.
trace?🔹	boolean	Print trace for stack warnings.
trust?🔹	string	The AWS account IDs that should be trusted to perform deployments into this environment (may be repeated, modern bootstrapping only).
trustForLookup?🔹	string	The AWS account IDs that should be trusted to look up values in this environment (may be repeated, modern bootstrapping only).
usePreviousParameters?🔹	boolean	Use previous values for existing parameters (you must specify all parameters on every deployment if this is disabled).
verbose?🔹	boolean	show debug logs.
versionReporting?🔹	boolean	Include "AWS::CDK::Metadata" resource in synthesized templates.

---

assetMetadata?🔹

Type: boolean (optional, default: true)

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

---

bootstrapBucketName?🔹

Type: string (optional, default: auto-generated CloudFormation name)

The name of the CDK toolkit bucket;

bucket will be created and must not exist

---

bootstrapCustomerKey?🔹

Type: string (optional, default: undefined)

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

---

bootstrapKmsKeyId?🔹

Type: string (optional, default: undefined)

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

---

caBundlePath?🔹

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

Path to CA certificate to use when validating HTTPS requests.

---

cfnExecutionPolicy?🔹

Type: string (optional, default: none)

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

---

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.

---

customPermissionsBoundary?🔹

Type: string (optional, default: undefined)

Use the permissions boundary specified by name.

---

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.

---

environments?🔹

Type: string[] (optional, default: Bootstrap all environments referenced in the CDK app or determine an environment from local configuration.)

The target AWS environments to deploy the bootstrap stack to.

Uses the following format: aws://<account-id>/<region> Example

"aws://123456789012/us-east-1"

---

examplePermissionsBoundary?🔹

Type: boolean (optional, default: undefined)

Use the example permissions boundary.

---

execute?🔹

Type: boolean (optional, default: true)

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

---

force?🔹

Type: boolean (optional, default: false)

Always bootstrap even if it would downgrade template version.

---

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

---

publicAccessBlockConfiguration?🔹

Type: string (optional, default: undefined)

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

---

qualifier?🔹

Type: string (optional, default: undefined)

String which must be unique for each bootstrap stack.

You must configure it on your CDK app if you change this from the default.

---

roleArn?🔹

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

Role to pass to CloudFormation for deployment.

---

showTemplate?🔹

Type: boolean (optional, default: false)

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

---

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.

---

template?🔹

Type: string (optional)

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

---

terminationProtection?🔹

Type: boolean (optional, default: false)

Toggle CloudFormation termination protection on the bootstrap stacks.

---

toolkitStackName?🔹

Type: string (optional)

The name of the CDK toolkit stack to create.

---

trace?🔹

Type: boolean (optional, default: false)

Print trace for stack warnings.

---

trust?🔹

Type: string (optional, default: undefined)

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

---

trustForLookup?🔹

Type: string (optional, default: undefined)

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

---

usePreviousParameters?🔹

Type: boolean (optional, default: true)

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

---

verbose?🔹

Type: boolean (optional, default: false)

show debug logs.

---

versionReporting?🔹

Type: boolean (optional, default: true)

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