Package software.amazon.awscdk.cloud_assembly_schema

Interface DefaultCdkOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
DeployOptions, DestroyOptions
All Known Implementing Classes:
DefaultCdkOptions.Jsii$Proxy, DeployOptions.Jsii$Proxy, DestroyOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:10.989Z") @Stability(Stable) public interface DefaultCdkOptions extends software.amazon.jsii.JsiiSerializable
Default 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 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();

  • Method Details

    • getAll

      @Stability(Stable) @Nullable default Boolean getAll()
      Deploy all stacks.

      Requried if stacks is not set

      Default: - false

    • getApp

      @Stability(Stable) @Nullable default String getApp()
      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

    • getAssetMetadata

      @Stability(Stable) @Nullable default Boolean getAssetMetadata()
      Include "aws:asset:*" CloudFormation metadata for resources that use assets.

      Default: true

    • getCaBundlePath

      @Stability(Stable) @Nullable default String getCaBundlePath()
      Path to CA certificate to use when validating HTTPS requests.

      Default: - read from AWS_CA_BUNDLE environment variable

    • getColor

      @Stability(Stable) @Nullable default Boolean getColor()
      Show colors and other style from console output.

      Default: true

    • getContext

      @Stability(Stable) @Nullable default Map<String,String> getContext()
      Additional context.

      Default: - no additional context

    • getDebug

      @Stability(Stable) @Nullable default Boolean getDebug()
      enable emission of additional debugging information, such as creation stack traces of tokens.

      Default: false

    • getEc2Creds

      @Stability(Stable) @Nullable default Boolean getEc2Creds()
      Force trying to fetch EC2 instance credentials.

      Default: - guess EC2 instance status

    • getIgnoreErrors

      @Stability(Stable) @Nullable default Boolean getIgnoreErrors()
      Ignores synthesis errors, which will likely produce an invalid output.

      Default: false

    • getJson

      @Stability(Stable) @Nullable default Boolean getJson()
      Use JSON output instead of YAML when templates are printed to STDOUT.

      Default: false

    • getLookups

      @Stability(Stable) @Nullable default Boolean getLookups()
      Perform context lookups.

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

      Default: true

    • getNotices

      @Stability(Stable) @Nullable default Boolean getNotices()
      Show relevant notices.

      Default: true

    • getOutput

      @Stability(Stable) @Nullable default String getOutput()
      Emits the synthesized cloud assembly into a directory.

      Default: cdk.out

    • getPathMetadata

      @Stability(Stable) @Nullable default Boolean getPathMetadata()
      Include "aws:cdk:path" CloudFormation metadata for each resource.

      Default: true

    • getProfile

      @Stability(Stable) @Nullable default String getProfile()
      Use the indicated AWS profile as the default environment.

      Default: - no profile is used

    • getProxy

      @Stability(Stable) @Nullable default String getProxy()
      Use the indicated proxy.

      Will read from HTTPS_PROXY environment if specified

      Default: - no proxy

    • getRoleArn

      @Stability(Stable) @Nullable default String getRoleArn()
      Role to pass to CloudFormation for deployment.

      Default: - use the bootstrap cfn-exec role

    • getStacks

      @Stability(Stable) @Nullable default List<String> getStacks()
      List of stacks to deploy.

      Requried if all is not set

      Default: - []

    • getStaging

      @Stability(Stable) @Nullable default Boolean getStaging()
      Copy assets to the output directory.

      Needed for local debugging the source files with SAM CLI

      Default: false

    • getStrict

      @Stability(Stable) @Nullable default Boolean getStrict()
      Do not construct stacks with warnings.

      Default: false

    • getTrace

      @Stability(Stable) @Nullable default Boolean getTrace()
      Print trace for stack warnings.

      Default: false

    • getVerbose

      @Stability(Stable) @Nullable default Boolean getVerbose()
      show debug logs.

      Default: false

    • getVersionReporting

      @Stability(Stable) @Nullable default Boolean getVersionReporting()
      Include "AWS::CDK::Metadata" resource in synthesized templates.

      Default: true

    • builder

      @Stability(Stable) static DefaultCdkOptions.Builder builder()
      Returns:
      a DefaultCdkOptions.Builder of DefaultCdkOptions