software.amazon.awscdk.integtests

Class IntegTestCaseStack.Builder

java.lang.Object

software.amazon.awscdk.integtests.IntegTestCaseStack.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<IntegTestCaseStack>

Enclosing class:

IntegTestCaseStack

@Stability(value=Experimental)
public static final class IntegTestCaseStack.Builder
extends Object
implements software.amazon.jsii.Builder<IntegTestCaseStack>

(experimental) A fluent builder for IntegTestCaseStack.

Method Summary

Modifier and Type	Method and Description
IntegTestCaseStack.Builder	allowDestroy(List<String> allowDestroy) (experimental) List of CloudFormation resource types in this stack that can be destroyed as part of an update without failing the test.
IntegTestCaseStack.Builder	analyticsReporting(Boolean analyticsReporting) (experimental) Include runtime versioning information in this Stack.
IntegTestCaseStack	build()
IntegTestCaseStack.Builder	cdkCommandOptions(CdkCommands cdkCommandOptions) (experimental) Additional options to use for each CDK command.
static IntegTestCaseStack.Builder	create(software.constructs.Construct scope, String id)
IntegTestCaseStack.Builder	description(String description) (experimental) A description of the stack.
IntegTestCaseStack.Builder	diffAssets(Boolean diffAssets) (experimental) 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.
IntegTestCaseStack.Builder	env(Environment env) (experimental) The AWS environment (account/region) where this stack will be deployed.
IntegTestCaseStack.Builder	hooks(Hooks hooks) (experimental) Additional commands to run at predefined points in the test workflow.
IntegTestCaseStack.Builder	regions(List<String> regions) (experimental) Limit deployment to these regions.
IntegTestCaseStack.Builder	stackName(String stackName) (experimental) Name to deploy the stack with.
IntegTestCaseStack.Builder	stackUpdateWorkflow(Boolean stackUpdateWorkflow) (experimental) 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.
IntegTestCaseStack.Builder	synthesizer(IStackSynthesizer synthesizer) (experimental) Synthesis method to use while deploying this stack.
IntegTestCaseStack.Builder	tags(Map<String,String> tags) (experimental) Stack tags that will be applied to all the taggable resources and the stack itself.
IntegTestCaseStack.Builder	terminationProtection(Boolean terminationProtection) (experimental) Whether to enable termination protection for this stack.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static IntegTestCaseStack.Builder create(software.constructs.Construct scope,
                                                                               String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of IntegTestCaseStack.Builder.

allowDestroy

@Stability(value=Experimental)
public IntegTestCaseStack.Builder allowDestroy(List<String> allowDestroy)

(experimental) 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

Parameters:

allowDestroy - List of CloudFormation resource types in this stack that can be destroyed as part of an update without failing the test. This parameter is required.

Returns:

this

cdkCommandOptions

@Stability(value=Experimental)
public IntegTestCaseStack.Builder cdkCommandOptions(CdkCommands cdkCommandOptions)

(experimental) Additional options to use for each CDK command.

Default: - runner default options

Parameters:

cdkCommandOptions - Additional options to use for each CDK command. This parameter is required.

Returns:

this

diffAssets

@Stability(value=Experimental)
public IntegTestCaseStack.Builder diffAssets(Boolean diffAssets)

(experimental) 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

Parameters:

diffAssets - 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. This parameter is required.

Returns:

this

hooks

@Stability(value=Experimental)
public IntegTestCaseStack.Builder hooks(Hooks hooks)

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

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

Default: - no hooks

Parameters:

hooks - Additional commands to run at predefined points in the test workflow. This parameter is required.

Returns:

this

regions

@Stability(value=Experimental)
public IntegTestCaseStack.Builder regions(List<String> regions)

(experimental) Limit deployment to these regions.

Default: - can run in any region

Parameters:

regions - Limit deployment to these regions. This parameter is required.

Returns:

this

stackUpdateWorkflow

@Stability(value=Experimental)
public IntegTestCaseStack.Builder stackUpdateWorkflow(Boolean stackUpdateWorkflow)

(experimental) 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

Parameters:

stackUpdateWorkflow - 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. This parameter is required.

Returns:

this

analyticsReporting

@Stability(value=Experimental)
public IntegTestCaseStack.Builder analyticsReporting(Boolean analyticsReporting)

(experimental) Include runtime versioning information in this Stack.

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

Parameters:

analyticsReporting - Include runtime versioning information in this Stack. This parameter is required.

Returns:

this

description

@Stability(value=Experimental)
public IntegTestCaseStack.Builder description(String description)

(experimental) A description of the stack.

Default: - No description.

Parameters:

description - A description of the stack. This parameter is required.

Returns:

this

env

@Stability(value=Experimental)
public IntegTestCaseStack.Builder env(Environment env)

(experimental) 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");
 

Parameters:

env - The AWS environment (account/region) where this stack will be deployed. This parameter is required.

Returns:

this

stackName

@Stability(value=Experimental)
public IntegTestCaseStack.Builder stackName(String stackName)

(experimental) Name to deploy the stack with.

Default: - Derived from construct path.

Parameters:

stackName - Name to deploy the stack with. This parameter is required.

Returns:

this

synthesizer

@Stability(value=Experimental)
public IntegTestCaseStack.Builder synthesizer(IStackSynthesizer synthesizer)

(experimental) Synthesis method to use while deploying this stack.

Default: - `DefaultStackSynthesizer` if the `@aws-cdk/core:newStyleStackSynthesis` feature flag is set, `LegacyStackSynthesizer` otherwise.

Parameters:

synthesizer - Synthesis method to use while deploying this stack. This parameter is required.

Returns:

this

tags

@Stability(value=Experimental)
public IntegTestCaseStack.Builder tags(Map<String,String> tags)

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

Default: {}

Parameters:

tags - Stack tags that will be applied to all the taggable resources and the stack itself. This parameter is required.

Returns:

this

terminationProtection

@Stability(value=Experimental)
public IntegTestCaseStack.Builder terminationProtection(Boolean terminationProtection)

(experimental) Whether to enable termination protection for this stack.

Default: false

Parameters:

terminationProtection - Whether to enable termination protection for this stack. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public IntegTestCaseStack build()

Specified by:

build in interface software.amazon.jsii.Builder<IntegTestCaseStack>