1.204.0

interface IntegTestCaseStackProps 🔹

LanguageType name
.NETAmazon.CDK.IntegTests.IntegTestCaseStackProps
Javasoftware.amazon.awscdk.integtests.IntegTestCaseStackProps
Pythonaws_cdk.integ_tests.IntegTestCaseStackProps
TypeScript (source)@aws-cdk/integ-tests » IntegTestCaseStackProps

Properties of an integration test case stack.

Example

declare const app: App;
declare const stackUnderTest: Stack;
const testCaseWithAssets = new IntegTestCaseStack(app, 'TestCaseAssets', {
  diffAssets: true,
});

new IntegTest(app, 'Integ', { testCases: [stackUnderTest, testCaseWithAssets] });

Properties

NameTypeDescription
allowDestroy?🔹string[]List of CloudFormation resource types in this stack that can be destroyed as part of an update without failing the test.
analyticsReporting?🔹booleanInclude runtime versioning information in this Stack.
cdkCommandOptions?🔹CdkCommandsAdditional options to use for each CDK command.
description?🔹stringA description of the stack.
diffAssets?🔹booleanWhether 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.
env?🔹EnvironmentThe AWS environment (account/region) where this stack will be deployed.
hooks?🔹HooksAdditional commands to run at predefined points in the test workflow.
regions?🔹string[]Limit deployment to these regions.
stackName?🔹stringName to deploy the stack with.
stackUpdateWorkflow?🔹booleanRun 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.
synthesizer?🔹IStackSynthesizerSynthesis method to use while deploying this stack.
tags?🔹{ [string]: string }Stack tags that will be applied to all the taggable resources and the stack itself.
terminationProtection?🔹booleanWhether to enable termination protection for this stack.

allowDestroy?🔹

Type: string[] (optional, default: do not allow destruction of any resources on update)

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']

analyticsReporting?🔹

Type: boolean (optional, default: analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key)

Include runtime versioning information in this Stack.

cdkCommandOptions?🔹

Type: CdkCommands (optional, default: runner default options)

Additional options to use for each CDK command.

description?🔹

Type: string (optional, default: No description.)

A description of the stack.

diffAssets?🔹

Type: boolean (optional, default: false)

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

env?🔹

Type: Environment (optional, default: The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.)

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. Example

// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  },
});

// 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)
new Stack(app, 'Stack2', {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT,
    region: process.env.CDK_DEFAULT_REGION
  },
});

// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  }
});

// 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.
new MyStack(app, 'Stack1');

hooks?🔹

Type: Hooks (optional, default: no hooks)

Additional commands to run at predefined points in the test workflow.

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

regions?🔹

Type: string[] (optional, default: can run in any region)

Limit deployment to these regions.

stackName?🔹

Type: string (optional, default: Derived from construct path.)

Name to deploy the stack with.

stackUpdateWorkflow?🔹

Type: boolean (optional, default: true)

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.

synthesizer?🔹

Type: IStackSynthesizer (optional, default: DefaultStackSynthesizer if the @aws-cdk/core:newStyleStackSynthesis feature flag is set, LegacyStackSynthesizer otherwise.)

Synthesis method to use while deploying this stack.

tags?🔹

Type: { [string]: string } (optional, default: {})

Stack tags that will be applied to all the taggable resources and the stack itself.

terminationProtection?🔹

Type: boolean (optional, default: false)

Whether to enable termination protection for this stack.

← PreviousNext →