DeployCommand Struct
Represents a cdk deploy command.
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
argsoptionalDeployOptionsargsoptionalDeployOptionsargsoptionalDeployOptionsArgsoptionalDeployOptionsArgsoptionalDeployOptions#Additional arguments to pass to the command This can be used to test specific CLI functionality.
Default: only default args are used
enabledoptionalbooleanenabledoptionalboolenabledoptionalBooleanEnabledoptionalboolEnabledoptional*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.
expectedMessageoptionalstringexpected_messageoptionalstrexpectedMessageoptionalStringExpectedMessageoptionalstringExpectedMessageoptional*string#This can be used in combination with `expectedError` to validate that a specific message is returned.
Default: do not validate message
expectErroroptionalbooleanexpect_erroroptionalboolexpectErroroptionalBooleanExpectErroroptionalboolExpectErroroptional*bool= false#If the runner should expect this command to fail.