software.amazon.awscdk.cloudassembly.schema

Interface CdkCommand

All Known Subinterfaces:

DeployCommand, DestroyCommand

All Known Implementing Classes:

CdkCommand.Jsii$Proxy, DeployCommand.Jsii$Proxy, DestroyCommand.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:31.186Z")
public interface 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 software.amazon.awscdk.cloudassembly.schema.*;
 CdkCommand cdkCommand = CdkCommand.builder()
         .enabled(false)
         .expectedMessage("expectedMessage")
         .expectError(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CdkCommand.Builder A builder for CdkCommand
static class	CdkCommand.Jsii$Proxy An implementation for CdkCommand

Method Summary

Modifier and Type	Method and Description
static CdkCommand.Builder	builder()
default java.lang.Boolean	getEnabled() 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 java.lang.String	getExpectedMessage() This can be used in combination with `expectedError` to validate that a specific message is returned.
default java.lang.Boolean	getExpectError() If the runner should expect this command to fail.

Method Detail

getEnabled

default java.lang.Boolean getEnabled()

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

getExpectedMessage

default java.lang.String getExpectedMessage()

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

Default: - do not validate message

getExpectError

default java.lang.Boolean getExpectError()

If the runner should expect this command to fail.

Default: false

builder

static CdkCommand.Builder builder()

Returns:

a CdkCommand.Builder of CdkCommand