software.amazon.lambda.powertools.cloudformation

Class Response.Builder

java.lang.Object

software.amazon.lambda.powertools.cloudformation.Response.Builder

Enclosing class:

Response

public static class Response.Builder
extends java.lang.Object

For building Response instances.

Method Summary

Modifier and Type	Method and Description
Response	build() Builds a Response object for the value.
Response.Builder	noEcho(boolean noEcho) Indicates whether to mask the output of the custom resource when it's retrieved by using the Fn::GetAtt function.
Response.Builder	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Configures a custom ObjectMapper for serializing the value object.
Response.Builder	physicalResourceId(java.lang.String physicalResourceId) A unique identifier for the custom resource being responded to.
Response.Builder	status(Response.Status status) Configures the status of this response.
Response.Builder	value(java.lang.Object value) Configures the value of this Response, typically a Map of name/value pairs.

Methods inherited from class java.lang.Object

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

Method Detail

value

public Response.Builder value(java.lang.Object value)

Configures the value of this Response, typically a Map of name/value pairs.

Parameters:

value - if null, the Response will be empty

Returns:

a reference to this builder

objectMapper

public Response.Builder objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Configures a custom ObjectMapper for serializing the value object. Creates a copy of the mapper provided; future mutations of the ObjectMapper made using the provided reference will not affect Response serialization.

Parameters:

objectMapper - if null, a default mapper will be used

Returns:

a reference to this builder

status

public Response.Builder status(Response.Status status)

Configures the status of this response.

Parameters:

status - if null, SUCCESS will be assumed

Returns:

a reference to this builder

physicalResourceId

public Response.Builder physicalResourceId(java.lang.String physicalResourceId)

A unique identifier for the custom resource being responded to. By default, the identifier is the name of the Amazon CloudWatch Logs log stream associated with the Lambda function.

Parameters:

physicalResourceId - if null, the default resource ID will be used

Returns:

a reference to this builder

noEcho

public Response.Builder noEcho(boolean noEcho)

Indicates whether to mask the output of the custom resource when it's retrieved by using the Fn::GetAtt function. If set to true, values will be masked with asterisks (*****), except for information stored in the these locations:

• The Metadata template section. CloudFormation does not transform, modify, or redact any information included in the Metadata section. See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
• The Outputs template section. See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html
• The Metadata attribute of a resource definition. See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html

We strongly recommend not using these mechanisms to include sensitive information, such as passwords or secrets.

For more information about using noEcho to mask sensitive information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds

By default, this value is false.

Parameters:

noEcho - when true, masks certain output

Returns:

a reference to this builder

build

public Response build()

Builds a Response object for the value.

Returns:

a Response object wrapping the initially provided value.