Package software.amazon.awscdk.services.apigatewayv2

Interface CfnIntegrationResponseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIntegrationResponseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:43.215Z")
@Stability(Stable)
public interface CfnIntegrationResponseProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIntegrationResponse.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 Object responseParameters;
 Object responseTemplates;
 CfnIntegrationResponseProps cfnIntegrationResponseProps = CfnIntegrationResponseProps.builder()
         .apiId("apiId")
         .integrationId("integrationId")
         .integrationResponseKey("integrationResponseKey")
         // the properties below are optional
         .contentHandlingStrategy("contentHandlingStrategy")
         .responseParameters(responseParameters)
         .responseTemplates(responseTemplates)
         .templateSelectionExpression("templateSelectionExpression")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIntegrationResponseProps.Builder	builder()
String	getApiId()	The API identifier.
default String	getContentHandlingStrategy()	Supported only for WebSocket APIs.
String	getIntegrationId()	The integration ID.
String	getIntegrationResponseKey()	The integration response key.
default Object	getResponseParameters()	A key-value map specifying response parameters that are passed to the method response from the backend.
default Object	getResponseTemplates()	The collection of response templates for the integration response as a string-to-string map of key-value pairs.
default String	getTemplateSelectionExpression()	The template selection expression for the integration response.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

The API identifier.

getIntegrationId

@Stability(Stable)
@NotNull
String getIntegrationId()

The integration ID.

getIntegrationResponseKey

@Stability(Stable)
@NotNull
String getIntegrationResponseKey()

The integration response key.

getContentHandlingStrategy

@Stability(Stable)
@Nullable
default String getContentHandlingStrategy()

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.

getResponseParameters

@Stability(Stable)
@Nullable
default Object getResponseParameters()

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.

getResponseTemplates

@Stability(Stable)
@Nullable
default Object getResponseTemplates()

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.

getTemplateSelectionExpression

@Stability(Stable)
@Nullable
default String getTemplateSelectionExpression()

The template selection expression for the integration response.

Supported only for WebSocket APIs.

builder

@Stability(Stable)
static CfnIntegrationResponseProps.Builder builder()

Returns:

a CfnIntegrationResponseProps.Builder of CfnIntegrationResponseProps