@aws-cdk_cloud-assembly-schema.DeployCommand

interface DeployCommand

LanguageType name
.NETAmazon.CDK.CloudAssembly.Schema.DeployCommand
Javasoftware.amazon.awscdk.cloudassembly.schema.DeployCommand
Pythonaws_cdk.cloud_assembly_schema.DeployCommand
TypeScript (source)@aws-cdk/cloud-assembly-schema » DeployCommand

Represents a cdk deploy command.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';
const deployCommand: cloud_assembly_schema.DeployCommand = {
  args: {
    all: false,
    app: 'app',
    assetMetadata: false,
    caBundlePath: 'caBundlePath',
    changeSetName: 'changeSetName',
    ci: false,
    color: false,
    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

NameTypeDescription
args?DeployOptionsAdditional arguments to pass to the command This can be used to test specific CLI functionality.
enabled?booleanWhether 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.
expectError?booleanIf the runner should expect this command to fail.
expectedMessage?stringThis can be used in combination with expectedError to validate that a specific message is returned.

args?

Type: DeployOptions (optional, default: only default args are used)

Additional arguments to pass to the command This can be used to test specific CLI functionality.


enabled?

Type: boolean (optional, default: 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.


expectError?

Type: boolean (optional, default: false)

If the runner should expect this command to fail.


expectedMessage?

Type: string (optional, default: do not validate message)

This can be used in combination with expectedError to validate that a specific message is returned.