SharedOptions

class aws_cdk.cli_lib_alpha.SharedOptions(*, asset_metadata=None, ca_bundle_path=None, color=None, context=None, debug=None, ec2_creds=None, ignore_errors=None, json=None, lookups=None, notices=None, path_metadata=None, profile=None, proxy=None, role_arn=None, stacks=None, staging=None, strict=None, trace=None, verbose=None, version_reporting=None)

Bases: object

(experimental) AWS CDK CLI options that apply to all commands.

Parameters:

  • asset_metadata (Optional[bool]) – (experimental) Include “aws:asset:*” CloudFormation metadata for resources that use assets. Default: true

  • ca_bundle_path (Optional[str]) – (experimental) Path to CA certificate to use when validating HTTPS requests. Default: - read from AWS_CA_BUNDLE environment variable

  • color (Optional[bool]) – (experimental) Show colors and other style from console output. Default: - true unless the environment variable NO_COLOR is set

  • context (Optional[Mapping[str, str]]) – (experimental) Additional context. Default: - no additional context

  • debug (Optional[bool]) – (experimental) enable emission of additional debugging information, such as creation stack traces of tokens. Default: false

  • ec2_creds (Optional[bool]) – (experimental) Force trying to fetch EC2 instance credentials. Default: - guess EC2 instance status

  • ignore_errors (Optional[bool]) – (experimental) Ignores synthesis errors, which will likely produce an invalid output. Default: false

  • json (Optional[bool]) – (experimental) Use JSON output instead of YAML when templates are printed to STDOUT. Default: false

  • lookups (Optional[bool]) – (experimental) Perform context lookups. Synthesis fails if this is disabled and context lookups need to be performed Default: true

  • notices (Optional[bool]) – (experimental) Show relevant notices. Default: true

  • path_metadata (Optional[bool]) – (experimental) Include “aws:cdk:path” CloudFormation metadata for each resource. Default: true

  • profile (Optional[str]) – (experimental) Use the indicated AWS profile as the default environment. Default: - no profile is used

  • proxy (Optional[str]) – (experimental) Use the indicated proxy. Will read from HTTPS_PROXY environment if specified Default: - no proxy

  • role_arn (Optional[str]) – (experimental) Role to pass to CloudFormation for deployment. Default: - use the bootstrap cfn-exec role

  • stacks (Optional[Sequence[str]]) – (experimental) List of stacks to deploy. Default: - all stacks

  • staging (Optional[bool]) – (experimental) Copy assets to the output directory. Needed for local debugging the source files with SAM CLI Default: false

  • strict (Optional[bool]) – (experimental) Do not construct stacks with warnings. Default: false

  • trace (Optional[bool]) – (experimental) Print trace for stack warnings. Default: false

  • verbose (Optional[bool]) – (experimental) show debug logs. Default: false

  • version_reporting (Optional[bool]) – (experimental) Include “AWS::CDK::Metadata” resource in synthesized templates. Default: true

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.cli_lib_alpha as cli_lib_alpha

shared_options = cli_lib_alpha.SharedOptions(
    asset_metadata=False,
    ca_bundle_path="caBundlePath",
    color=False,
    context={
        "context_key": "context"
    },
    debug=False,
    ec2_creds=False,
    ignore_errors=False,
    json=False,
    lookups=False,
    notices=False,
    path_metadata=False,
    profile="profile",
    proxy="proxy",
    role_arn="roleArn",
    stacks=["stacks"],
    staging=False,
    strict=False,
    trace=False,
    verbose=False,
    version_reporting=False
)

Attributes

asset_metadata

*” CloudFormation metadata for resources that use assets.

Default:

true

Stability:

experimental

Type:

(experimental) Include “aws

Type:

asset

ca_bundle_path

(experimental) Path to CA certificate to use when validating HTTPS requests.

Default:

  • read from AWS_CA_BUNDLE environment variable

Stability:

experimental

color

(experimental) Show colors and other style from console output.

Default:

  • true unless the environment variable NO_COLOR is set

Stability:

experimental

context

(experimental) Additional context.

Default:

  • no additional context

Stability:

experimental

debug

(experimental) enable emission of additional debugging information, such as creation stack traces of tokens.

Default:

false

Stability:

experimental

ec2_creds

(experimental) Force trying to fetch EC2 instance credentials.

Default:

  • guess EC2 instance status

Stability:

experimental

ignore_errors

(experimental) Ignores synthesis errors, which will likely produce an invalid output.

Default:

false

Stability:

experimental

json

(experimental) Use JSON output instead of YAML when templates are printed to STDOUT.

Default:

false

Stability:

experimental

lookups

(experimental) Perform context lookups.

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

Default:

true

Stability:

experimental

notices

(experimental) Show relevant notices.

Default:

true

Stability:

experimental

path_metadata

path” CloudFormation metadata for each resource.

Default:

true

Stability:

experimental

Type:

(experimental) Include “aws

Type:

cdk

profile

(experimental) Use the indicated AWS profile as the default environment.

Default:

  • no profile is used

Stability:

experimental

proxy

(experimental) Use the indicated proxy.

Will read from HTTPS_PROXY environment if specified

Default:

  • no proxy

Stability:

experimental

role_arn

(experimental) Role to pass to CloudFormation for deployment.

Default:

  • use the bootstrap cfn-exec role

Stability:

experimental

stacks

(experimental) List of stacks to deploy.

Default:

  • all stacks

Stability:

experimental

staging

(experimental) Copy assets to the output directory.

Needed for local debugging the source files with SAM CLI

Default:

false

Stability:

experimental

strict

(experimental) Do not construct stacks with warnings.

Default:

false

Stability:

experimental

trace

(experimental) Print trace for stack warnings.

Default:

false

Stability:

experimental

verbose

(experimental) show debug logs.

Default:

false

Stability:

experimental

version_reporting

(experimental) Include “AWS::CDK::Metadata” resource in synthesized templates.

Default:

true

Stability:

experimental