Package software.amazon.awscdk

Class StageProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.StageProps.Jsii$Proxy
All Implemented Interfaces:
StageProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
StageProps
@Stability(Stable) @Internal public static final class StageProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements StageProps
An implementation for StageProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(StageProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the StageProps.Builder.

  • Method Details

    • getEnv

      public final Environment getEnv()
      Description copied from interface: StageProps
      Default AWS environment (account/region) for Stacks in this Stage.

      Stacks defined inside this Stage with either region or account missing from its env will use the corresponding field given here.

      If either region or accountis is not configured for Stack (either on the Stack itself or on the containing Stage), the Stack will be environment-agnostic.

      Environment-agnostic stacks can be deployed to any environment, may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups, will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

      Default: - The environments should be configured on the `Stack`s.

      Example: 

       // Use a concrete account and region to deploy this Stage to
 // Use a concrete account and region to deploy this Stage to
 Stage.Builder.create(app, "Stage1")
         .env(Environment.builder().account("123456789012").region("us-east-1").build())
         .build();
 // Use the CLI's current credentials to determine the target environment
 // Use the CLI's current credentials to determine the target environment
 Stage.Builder.create(app, "Stage2")
         .env(Environment.builder().account(process.getEnv().getCDK_DEFAULT_ACCOUNT()).region(process.getEnv().getCDK_DEFAULT_REGION()).build())
         .build();
      Specified by:
      getEnv in interface StageProps

    • getOutdir

      public final String getOutdir()
      Description copied from interface: StageProps
      The output directory into which to emit synthesized artifacts.

      Can only be specified if this stage is the root stage (the app). If this is specified and this stage is nested within another stage, an error will be thrown.

      Default: - for nested stages, outdir will be determined as a relative directory to the outdir of the app. For apps, if outdir is not specified, a temporary directory will be created.

      Specified by:
      getOutdir in interface StageProps

    • getPermissionsBoundary

      public final PermissionsBoundary getPermissionsBoundary()
      Description copied from interface: StageProps
      Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.

      Default: - no permissions boundary is applied

      Specified by:
      getPermissionsBoundary in interface StageProps

    • getPolicyValidationBeta1

      public final List<IPolicyValidationPluginBeta1> getPolicyValidationBeta1()
      Description copied from interface: StageProps
      Validation plugins to run during synthesis.

      If any plugin reports any violation, synthesis will be interrupted and the report displayed to the user.

      Default: - no validation plugins are used

      Specified by:
      getPolicyValidationBeta1 in interface StageProps

    • getStageName

      public final String getStageName()
      Description copied from interface: StageProps
      Name of this stage.

      Default: - Derived from the id.

      Specified by:
      getStageName in interface StageProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object