Package software.amazon.awscdk.integtests

Class IntegTestCaseStackProps.Jsii$Proxy

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

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

  • Method Details

    • getAllowDestroy

      public final List<String> getAllowDestroy()
      Description copied from interface: TestOptions
      List of CloudFormation resource types in this stack that can be destroyed as part of an update without failing the test.

      This list should only include resources that for this specific integration test we are sure will not cause errors or an outage if destroyed. For example, maybe we know that a new resource will be created first before the old resource is destroyed which prevents any outage.

      e.g. ['AWS::IAM::Role']

      Default: - do not allow destruction of any resources on update

      Specified by:
      getAllowDestroy in interface TestOptions

    • getCdkCommandOptions

      public final CdkCommands getCdkCommandOptions()
      Description copied from interface: TestOptions
      Additional options to use for each CDK command.

      Default: - runner default options

      Specified by:
      getCdkCommandOptions in interface TestOptions

    • getDiffAssets

      public final Boolean getDiffAssets()
      Description copied from interface: TestOptions
      Whether or not to include asset hashes in the diff Asset hashes can introduces a lot of unneccessary noise into tests, but there are some cases where asset hashes should be included.

      For example any tests involving custom resources or bundling

      Default: false

      Specified by:
      getDiffAssets in interface TestOptions

    • getHooks

      public final Hooks getHooks()
      Description copied from interface: TestOptions
      Additional commands to run at predefined points in the test workflow.

      e.g. { postDeploy: ['yarn', 'test'] }

      Default: - no hooks

      Specified by:
      getHooks in interface TestOptions

    • getRegions

      public final List<String> getRegions()
      Description copied from interface: TestOptions
      Limit deployment to these regions.

      Default: - can run in any region

      Specified by:
      getRegions in interface TestOptions

    • getStackUpdateWorkflow

      public final Boolean getStackUpdateWorkflow()
      Description copied from interface: TestOptions
      Run update workflow on this test case This should only be set to false to test scenarios that are not possible to test as part of the update workflow.

      Default: true

      Specified by:
      getStackUpdateWorkflow in interface TestOptions

    • 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

    • 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

    • 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

    • getSynthesizer

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

      Default: - `DefaultStackSynthesizer` if the `@aws-cdk/core:newStyleStackSynthesis` feature flag is set, `LegacyStackSynthesizer` 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