AWS CDK Reference

Appearance

v2.274.0

CdkCommands Struct ​

Options for specific cdk commands that are run as part of the integration test workflow.

Source
node_modules/@aws-cdk/cloud-assembly-schema/lib/integ-tests/test-case.d.ts
Type last changed
v2.20.0 · 7 Apr 2022

Example ​

ts
// 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 cdkCommands: cloud_assembly_schema.CdkCommands = {
  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,
  },
};

Properties ​

deployDeployCommanddeployDeployCommanddeployDeployCommandDeployDeployCommandDeployDeployCommand= default deploy options#
Options to for the cdk deploy command.
destroyDestroyCommanddestroyDestroyCommanddestroyDestroyCommandDestroyDestroyCommandDestroyDestroyCommand= default destroy options#
Options to for the cdk destroy command.