@Stability(value=Experimental) public static final class IntegTestCaseStackProps.Builder extends Object implements software.amazon.jsii.Builder<IntegTestCaseStackProps>
IntegTestCaseStackProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Experimental) public IntegTestCaseStackProps.Builder allowDestroy(List<String> allowDestroy)
TestOptions.getAllowDestroy()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']
this@Stability(value=Experimental) public IntegTestCaseStackProps.Builder cdkCommandOptions(CdkCommands cdkCommandOptions)
TestOptions.getCdkCommandOptions()cdkCommandOptions - Additional options to use for each CDK command.this@Stability(value=Experimental) public IntegTestCaseStackProps.Builder diffAssets(Boolean diffAssets)
TestOptions.getDiffAssets()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 bundlingthis@Stability(value=Experimental) public IntegTestCaseStackProps.Builder hooks(Hooks hooks)
TestOptions.getHooks()hooks - Additional commands to run at predefined points in the test workflow.
e.g. { postDeploy: ['yarn', 'test'] }this@Stability(value=Experimental) public IntegTestCaseStackProps.Builder regions(List<String> regions)
TestOptions.getRegions()regions - Limit deployment to these regions.this@Stability(value=Experimental) public IntegTestCaseStackProps.Builder stackUpdateWorkflow(Boolean stackUpdateWorkflow)
TestOptions.getStackUpdateWorkflow()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@Stability(value=Experimental) public IntegTestCaseStackProps.Builder analyticsReporting(Boolean analyticsReporting)
StackProps.getAnalyticsReporting()analyticsReporting - Include runtime versioning information in this Stack.this@Stability(value=Experimental) public IntegTestCaseStackProps.Builder description(String description)
StackProps.getDescription()description - A description of the stack.this@Stability(value=Experimental) public IntegTestCaseStackProps.Builder env(Environment env)
StackProps.getEnv()env - 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.
this@Stability(value=Experimental) public IntegTestCaseStackProps.Builder stackName(String stackName)
StackProps.getStackName()stackName - Name to deploy the stack with.this@Stability(value=Experimental) public IntegTestCaseStackProps.Builder synthesizer(IStackSynthesizer synthesizer)
StackProps.getSynthesizer()synthesizer - Synthesis method to use while deploying this stack.this@Stability(value=Experimental) public IntegTestCaseStackProps.Builder tags(Map<String,String> tags)
StackProps.getTags()tags - Stack tags that will be applied to all the taggable resources and the stack itself.this@Stability(value=Experimental) public IntegTestCaseStackProps.Builder terminationProtection(Boolean terminationProtection)
StackProps.getTerminationProtection()terminationProtection - Whether to enable termination protection for this stack.this@Stability(value=Experimental) public IntegTestCaseStackProps build()
build in interface software.amazon.jsii.Builder<IntegTestCaseStackProps>IntegTestCaseStackPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.