DestroyCommand

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

Bases: aws_cdk.cloud_assembly_schema.CdkCommand

Represents a cdk destroy command.

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

  • args (Optional[DestroyOptions]) – Additional arguments to pass to the command This can be used to test specific CLI functionality. Default: - only default args are used

ExampleMetadata

infused

Example:

app = App()

stack_under_test = Stack(app, "StackUnderTest")

stack = Stack(app, "stack")

test_case = IntegTest(app, "CustomizedDeploymentWorkflow",
    test_cases=[stack_under_test],
    diff_assets=True,
    stack_update_workflow=True,
    cdk_command_options=CdkCommands(
        deploy=DeployCommand(
            args=DeployOptions(
                require_approval=RequireApproval.NEVER,
                json=True
            )
        ),
        destroy=DestroyCommand(
            args=DestroyOptions(
                force=True
            )
        )
    )
)

Attributes

args

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

Default
  • only default args are used

Return type

Optional[DestroyOptions]

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]