software.amazon.awscdk.cloudassembly.schema

Class TestCase.Builder

java.lang.Object

software.amazon.awscdk.cloudassembly.schema.TestCase.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TestCase>

Enclosing interface:

TestCase

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

A builder for TestCase

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TestCase.Builder	allowDestroy(List<String> allowDestroy) Sets the value of TestOptions.getAllowDestroy()
TestCase.Builder	assertionStack(String assertionStack) Sets the value of TestCase.getAssertionStack()
TestCase.Builder	assertionStackName(String assertionStackName) Sets the value of TestCase.getAssertionStackName()
TestCase	build() Builds the configured instance.
TestCase.Builder	cdkCommandOptions(CdkCommands cdkCommandOptions) Sets the value of TestOptions.getCdkCommandOptions()
TestCase.Builder	diffAssets(Boolean diffAssets) Sets the value of TestOptions.getDiffAssets()
TestCase.Builder	hooks(Hooks hooks) Sets the value of TestOptions.getHooks()
TestCase.Builder	regions(List<String> regions) Sets the value of TestOptions.getRegions()
TestCase.Builder	stacks(List<String> stacks) Sets the value of TestCase.getStacks()
TestCase.Builder	stackUpdateWorkflow(Boolean stackUpdateWorkflow) Sets the value of TestOptions.getStackUpdateWorkflow()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

stacks

@Stability(value=Stable)
public TestCase.Builder stacks(List<String> stacks)

Sets the value of TestCase.getStacks()

Parameters:

stacks - Stacks that should be tested as part of this test case The stackNames will be passed as args to the cdk commands so dependent stacks will be automatically deployed unless `exclusively` is passed. This parameter is required.

Returns:

this

assertionStack

@Stability(value=Stable)
public TestCase.Builder assertionStack(String assertionStack)

Sets the value of TestCase.getAssertionStack()

Parameters:

assertionStack - The node id of the stack that contains assertions. This is the value that can be used to deploy the stack with the CDK CLI

Returns:

this

assertionStackName

@Stability(value=Stable)
public TestCase.Builder assertionStackName(String assertionStackName)

Sets the value of TestCase.getAssertionStackName()

Parameters:

assertionStackName - The name of the stack that contains assertions.

Returns:

this

allowDestroy

@Stability(value=Stable)
public TestCase.Builder allowDestroy(List<String> allowDestroy)

Sets the value of TestOptions.getAllowDestroy()

Parameters:

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

Returns:

this

cdkCommandOptions

@Stability(value=Stable)
public TestCase.Builder cdkCommandOptions(CdkCommands cdkCommandOptions)

Sets the value of TestOptions.getCdkCommandOptions()

Parameters:

cdkCommandOptions - Additional options to use for each CDK command.

Returns:

this

diffAssets

@Stability(value=Stable)
public TestCase.Builder diffAssets(Boolean diffAssets)

Sets the value of TestOptions.getDiffAssets()

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. For example any tests involving custom resources or bundling

Returns:

this

hooks

@Stability(value=Stable)
public TestCase.Builder hooks(Hooks hooks)

Sets the value of TestOptions.getHooks()

Parameters:

hooks - Additional commands to run at predefined points in the test workflow. e.g. { postDeploy: ['yarn', 'test'] }

Returns:

this

regions

@Stability(value=Stable)
public TestCase.Builder regions(List<String> regions)

Sets the value of TestOptions.getRegions()

Parameters:

regions - Limit deployment to these regions.

Returns:

this

stackUpdateWorkflow

@Stability(value=Stable)
public TestCase.Builder stackUpdateWorkflow(Boolean stackUpdateWorkflow)

Sets the value of TestOptions.getStackUpdateWorkflow()

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.

Returns:

this

build

@Stability(value=Stable)
public TestCase build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TestCase

Throws:

NullPointerException - if any required attribute was not provided