Package software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2

Class CfnIntegrationResponseMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.CfnIntegrationResponseMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIntegrationResponseMixinProps>

Enclosing interface:

CfnIntegrationResponseMixinProps

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

A builder for CfnIntegrationResponseMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

apiId

@Stability(Stable)
public CfnIntegrationResponseMixinProps.Builder apiId(String apiId)

Sets the value of CfnIntegrationResponseMixinProps.getApiId()

Parameters:

apiId - The API identifier.

Returns:

this

apiId

@Stability(Stable)
public CfnIntegrationResponseMixinProps.Builder apiId(IApiRef apiId)

Sets the value of CfnIntegrationResponseMixinProps.getApiId()

Parameters:

apiId - The API identifier.

Returns:

this

contentHandlingStrategy

@Stability(Stable)
public CfnIntegrationResponseMixinProps.Builder contentHandlingStrategy(String contentHandlingStrategy)

Sets the value of CfnIntegrationResponseMixinProps.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

integrationId

@Stability(Stable)
public CfnIntegrationResponseMixinProps.Builder integrationId(String integrationId)

Sets the value of CfnIntegrationResponseMixinProps.getIntegrationId()

Parameters:

integrationId - The integration ID.

Returns:

this

integrationId

@Stability(Stable)
public CfnIntegrationResponseMixinProps.Builder integrationId(IIntegrationRef integrationId)

Sets the value of CfnIntegrationResponseMixinProps.getIntegrationId()

Parameters:

integrationId - The integration ID.

Returns:

this

integrationResponseKey

@Stability(Stable)
public CfnIntegrationResponseMixinProps.Builder integrationResponseKey(String integrationResponseKey)

Sets the value of CfnIntegrationResponseMixinProps.getIntegrationResponseKey()

Parameters:

integrationResponseKey - The integration response key.

Returns:

this

responseParameters

@Stability(Stable)
public CfnIntegrationResponseMixinProps.Builder responseParameters(Object responseParameters)

Sets the value of CfnIntegrationResponseMixinProps.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(Stable)
public CfnIntegrationResponseMixinProps.Builder responseTemplates(Object responseTemplates)

Sets the value of CfnIntegrationResponseMixinProps.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(Stable)
public CfnIntegrationResponseMixinProps.Builder templateSelectionExpression(String templateSelectionExpression)

Sets the value of CfnIntegrationResponseMixinProps.getTemplateSelectionExpression()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnIntegrationResponseMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnIntegrationResponseMixinProps

Throws:

NullPointerException - if any required attribute was not provided