Package software.amazon.awscdk.cloudassembly.schema

Interface CdkCommand

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DeployCommand, DestroyCommand

All Known Implementing Classes:

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

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:26.072Z")
@Stability(Stable)
public interface CdkCommand
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	CdkCommand.Builder	A builder for CdkCommand
static final class	CdkCommand.Jsii$Proxy	An implementation for CdkCommand

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
@Nullable
default String getExpectedMessage()

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

Default: - do not validate message

getExpectError

@Stability(Stable)
@Nullable
default Boolean getExpectError()

If the runner should expect this command to fail.

Default: false

builder

@Stability(Stable)
static CdkCommand.Builder builder()

Returns:

a CdkCommand.Builder of CdkCommand