@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-25T18:29:06.912Z")
public interface CfnIntegrationResponseProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnIntegrationResponseProps.Builder
A builder for
CfnIntegrationResponseProps |
static class |
CfnIntegrationResponseProps.Jsii$Proxy
An implementation for
CfnIntegrationResponseProps |
Modifier and Type | Method and Description |
---|---|
static CfnIntegrationResponseProps.Builder |
builder() |
java.lang.String |
getApiId()
The API identifier.
|
default java.lang.String |
getContentHandlingStrategy()
Supported only for WebSocket APIs.
|
java.lang.String |
getIntegrationId()
The integration ID.
|
java.lang.String |
getIntegrationResponseKey()
The integration response key.
|
default java.lang.Object |
getResponseParameters()
A key-value map specifying response parameters that are passed to the method response from the backend.
|
default java.lang.Object |
getResponseTemplates()
The collection of response templates for the integration response as a string-to-string map of key-value pairs.
|
default java.lang.String |
getTemplateSelectionExpression()
The template selection expression for the integration response.
|
java.lang.String getApiId()
java.lang.String getIntegrationId()
java.lang.String getIntegrationResponseKey()
default java.lang.String getContentHandlingStrategy()
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.
default java.lang.Object getResponseParameters()
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.
default java.lang.Object getResponseTemplates()
Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
default java.lang.String getTemplateSelectionExpression()
Supported only for WebSocket APIs.
static CfnIntegrationResponseProps.Builder builder()