IntegTestCaseStackProps
- class aws_cdk.integ_tests.IntegTestCaseStackProps(*, allow_destroy=None, cdk_command_options=None, diff_assets=None, hooks=None, regions=None, stack_update_workflow=None, analytics_reporting=None, description=None, env=None, stack_name=None, synthesizer=None, tags=None, termination_protection=None)
Bases:
TestOptions
,StackProps
(experimental) Properties of an integration test case stack.
- Parameters:
allow_destroy (
Optional
[Sequence
[str
]]) – 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 updatecdk_command_options (
Union
[CdkCommands
,Dict
[str
,Any
],None
]) – Additional options to use for each CDK command. Default: - runner default optionsdiff_assets (
Optional
[bool
]) – 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: falsehooks (
Union
[Hooks
,Dict
[str
,Any
],None
]) – Additional commands to run at predefined points in the test workflow. e.g. { postDeploy: [‘yarn’, ‘test’] } Default: - no hooksregions (
Optional
[Sequence
[str
]]) – Limit deployment to these regions. Default: - can run in any regionstack_update_workflow (
Optional
[bool
]) – 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: trueanalytics_reporting (
Optional
[bool
]) – Include runtime versioning information in this Stack. Default:analyticsReporting
setting of containingApp
, or value of ‘aws:cdk:version-reporting’ context keydescription (
Optional
[str
]) – A description of the stack. Default: - No description.env (
Union
[Environment
,Dict
[str
,Any
],None
]) – The AWS environment (account/region) where this stack will be deployed. Set theregion
/account
fields ofenv
to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variablesCDK_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 theStack
is instantiated inside aStage
, any undefinedregion
/account
fields fromenv
will default to the same field on the encompassingStage
, if configured there. If eitherregion
oraccount
are not set nor inherited fromStage
, 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 asec2.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 containingStage
if available, otherwise create the stack will be environment-agnostic.stack_name (
Optional
[str
]) – Name to deploy the stack with. Default: - Derived from construct path.synthesizer (
Optional
[IStackSynthesizer
]) – Synthesis method to use while deploying this stack. Default: -DefaultStackSynthesizer
if the@aws-cdk/core:newStyleStackSynthesis
feature flag is set,LegacyStackSynthesizer
otherwise.tags (
Optional
[Mapping
[str
,str
]]) – Stack tags that will be applied to all the taggable resources and the stack itself. Default: {}termination_protection (
Optional
[bool
]) – Whether to enable termination protection for this stack. Default: false
- Stability:
experimental
- ExampleMetadata:
infused
Example:
# app: App # stack_under_test: Stack test_case_with_assets = IntegTestCaseStack(app, "TestCaseAssets", diff_assets=True ) IntegTest(app, "Integ", test_cases=[stack_under_test, test_case_with_assets])
Attributes
- allow_destroy
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
- analytics_reporting
Include runtime versioning information in this Stack.
- Default:
analyticsReporting
setting of containingApp
, or value of ‘aws:cdk:version-reporting’ context key
- cdk_command_options
Additional options to use for each CDK command.
- Default:
runner default options
- description
A description of the stack.
- Default:
No description.
- diff_assets
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
- env
The AWS environment (account/region) where this stack will be deployed.
Set the
region
/account
fields ofenv
to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variablesCDK_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 aStage
, any undefinedregion
/account
fields fromenv
will default to the same field on the encompassingStage
, if configured there.If either
region
oraccount
are not set nor inherited fromStage
, 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 asec2.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. Stack(app, "Stack1", env=Environment( 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) Stack(app, "Stack2", env=Environment( account=process.env.CDK_DEFAULT_ACCOUNT, region=process.env.CDK_DEFAULT_REGION ) ) # Define multiple stacks stage associated with an environment my_stage = Stage(app, "MyStage", env=Environment( 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 MyStack(my_stage, "Stack1") YourStack(my_stage, "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. MyStack(app, "Stack1")
- hooks
Additional commands to run at predefined points in the test workflow.
e.g. { postDeploy: [‘yarn’, ‘test’] }
- Default:
no hooks
- regions
Limit deployment to these regions.
- Default:
can run in any region
- stack_name
Name to deploy the stack with.
- Default:
Derived from construct path.
- stack_update_workflow
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
- synthesizer
Synthesis method to use while deploying this stack.
- Default:
DefaultStackSynthesizer
if the@aws-cdk/core:newStyleStackSynthesis
feature flag
is set,
LegacyStackSynthesizer
otherwise.
- tags
Stack tags that will be applied to all the taggable resources and the stack itself.
- Default:
{}
- termination_protection
Whether to enable termination protection for this stack.
- Default:
false