# CdkCommand

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

- Source: [`node_modules/@aws-cdk/cloud-assembly-schema/lib/integ-tests/test-case.d.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/node_modules/@aws-cdk/cloud-assembly-schema/lib/integ-tests/test-case.d.ts#L130)
- 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 cdkCommand: cloud_assembly_schema.CdkCommand = {
  enabled: false,
  expectedMessage: 'expectedMessage',
  expectError: false,
};
```

## Properties

- `enabled`: boolean = 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.

- `expectedMessage`: string — This can be used in combination with `expectedError` to validate that a specific message is returned.

  **Default:** do not validate message

- `expectError`: boolean = false — If the runner should expect this command to fail.
