Package software.amazon.awscdk

Class StackProps.Jsii$Proxy

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

  • 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(StackProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the StackProps.Builder.

  • Method Details

    • getAnalyticsReporting

      public final Boolean getAnalyticsReporting()
      Description copied from interface: StackProps
      Include runtime versioning information in this Stack.

      Default: `analyticsReporting` setting of containing `App`, or value of 'aws:cdk:version-reporting' context key

      Specified by:
      getAnalyticsReporting in interface StackProps

    • getCrossRegionReferences

      public final Boolean getCrossRegionReferences()
      Description copied from interface: StackProps
      Enable this flag to allow native cross region stack references.

      Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

      This feature is currently experimental

      Default: false

      Specified by:
      getCrossRegionReferences in interface StackProps

    • getDescription

      public final String getDescription()
      Description copied from interface: StackProps
      A description of the stack.

      Default: - No description.

      Specified by:
      getDescription in interface StackProps

    • getEnv

      public final Environment getEnv()
      Description copied from interface: StackProps
      The AWS environment (account/region) where this stack will be deployed.

      Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).

      If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

      If either region or account are not set nor inherited from Stage, the Stack will be considered "environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but 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 such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

      Default: - The environment of the containing `Stage` if available, otherwise create the stack will be environment-agnostic.

      Example: 

       // Use a concrete account and region to deploy this stack to:
 // `.account` and `.region` will simply return these values.
 // Use a concrete account and region to deploy this stack to:
 // `.account` and `.region` will simply return these values.
 Stack.Builder.create(app, "Stack1")
         .env(Environment.builder()
                 .account("123456789012")
                 .region("us-east-1")
                 .build())
         .build();
 // Use the CLI's current credentials to determine the target environment:
 // `.account` and `.region` will reflect the account+region the CLI
 // is configured to use (based on the user CLI credentials)
 // Use the CLI's current credentials to determine the target environment:
 // `.account` and `.region` will reflect the account+region the CLI
 // is configured to use (based on the user CLI credentials)
 Stack.Builder.create(app, "Stack2")
         .env(Environment.builder()
                 .account(process.getEnv().getCDK_DEFAULT_ACCOUNT())
                 .region(process.getEnv().getCDK_DEFAULT_REGION())
                 .build())
         .build();
 // Define multiple stacks stage associated with an environment
 Stage myStage = Stage.Builder.create(app, "MyStage")
         .env(Environment.builder()
                 .account("123456789012")
                 .region("us-east-1")
                 .build())
         .build();
 // both of these stacks will use the stage's account/region:
 // `.account` and `.region` will resolve to the concrete values as above
 // both of these stacks will use the stage's account/region:
 // `.account` and `.region` will resolve to the concrete values as above
 new MyStack(myStage, "Stack1");
 new YourStack(myStage, "Stack2");
 // Define an environment-agnostic stack:
 // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
 // which will only resolve to actual values by CloudFormation during deployment.
 // Define an environment-agnostic stack:
 // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
 // which will only resolve to actual values by CloudFormation during deployment.
 new MyStack(app, "Stack1");
      Specified by:
      getEnv in interface StackProps

    • getNotificationArns

      public final List<String> getNotificationArns()
      Description copied from interface: StackProps
      SNS Topic ARNs that will receive stack events.

      Default: - no notfication arns.

      Specified by:
      getNotificationArns in interface StackProps

    • getPermissionsBoundary

      public final PermissionsBoundary getPermissionsBoundary()
      Description copied from interface: StackProps
      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 StackProps

    • getStackName

      public final String getStackName()
      Description copied from interface: StackProps
      Name to deploy the stack with.

      Default: - Derived from construct path.

      Specified by:
      getStackName in interface StackProps

    • getSuppressTemplateIndentation

      public final Boolean getSuppressTemplateIndentation()
      Description copied from interface: StackProps
      Enable this flag to suppress indentation in generated CloudFormation templates.

      If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

      Default: - the value of `@aws-cdk/core:suppressTemplateIndentation`, or `false` if that is not set.

      Specified by:
      getSuppressTemplateIndentation in interface StackProps

    • getSynthesizer

      public final IStackSynthesizer getSynthesizer()
      Description copied from interface: StackProps
      Synthesis method to use while deploying this stack.

      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.

      If not specified, the defaultStackSynthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

      Default: - The synthesizer specified on `App`, or `DefaultStackSynthesizer` otherwise.

      Specified by:
      getSynthesizer in interface StackProps

    • getTags

      public final Map<String,String> getTags()
      Description copied from interface: StackProps
      Stack tags that will be applied to all the taggable resources and the stack itself.

      Default: {}

      Specified by:
      getTags in interface StackProps

    • getTerminationProtection

      public final Boolean getTerminationProtection()
      Description copied from interface: StackProps
      Whether to enable termination protection for this stack.

      Default: false

      Specified by:
      getTerminationProtection in interface StackProps

    • $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