CdkCommand

class aws_cdk.cloud_assembly_schema.CdkCommand(*, enabled=None, expected_message=None, expect_error=None)

Bases: object

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

Parameters
  • enabled (Optional[bool]) – 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. Default: true

  • expected_message (Optional[str]) – This can be used in combination with expectedError to validate that a specific message is returned. Default: - do not validate message

  • expect_error (Optional[bool]) – If the runner should expect this command to fail. Default: false

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.cloud_assembly_schema as cloud_assembly_schema

cdk_command = cloud_assembly_schema.CdkCommand(
    enabled=False,
    expected_message="expectedMessage",
    expect_error=False
)

Attributes

enabled

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.

Default

true

Return type

Optional[bool]

expect_error

If the runner should expect this command to fail.

Default

false

Return type

Optional[bool]

expected_message

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

Default
  • do not validate message

Return type

Optional[str]