Package software.amazon.awscdk

Class App.Builder

java.lang.Object
software.amazon.awscdk.App.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<App>
Enclosing class:
App
@Stability(Stable) public static final class App.Builder extends Object implements software.amazon.jsii.Builder<App>
A fluent builder for App.

  • Method Details

    • create

      @Stability(Stable) public static App.Builder create()
      Returns:
      a new instance of App.Builder.

    • analyticsReporting

      @Stability(Stable) public App.Builder analyticsReporting(Boolean analyticsReporting)
      Include runtime versioning information in the Stacks of this app.

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

      Parameters:
      analyticsReporting - Include runtime versioning information in the Stacks of this app. This parameter is required.
      Returns:
      this

    • autoSynth

      @Stability(Stable) public App.Builder autoSynth(Boolean autoSynth)
      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

      Parameters:
      autoSynth - Automatically call synth() before the program exits. This parameter is required.
      Returns:
      this

    • context

      @Stability(Stable) public App.Builder context(Map<String,? extends Object> context)
      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

      Parameters:
      context - Additional context values for the application. This parameter is required.
      Returns:
      this

    • defaultStackSynthesizer

      @Stability(Stable) public App.Builder defaultStackSynthesizer(IReusableStackSynthesizer defaultStackSynthesizer)
      The stack synthesizer to use by default for all Stacks in the App.

      The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

      Default: - A `DefaultStackSynthesizer` with default settings

      Parameters:
      defaultStackSynthesizer - The stack synthesizer to use by default for all Stacks in the App. This parameter is required.
      Returns:
      this

    • outdir

      @Stability(Stable) public App.Builder outdir(String outdir)
      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.

      Parameters:
      outdir - The output directory into which to emit synthesized artifacts. This parameter is required.
      Returns:
      this

    • policyValidationBeta1

      @Stability(Stable) public App.Builder policyValidationBeta1(List<? extends IPolicyValidationPluginBeta1> policyValidationBeta1)
      Validation plugins to run after synthesis.

      Default: - no validation plugins

      Parameters:
      policyValidationBeta1 - Validation plugins to run after synthesis. This parameter is required.
      Returns:
      this

    • postCliContext

      @Stability(Stable) public App.Builder postCliContext(Map<String,? extends Object> postCliContext)
      Additional context values for the application.

      Context provided here has precedence over context set by:

      • The CLI via --context
      • The context key in cdk.json
      • The AppProps.context property

      This property is recommended over the AppProps.context property since you can make final decision over which context value to take in your app.

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

      Default: - no additional context

      Example: 

       // context from the CLI and from `cdk.json` are stored in the
 // CDK_CONTEXT env variable
 Object cliContext = JSON.parse(process.getEnv().getCDK_CONTEXT());
 // determine whether to take the context passed in the CLI or not
 Object determineValue = process.env.PROD ? cliContext.SOMEKEY : 'my-prod-value';
 App.Builder.create()
         .postCliContext(Map.of(
                 "SOMEKEY", determineValue))
         .build();

      Parameters:
      postCliContext - Additional context values for the application. This parameter is required.
      Returns:
      this

    • stackTraces

      @Stability(Stable) public App.Builder stackTraces(Boolean stackTraces)
      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.

      Parameters:
      stackTraces - Include construct creation stack trace in the aws:cdk:trace metadata key of all constructs. This parameter is required.
      Returns:
      this

    • treeMetadata

      @Stability(Stable) public App.Builder treeMetadata(Boolean treeMetadata)
      Include construct tree metadata as part of the Cloud Assembly.

      Default: true

      Parameters:
      treeMetadata - Include construct tree metadata as part of the Cloud Assembly. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public App build()
      Specified by:
      build in interface software.amazon.jsii.Builder<App>
      Returns:
      a newly built instance of App.