interface SharedOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.Cli.Lib.Alpha.SharedOptions |
![]() | github.com/aws/aws-cdk-go/awscdkclilibalpha/v2#SharedOptions |
![]() | software.amazon.awscdk.cli.lib.alpha.SharedOptions |
![]() | aws_cdk.cli_lib_alpha.SharedOptions |
![]() | @aws-cdk/cli-lib-alpha ยป SharedOptions |
AWS CDK CLI options that apply to all commands.
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 sharedOptions: cli_lib_alpha.SharedOptions = {
assetMetadata: false,
caBundlePath: 'caBundlePath',
color: false,
context: {
contextKey: 'context',
},
debug: false,
ec2Creds: false,
ignoreErrors: false,
json: false,
lookups: false,
notices: false,
pathMetadata: false,
profile: 'profile',
proxy: 'proxy',
roleArn: 'roleArn',
stacks: ['stacks'],
staging: false,
strict: false,
trace: false,
verbose: false,
versionReporting: false,
};
Properties
Name | Type | Description |
---|---|---|
asset | boolean | Include "aws:asset:*" CloudFormation metadata for resources that use assets. |
ca | string | Path to CA certificate to use when validating HTTPS requests. |
color? | boolean | Show colors and other style from console output. |
context? | { [string]: string } | Additional context. |
debug? | boolean | enable emission of additional debugging information, such as creation stack traces of tokens. |
ec2 | boolean | Force trying to fetch EC2 instance credentials. |
ignore | 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. |
path | 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. |
role | string | Role to pass to CloudFormation for deployment. |
stacks? | string[] | List of stacks to deploy. |
staging? | boolean | Copy assets to the output directory. |
strict? | boolean | Do not construct stacks with warnings. |
trace? | boolean | Print trace for stack warnings. |
verbose? | boolean | show debug logs. |
version | 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.
caBundlePath?
Type:
string
(optional, default: read from AWS_CA_BUNDLE environment variable)
Path to CA certificate to use when validating HTTPS requests.
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.
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.
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
roleArn?
Type:
string
(optional, default: use the bootstrap cfn-exec role)
Role to pass to CloudFormation for deployment.
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.
trace?
Type:
boolean
(optional, default: false)
Print trace for stack warnings.
verbose?
Type:
boolean
(optional, default: false)
show debug logs.
versionReporting?
Type:
boolean
(optional, default: true)
Include "AWS::CDK::Metadata" resource in synthesized templates.