@aws-cdk_cli-lib-alpha.BootstrapOptions

interface BootstrapOptions ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.Cli.Lib.Alpha.BootstrapOptions
Gogithub.com/aws/aws-cdk-go/awscdkclilibalpha/v2#BootstrapOptions
Javasoftware.amazon.awscdk.cli.lib.alpha.BootstrapOptions
Pythonaws_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,
  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

NameTypeDescription
assetMetadata?๐Ÿ”นbooleanInclude "aws:asset:*" CloudFormation metadata for resources that use assets.
bootstrapBucketName?๐Ÿ”นstringThe name of the CDK toolkit bucket;
bootstrapCustomerKey?๐Ÿ”นstringCreate a Customer Master Key (CMK) for the bootstrap bucket (you will be charged but can customize permissions, modern bootstrapping only).
bootstrapKmsKeyId?๐Ÿ”นstringAWS KMS master key ID used for the SSE-KMS encryption.
caBundlePath?๐Ÿ”นstringPath to CA certificate to use when validating HTTPS requests.
cfnExecutionPolicy?๐Ÿ”นstringThe Managed Policy ARNs that should be attached to the role performing deployments into this environment (may be repeated, modern bootstrapping only).
color?๐Ÿ”นbooleanShow colors and other style from console output.
context?๐Ÿ”น{ [string]: string }Additional context.
customPermissionsBoundary?๐Ÿ”นstringUse the permissions boundary specified by name.
debug?๐Ÿ”นbooleanenable emission of additional debugging information, such as creation stack traces of tokens.
ec2Creds?๐Ÿ”นbooleanForce trying to fetch EC2 instance credentials.
examplePermissionsBoundary?๐Ÿ”นbooleanUse the example permissions boundary.
execute?๐Ÿ”นbooleanWhether to execute ChangeSet (--no-execute will NOT execute the ChangeSet).
force?๐Ÿ”นbooleanAlways bootstrap even if it would downgrade template version.
ignoreErrors?๐Ÿ”นbooleanIgnores synthesis errors, which will likely produce an invalid output.
json?๐Ÿ”นbooleanUse JSON output instead of YAML when templates are printed to STDOUT.
lookups?๐Ÿ”นbooleanPerform context lookups.
notices?๐Ÿ”นbooleanShow relevant notices.
pathMetadata?๐Ÿ”นbooleanInclude "aws:cdk:path" CloudFormation metadata for each resource.
profile?๐Ÿ”นstringUse the indicated AWS profile as the default environment.
proxy?๐Ÿ”นstringUse the indicated proxy.
publicAccessBlockConfiguration?๐Ÿ”นstringBlock public access configuration on CDK toolkit bucket (enabled by default).
qualifier?๐Ÿ”นstringString which must be unique for each bootstrap stack.
roleArn?๐Ÿ”นstringRole to pass to CloudFormation for deployment.
showTemplate?๐Ÿ”นbooleanInstead of actual bootstrapping, print the current CLI's bootstrapping template to stdout for customization.
stacks?๐Ÿ”นstring[]List of stacks to deploy.
staging?๐Ÿ”นbooleanCopy assets to the output directory.
strict?๐Ÿ”นbooleanDo not construct stacks with warnings.
template?๐Ÿ”นstringUse the template from the given file instead of the built-in one (use --show-template to obtain an example).
terminationProtection?๐Ÿ”นbooleanToggle CloudFormation termination protection on the bootstrap stacks.
toolkitStackName?๐Ÿ”นstringThe name of the CDK toolkit stack to create.
trace?๐Ÿ”นbooleanPrint trace for stack warnings.
trust?๐Ÿ”นstringThe AWS account IDs that should be trusted to perform deployments into this environment (may be repeated, modern bootstrapping only).
trustForLookup?๐Ÿ”นstringThe AWS account IDs that should be trusted to look up values in this environment (may be repeated, modern bootstrapping only).
usePreviousParameters?๐Ÿ”นbooleanUse previous values for existing parameters (you must specify all parameters on every deployment if this is disabled).
verbose?๐Ÿ”นbooleanshow debug logs.
versionReporting?๐Ÿ”นbooleanInclude "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.


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.