Interface CfnMethod.IntegrationResponseProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnMethod.IntegrationResponseProperty.Jsii$Proxy
- Enclosing class:
CfnMethod
IntegrationResponse
is a property of the Amazon API Gateway Method Integration property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.
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.apigateway.*; IntegrationResponseProperty integrationResponseProperty = IntegrationResponseProperty.builder() .statusCode("statusCode") // the properties below are optional .contentHandling("contentHandling") .responseParameters(Map.of( "responseParametersKey", "responseParameters")) .responseTemplates(Map.of( "responseTemplatesKey", "responseTemplates")) .selectionPattern("selectionPattern") .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnMethod.IntegrationResponseProperty
static final class
An implementation forCfnMethod.IntegrationResponseProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
Specifies how to handle response payload content type conversions.default Object
A key-value map specifying response parameters that are passed to the method response from the back end.default Object
Specifies the templates used to transform the integration response body.default String
Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end.Specifies the status code that is used to map the integration response to an existing MethodResponse.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getStatusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse. -
getContentHandling
Specifies how to handle response payload content type conversions.Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
-
getResponseParameters
A key-value map specifying response parameters that are passed to the method response from the back end.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}
, wherename
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}
, wherename
is a valid and unique response header name andJSON-expression
is a valid JSON expression without the$
prefix. -
getResponseTemplates
Specifies the templates used to transform the integration response body.Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
-
getSelectionPattern
Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end.For example, if the success response returns nothing and the error response returns some string, you could use the
.+
regex to match error response. However, make sure that the error response does not contain any newline (\n
) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched. -
builder
-