Package io.github.cdklabs.cdk.ecs.codedeploy

Interface ApiTestStep

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiTestStep.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-06T18:16:18.997Z")
@Stability(Experimental)
public interface ApiTestStep
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ApiTestStep.Builder	builder()
default String	getBody()	(experimental) Optional body to include in HTTP request.
default Object	getExpectedValue()	(experimental) Expected value to compare against the jmesPath.
default Map<String,String>	getHeaders()	(experimental) Optional headers to include in HTTP request.
default String	getJmesPath()	(experimental) JMESPath to apply against the response from the HTTP request and compare against expected value.
default String	getMethod()	(experimental) Optional method to for HTTP request.
String	getName()	(experimental) Name of test.
String	getPath()	(experimental) Path of HTTP request, relative to baseUrl.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(Experimental)
@NotNull
String getName()

(experimental) Name of test.

getPath

@Stability(Experimental)
@NotNull
String getPath()

(experimental) Path of HTTP request, relative to baseUrl.

getBody

@Stability(Experimental)
@Nullable
default String getBody()

(experimental) Optional body to include in HTTP request.

Default: - no body included.

getExpectedValue

@Stability(Experimental)
@Nullable
default Object getExpectedValue()

(experimental) Expected value to compare against the jmesPath.

Default: - undefined

getHeaders

@Stability(Experimental)
@Nullable
default Map<String,String> getHeaders()

(experimental) Optional headers to include in HTTP request.

Default: - no headers included.

getJmesPath

@Stability(Experimental)
@Nullable
default String getJmesPath()

(experimental) JMESPath to apply against the response from the HTTP request and compare against expected value.

Default: - no JMESPath assertion will be performed.

getMethod

@Stability(Experimental)
@Nullable
default String getMethod()

(experimental) Optional method to for HTTP request.

Default: - GET

builder

@Stability(Experimental)
static ApiTestStep.Builder builder()

Returns:

a ApiTestStep.Builder of ApiTestStep