aws-cdk-lib.cloud_assembly_schema.DefaultCdkOptions

DefaultCdkOptions Struct

Default CDK CLI options that apply to all commands.

Source

node_modules/@aws-cdk/cloud-assembly-schema/lib/integ-tests/commands/common.d.ts

Type last changed

v2.20.0 · 7 Apr 2022

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';
const defaultCdkOptions: cloud_assembly_schema.DefaultCdkOptions = {
  all: false,
  app: 'app',
  assetMetadata: false,
  caBundlePath: 'caBundlePath',
  color: false,
  context: {
    contextKey: 'context',
  },
  debug: false,
  ec2Creds: false,
  ignoreErrors: false,
  json: false,
  lookups: false,
  notices: false,
  output: 'output',
  pathMetadata: false,
  profile: 'profile',
  proxy: 'proxy',
  roleArn: 'roleArn',
  stacks: ['stacks'],
  staging: false,
  strict: false,
  trace: false,
  verbose: false,
  versionReporting: false,
};

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

default_cdk_options = 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
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cloud_assembly_schema.*;

DefaultCdkOptions defaultCdkOptions = DefaultCdkOptions.builder()
        .all(false)
        .app("app")
        .assetMetadata(false)
        .caBundlePath("caBundlePath")
        .color(false)
        .context(Map.of(
                "contextKey", "context"))
        .debug(false)
        .ec2Creds(false)
        .ignoreErrors(false)
        .json(false)
        .lookups(false)
        .notices(false)
        .output("output")
        .pathMetadata(false)
        .profile("profile")
        .proxy("proxy")
        .roleArn("roleArn")
        .stacks(List.of("stacks"))
        .staging(false)
        .strict(false)
        .trace(false)
        .verbose(false)
        .versionReporting(false)
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Cloud_assembly_schema;

var defaultCdkOptions = new DefaultCdkOptions {
    All = false,
    App = "app",
    AssetMetadata = false,
    CaBundlePath = "caBundlePath",
    Color = false,
    Context = new Dictionary<string, string> {
        { "contextKey", "context" }
    },
    Debug = false,
    Ec2Creds = false,
    IgnoreErrors = false,
    Json = false,
    Lookups = false,
    Notices = false,
    Output = "output",
    PathMetadata = false,
    Profile = "profile",
    Proxy = "proxy",
    RoleArn = "roleArn",
    Stacks = new [] { "stacks" },
    Staging = false,
    Strict = false,
    Trace = false,
    Verbose = false,
    VersionReporting = false
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

defaultCdkOptions := &DefaultCdkOptions{
	All: jsii.Boolean(false),
	App: jsii.String("app"),
	AssetMetadata: jsii.Boolean(false),
	CaBundlePath: jsii.String("caBundlePath"),
	Color: jsii.Boolean(false),
	Context: map[string]*string{
		"contextKey": jsii.String("context"),
	},
	Debug: jsii.Boolean(false),
	Ec2Creds: jsii.Boolean(false),
	IgnoreErrors: jsii.Boolean(false),
	Json: jsii.Boolean(false),
	Lookups: jsii.Boolean(false),
	Notices: jsii.Boolean(false),
	Output: jsii.String("output"),
	PathMetadata: jsii.Boolean(false),
	Profile: jsii.String("profile"),
	Proxy: jsii.String("proxy"),
	RoleArn: jsii.String("roleArn"),
	Stacks: []*string{
		jsii.String("stacks"),
	},
	Staging: jsii.Boolean(false),
	Strict: jsii.Boolean(false),
	Trace: jsii.Boolean(false),
	Verbose: jsii.Boolean(false),
	VersionReporting: jsii.Boolean(false),
}

Properties

all?optionalbooleanall?optionalboolall?optionalBooleanAll?optionalboolAll?optional*bool= false#

Deploy all stacks.

Requried if stacks is not set

app?optionalstringapp?optionalstrapp?optionalStringApp?optionalstringApp?optional*string#

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

assetMetadata?optionalbooleanasset_metadata?optionalboolassetMetadata?optionalBooleanAssetMetadata?optionalboolAssetMetadata?optional*bool= true#

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

caBundlePath?optionalstringca_bundle_path?optionalstrcaBundlePath?optionalStringCaBundlePath?optionalstringCaBundlePath?optional*string#

Path to CA certificate to use when validating HTTPS requests.

Default: read from AWS_CA_BUNDLE environment variable

color?optionalbooleancolor?optionalboolcolor?optionalBooleanColor?optionalboolColor?optional*bool= true#

Show colors and other style from console output.

context?optional{ [key: string]: string }context?optionaltyping.Mapping[str, str]context?optionalMap<String, String>Context?optionalIDictionary<string, string>Context?optional*map[string]*string#

Additional context.

Default: no additional context

debug?optionalbooleandebug?optionalbooldebug?optionalBooleanDebug?optionalboolDebug?optional*bool= false#

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

ec2Creds?optionalbooleanec2_creds?optionalboolec2Creds?optionalBooleanEc2Creds?optionalboolEc2Creds?optional*bool#

Force trying to fetch EC2 instance credentials.

Default: guess EC2 instance status

ignoreErrors?optionalbooleanignore_errors?optionalboolignoreErrors?optionalBooleanIgnoreErrors?optionalboolIgnoreErrors?optional*bool= false#

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

json?optionalbooleanjson?optionalbooljson?optionalBooleanJson?optionalboolJson?optional*bool= false#

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

lookups?optionalbooleanlookups?optionalboollookups?optionalBooleanLookups?optionalboolLookups?optional*bool= true#

Perform context lookups.

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

notices?optionalbooleannotices?optionalboolnotices?optionalBooleanNotices?optionalboolNotices?optional*bool= true#

Show relevant notices.

output?optionalstringoutput?optionalstroutput?optionalStringOutput?optionalstringOutput?optional*string= cdk.out#

Emits the synthesized cloud assembly into a directory.

pathMetadata?optionalbooleanpath_metadata?optionalboolpathMetadata?optionalBooleanPathMetadata?optionalboolPathMetadata?optional*bool= true#

Include "aws:cdk:path" CloudFormation metadata for each resource.

profile?optionalstringprofile?optionalstrprofile?optionalStringProfile?optionalstringProfile?optional*string#

Use the indicated AWS profile as the default environment.

Default: no profile is used

proxy?optionalstringproxy?optionalstrproxy?optionalStringProxy?optionalstringProxy?optional*string#

Use the indicated proxy.

Default: no proxy

Will read from HTTPS_PROXY environment if specified

roleArn?optionalstringrole_arn?optionalstrroleArn?optionalStringRoleArn?optionalstringRoleArn?optional*string#

Role to pass to CloudFormation for deployment.

Default: use the bootstrap cfn-exec role

stacks?optionalstring[]stacks?optionaltyping.List[str]stacks?optionalList<String>Stacks?optionalstring[]Stacks?optional*[]*string= []#

List of stacks to deploy.

Requried if all is not set

staging?optionalbooleanstaging?optionalboolstaging?optionalBooleanStaging?optionalboolStaging?optional*bool= false#

Copy assets to the output directory.

Needed for local debugging the source files with SAM CLI

strict?optionalbooleanstrict?optionalboolstrict?optionalBooleanStrict?optionalboolStrict?optional*bool= false#

Do not construct stacks with warnings.

trace?optionalbooleantrace?optionalbooltrace?optionalBooleanTrace?optionalboolTrace?optional*bool= false#

Print trace for stack warnings.

verbose?optionalbooleanverbose?optionalboolverbose?optionalBooleanVerbose?optionalboolVerbose?optional*bool= false#

show debug logs.

versionReporting?optionalbooleanversion_reporting?optionalboolversionReporting?optionalBooleanVersionReporting?optionalboolVersionReporting?optional*bool= true#

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