Interface CfnIntegrationResponseProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnIntegrationResponseProps.Jsii$Proxy
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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnIntegrationResponseProps
static final class
An implementation forCfnIntegrationResponseProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
getApiId()
The API identifier.default String
Supported only for WebSocket APIs.The integration ID.The integration response key.default Object
A key-value map specifying response parameters that are passed to the method response from the backend.default Object
The collection of response templates for the integration response as a string-to-string map of key-value pairs.default String
The template selection expression for the integration response.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApiId
The API identifier.- See Also:
-
getIntegrationId
The integration ID.- See Also:
-
getIntegrationResponseKey
The integration response key.- See Also:
-
getContentHandlingStrategy
Supported only for WebSocket APIs.Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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.
- See Also:
-
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 ofintegration.response.header. *{name}*
orintegration.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.- See Also:
-
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.
- See Also:
-
getTemplateSelectionExpression
The template selection expression for the integration response.Supported only for WebSocket APIs.
- See Also:
-
builder
-