aws-cdk-lib.cloud_assembly_schema.TestOptions

TestOptions Struct

The set of options to control the workflow of the test runner.

Source

node_modules/@aws-cdk/cloud-assembly-schema/lib/integ-tests/test-case.d.ts

Type last changed

v2.258.0 · 4 Jun 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';
const testOptions: cloud_assembly_schema.TestOptions = {
  allowDeleteFailures: false,
  allowDestroy: ['allowDestroy'],
  cdkCommandOptions: {
    deploy: {
      args: {
        all: false,
        app: 'app',
        assetMetadata: false,
        caBundlePath: 'caBundlePath',
        changeSetName: 'changeSetName',
        ci: false,
        color: false,
        concurrency: 123,
        context: {
          contextKey: 'context',
        },
        debug: false,
        ec2Creds: false,
        exclusively: false,
        execute: false,
        force: false,
        ignoreErrors: false,
        json: false,
        lookups: false,
        notices: false,
        notificationArns: ['notificationArns'],
        output: 'output',
        outputsFile: 'outputsFile',
        parameters: {
          parametersKey: 'parameters',
        },
        pathMetadata: false,
        profile: 'profile',
        proxy: 'proxy',
        requireApproval: cloud_assembly_schema.RequireApproval.NEVER,
        reuseAssets: ['reuseAssets'],
        roleArn: 'roleArn',
        rollback: false,
        stacks: ['stacks'],
        staging: false,
        strict: false,
        toolkitStackName: 'toolkitStackName',
        trace: false,
        usePreviousParameters: false,
        verbose: false,
        versionReporting: false,
      },
      enabled: false,
      expectedMessage: 'expectedMessage',
      expectError: false,
    },
    destroy: {
      args: {
        all: false,
        app: 'app',
        assetMetadata: false,
        caBundlePath: 'caBundlePath',
        color: false,
        context: {
          contextKey: 'context',
        },
        debug: false,
        ec2Creds: false,
        exclusively: false,
        force: false,
        ignoreErrors: false,
        json: false,
        lookups: false,
        notices: false,
        output: 'output',
        pathMetadata: false,
        profile: 'profile',
        proxy: 'proxy',
        roleArn: 'roleArn',
        stacks: ['stacks'],
        staging: false,
        strict: false,
        trace: false,
        verbose: false,
        versionReporting: false,
      },
      enabled: false,
      expectedMessage: 'expectedMessage',
      expectError: false,
    },
  },
  diffAssets: false,
  hooks: {
    postDeploy: ['postDeploy'],
    postDestroy: ['postDestroy'],
    preDeploy: ['preDeploy'],
    preDestroy: ['preDestroy'],
  },
  regions: ['regions'],
  stackUpdateWorkflow: false,
};

Properties

allowDeleteFailures?optionalbooleanallow_delete_failures?optionalboolallowDeleteFailures?optionalBooleanAllowDeleteFailures?optionalboolAllowDeleteFailures?optional*bool= false#

Whether to allow resources that fail to delete during a stack update.

When false, the test will fail if CloudFormation skips deleting a resource during a stack update. When true, only a warning is printed.

allowDestroy?optionalstring[]allow_destroy?optionaltyping.List[str]allowDestroy?optionalList<String>AllowDestroy?optionalstring[]AllowDestroy?optional*[]*string#

List of CloudFormation resource types in this stack that can be destroyed as part of an update without failing the test.

Default: do not allow destruction of any resources on update

notes

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

cdkCommandOptions?optionalCdkCommandscdk_command_options?optionalCdkCommandscdkCommandOptions?optionalCdkCommandsCdkCommandOptions?optionalCdkCommandsCdkCommandOptions?optionalCdkCommands#

Additional options to use for each CDK command.

Default: runner default options

diffAssets?optionalbooleandiff_assets?optionalbooldiffAssets?optionalBooleanDiffAssets?optionalboolDiffAssets?optional*bool= 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

hooks?optionalHookshooks?optionalHookshooks?optionalHooksHooks?optionalHooksHooks?optionalHooks#

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

Default: no hooks

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

regions?optionalstring[]regions?optionaltyping.List[str]regions?optionalList<String>Regions?optionalstring[]Regions?optional*[]*string#

Limit deployment to these regions.

Default: can run in any region

stackUpdateWorkflow?optionalbooleanstack_update_workflow?optionalboolstackUpdateWorkflow?optionalBooleanStackUpdateWorkflow?optionalboolStackUpdateWorkflow?optional*bool= 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.