DefaultCdkOptions

class aws_cdk.cloud_assembly_schema.DefaultCdkOptions(*, all=None, app=None, 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, output=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

Default CDK CLI options that apply to all commands.

Parameters:

all (Optional[bool]) – Deploy all stacks. Requried if stacks is not set Default: - false
app (Optional[str]) – command-line for executing your app or a cloud assembly directory e.g. “node bin/my-app.js” or “cdk.out”. Default: - read from cdk.json
asset_metadata (Optional[bool]) – Include “aws:asset:*” CloudFormation metadata for resources that use assets. Default: true
ca_bundle_path (Optional[str]) – Path to CA certificate to use when validating HTTPS requests. Default: - read from AWS_CA_BUNDLE environment variable
color (Optional[bool]) – Show colors and other style from console output. Default: true
context (Optional[Mapping[str, str]]) – Additional context. Default: - no additional context
debug (Optional[bool]) – enable emission of additional debugging information, such as creation stack traces of tokens. Default: false
ec2_creds (Optional[bool]) – Force trying to fetch EC2 instance credentials. Default: - guess EC2 instance status
ignore_errors (Optional[bool]) – Ignores synthesis errors, which will likely produce an invalid output. Default: false
json (Optional[bool]) – Use JSON output instead of YAML when templates are printed to STDOUT. Default: false
lookups (Optional[bool]) – Perform context lookups. Synthesis fails if this is disabled and context lookups need to be performed Default: true
notices (Optional[bool]) – Show relevant notices. Default: true
output (Optional[str]) – Emits the synthesized cloud assembly into a directory. Default: cdk.out
path_metadata (Optional[bool]) – Include “aws:cdk:path” CloudFormation metadata for each resource. Default: true
profile (Optional[str]) – Use the indicated AWS profile as the default environment. Default: - no profile is used
proxy (Optional[str]) – Use the indicated proxy. Will read from HTTPS_PROXY environment if specified Default: - no proxy
role_arn (Optional[str]) – Role to pass to CloudFormation for deployment. Default: - use the bootstrap cfn-exec role
stacks (Optional[Sequence[str]]) – List of stacks to deploy. Requried if all is not set Default: - []
staging (Optional[bool]) – Copy assets to the output directory. Needed for local debugging the source files with SAM CLI Default: false
strict (Optional[bool]) – Do not construct stacks with warnings. Default: false
trace (Optional[bool]) – Print trace for stack warnings. Default: false
verbose (Optional[bool]) – show debug logs. Default: false
version_reporting (Optional[bool]) – Include “AWS::CDK::Metadata” resource in synthesized templates. Default: true

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.cloud_assembly_schema as cloud_assembly_schema

default_cdk_options = cloud_assembly_schema.DefaultCdkOptions(
    all=False,
    app="app",
    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,
    output="output",
    path_metadata=False,
    profile="profile",
    proxy="proxy",
    role_arn="roleArn",
    stacks=["stacks"],
    staging=False,
    strict=False,
    trace=False,
    verbose=False,
    version_reporting=False
)

Attributes

all

Deploy all stacks.

Requried if stacks is not set

Default:

false

app

command-line for executing your app or a cloud assembly directory e.g. “node bin/my-app.js” or “cdk.out”.

Default:

read from cdk.json

asset_metadata

*” CloudFormation metadata for resources that use assets.

Default:: true
Type:: Include “aws
Type:: asset

ca_bundle_path

Path to CA certificate to use when validating HTTPS requests.

Default:

read from AWS_CA_BUNDLE environment variable

color

Show colors and other style from console output.

Default:: true

context

Additional context.

Default:

no additional context

debug

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

Default:: false

ec2_creds

Force trying to fetch EC2 instance credentials.

Default:

guess EC2 instance status

ignore_errors

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

Default:: false

json

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

Default:: false

lookups

Perform context lookups.

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

Default:: true

notices

Show relevant notices.

Default:: true

output

Emits the synthesized cloud assembly into a directory.

Default:: cdk.out

path_metadata

path” CloudFormation metadata for each resource.

Default:: true
Type:: Include “aws
Type:: cdk

profile

Use the indicated AWS profile as the default environment.

Default:

no profile is used

proxy

Use the indicated proxy.

Will read from HTTPS_PROXY environment if specified

Default:

no proxy

role_arn

Role to pass to CloudFormation for deployment.

Default:

use the bootstrap cfn-exec role

stacks

List of stacks to deploy.

Requried if all is not set

Default:

[]

staging

Copy assets to the output directory.

Needed for local debugging the source files with SAM CLI

Default:: false

strict

Do not construct stacks with warnings.

Default:: false

trace

Print trace for stack warnings.

Default:: false

verbose

show debug logs.

Default:: false

version_reporting

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

Default:: true