Package software.amazon.awscdk.core

Interface AppProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AppProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:54.782Z") @Stability(Stable) public interface AppProps extends software.amazon.jsii.JsiiSerializable
Initialization props for apps.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 Object context;
 AppProps appProps = AppProps.builder()
         .analyticsReporting(false)
         .autoSynth(false)
         .context(Map.of(
                 "contextKey", context))
         .outdir("outdir")
         .runtimeInfo(false)
         .stackTraces(false)
         .treeMetadata(false)
         .build();

  • Method Details

    • getAnalyticsReporting

      @Stability(Stable) @Nullable default Boolean getAnalyticsReporting()
      Include runtime versioning information in the Stacks of this app.

      Default: Value of 'aws:cdk:version-reporting' context key

    • getAutoSynth

      @Stability(Stable) @Nullable default Boolean getAutoSynth()
      Automatically call synth() before the program exits.

      If you set this, you don't have to call synth() explicitly. Note that this feature is only available for certain programming languages, and calling synth() is still recommended.

      Default: true if running via CDK CLI (`CDK_OUTDIR` is set), `false` otherwise

    • getContext

      @Stability(Stable) @Nullable default Map<String,Object> getContext()
      Additional context values for the application.

      Context set by the CLI or the context key in cdk.json has precedence.

      Context can be read from any construct using node.getContext(key).

      Default: - no additional context

    • getOutdir

      @Stability(Stable) @Nullable default String getOutdir()
      The output directory into which to emit synthesized artifacts.

      You should never need to set this value. By default, the value you pass to the CLI's --output flag will be used, and if you change it to a different directory the CLI will fail to pick up the generated Cloud Assembly.

      This property is intended for internal and testing use.

      Default: - If this value is _not_ set, considers the environment variable `CDK_OUTDIR`. If `CDK_OUTDIR` is not defined, uses a temp directory.

    • getRuntimeInfo

      @Stability(Deprecated) @Deprecated @Nullable default Boolean getRuntimeInfo()
      Deprecated.
      use versionReporting instead
      (deprecated) Include runtime versioning information in the Stacks of this app.

      Default: Value of 'aws:cdk:version-reporting' context key

    • getStackTraces

      @Stability(Stable) @Nullable default Boolean getStackTraces()
      Include construct creation stack trace in the aws:cdk:trace metadata key of all constructs.

      Default: true stack traces are included unless `aws:cdk:disable-stack-trace` is set in the context.

    • getTreeMetadata

      @Stability(Stable) @Nullable default Boolean getTreeMetadata()
      Include construct tree metadata as part of the Cloud Assembly.

      Default: true

    • builder

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