software.amazon.awscdk.services.apigatewayv2

Class CfnIntegrationResponseProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.CfnIntegrationResponseProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIntegrationResponseProps>

Enclosing interface:

CfnIntegrationResponseProps

@Stability(value=Stable)
public static final class CfnIntegrationResponseProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIntegrationResponseProps>

A builder for CfnIntegrationResponseProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnIntegrationResponseProps.Builder	apiId(String apiId) Sets the value of CfnIntegrationResponseProps.getApiId()
CfnIntegrationResponseProps	build() Builds the configured instance.
CfnIntegrationResponseProps.Builder	contentHandlingStrategy(String contentHandlingStrategy) Sets the value of CfnIntegrationResponseProps.getContentHandlingStrategy()
CfnIntegrationResponseProps.Builder	integrationId(String integrationId) Sets the value of CfnIntegrationResponseProps.getIntegrationId()
CfnIntegrationResponseProps.Builder	integrationResponseKey(String integrationResponseKey) Sets the value of CfnIntegrationResponseProps.getIntegrationResponseKey()
CfnIntegrationResponseProps.Builder	responseParameters(Object responseParameters) Sets the value of CfnIntegrationResponseProps.getResponseParameters()
CfnIntegrationResponseProps.Builder	responseTemplates(Object responseTemplates) Sets the value of CfnIntegrationResponseProps.getResponseTemplates()
CfnIntegrationResponseProps.Builder	templateSelectionExpression(String templateSelectionExpression) Sets the value of CfnIntegrationResponseProps.getTemplateSelectionExpression()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

apiId

@Stability(value=Stable)
public CfnIntegrationResponseProps.Builder apiId(String apiId)

Sets the value of CfnIntegrationResponseProps.getApiId()

Parameters:

apiId - The API identifier. This parameter is required.

Returns:

this

integrationId

@Stability(value=Stable)
public CfnIntegrationResponseProps.Builder integrationId(String integrationId)

Sets the value of CfnIntegrationResponseProps.getIntegrationId()

Parameters:

integrationId - The integration ID. This parameter is required.

Returns:

this

integrationResponseKey

@Stability(value=Stable)
public CfnIntegrationResponseProps.Builder integrationResponseKey(String integrationResponseKey)

Sets the value of CfnIntegrationResponseProps.getIntegrationResponseKey()

Parameters:

integrationResponseKey - The integration response key. This parameter is required.

Returns:

this

contentHandlingStrategy

@Stability(value=Stable)
public CfnIntegrationResponseProps.Builder contentHandlingStrategy(String contentHandlingStrategy)

Sets the value of CfnIntegrationResponseProps.getContentHandlingStrategy()

Parameters:

contentHandlingStrategy - Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

CONVERT_TO_BINARY : Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT : Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Returns:

this

responseParameters

@Stability(value=Stable)
public CfnIntegrationResponseProps.Builder responseParameters(Object responseParameters)

Sets the value of CfnIntegrationResponseProps.getResponseParameters()

Parameters:

responseParameters - A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header. *{name}* , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header. *{name}* or integration.response.body. *{JSON-expression}* , where *{name}* is a valid and unique response header name and *{JSON-expression}* is a valid JSON expression without the $ prefix.

Returns:

this

responseTemplates

@Stability(value=Stable)
public CfnIntegrationResponseProps.Builder responseTemplates(Object responseTemplates)

Sets the value of CfnIntegrationResponseProps.getResponseTemplates()

Parameters:

responseTemplates - The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Returns:

this

templateSelectionExpression

@Stability(value=Stable)
public CfnIntegrationResponseProps.Builder templateSelectionExpression(String templateSelectionExpression)

Sets the value of CfnIntegrationResponseProps.getTemplateSelectionExpression()

Parameters:

templateSelectionExpression - The template selection expression for the integration response. Supported only for WebSocket APIs.

Returns:

this

build

@Stability(value=Stable)
public CfnIntegrationResponseProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnIntegrationResponseProps>

Returns:

a new instance of CfnIntegrationResponseProps

Throws:

NullPointerException - if any required attribute was not provided