interface CdkCommand

Language	Type name
.NET	`Amazon.CDK.cloud_assembly_schema.CdkCommand`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#CdkCommand`
Java	`software.amazon.awscdk.cloud_assembly_schema.CdkCommand`
Python	`aws_cdk.cloud_assembly_schema.CdkCommand`
TypeScript (source)	`aws-cdk-lib` » `cloud_assembly_schema` » `CdkCommand`

Represents a cdk command i.e. synth, deploy, & destroy.

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 cdkCommand: cloud_assembly_schema.CdkCommand = {
  enabled: false,
  expectedMessage: 'expectedMessage',
  expectError: false,
};

Properties

Name	Type	Description
enabled?	`boolean`	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?	`boolean`	If the runner should expect this command to fail.
expectedMessage?	`string`	This can be used in combination with `expectedError` to validate that a specific message is returned.

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.

AWS CDK