AWS CDK Reference

Appearance

v2.274.0

DeployCommand Struct ​

Represents a cdk deploy command.

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 deployCommand: cloud_assembly_schema.DeployCommand = {
  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,
};

Properties ​

argsDeployOptionsargsDeployOptionsargsDeployOptionsArgsDeployOptionsArgsDeployOptions= only default args are used#
Additional arguments to pass to the command This can be used to test specific CLI functionality.
enabledbooleanenabledboolenabledBooleanEnabledboolEnabled*bool= true#
Whether or not to run this command as part of the workflow This can be used if you only want to test some of the workflow for example enable `synth` and disable `deploy` & `destroy` in order to limit the test to synthesis.
expectedMessagestringexpected_messagestrexpectedMessageStringExpectedMessagestringExpectedMessage*string= do not validate message#
This can be used in combination with `expectedError` to validate that a specific message is returned.
expectErrorbooleanexpect_errorboolexpectErrorBooleanExpectErrorboolExpectError*bool= false#
If the runner should expect this command to fail.