software.amazon.lambda.powertools.cloudformation

Class Response

java.lang.Object

software.amazon.lambda.powertools.cloudformation.Response

public class Response
extends java.lang.Object

Models the arbitrary data to be sent to the custom resource in response to a CloudFormation event. This object encapsulates the data and the means to serialize it.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Response.Builder For building Response instances.
static class	Response.Status Indicates whether a response is a success or failure.

Method Summary

Modifier and Type	Method and Description
static Response.Builder	builder() Creates a builder for constructing a Response wrapping the provided value.
static Response	failed() Creates an empty, failed Response.
java.lang.String	getPhysicalResourceId() The physical resource ID.
Response.Status	getStatus() The success/failed status of the Response.
boolean	isNoEcho() Whether to mask custom resource output (true) or not (false).
static Response	success() Creates an empty, successful Response.
java.lang.String	toString() Includes all Response attributes, including its value in JSON format

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static Response.Builder builder()

Creates a builder for constructing a Response wrapping the provided value.

Returns:

a builder

failed

public static Response failed()

Creates an empty, failed Response.

Returns:

a failed Response with no value.

success

public static Response success()

Creates an empty, successful Response.

Returns:

a failed Response with no value.

getStatus

public Response.Status getStatus()

The success/failed status of the Response.

Returns:

a non-null Status

getPhysicalResourceId

public java.lang.String getPhysicalResourceId()

The physical resource ID. If null, the default physical resource ID will be provided to the custom resource.

Returns:

a potentially null physical resource ID

isNoEcho

public boolean isNoEcho()

Whether to mask custom resource output (true) or not (false).

Returns:

true if custom resource output is to be masked, false otherwise

toString

public java.lang.String toString()

Includes all Response attributes, including its value in JSON format

Overrides:

toString in class java.lang.Object

Returns:

a full description of the Response