software.amazon.awscdk.services.apigateway

Interface CfnMethod.IntegrationResponseProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMethod.IntegrationResponseProperty.Jsii$Proxy

Enclosing class:

CfnMethod

@Stability(value=Stable)
public static interface CfnMethod.IntegrationResponseProperty
extends software.amazon.jsii.JsiiSerializable

`IntegrationResponse` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) 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

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnMethod.IntegrationResponseProperty.Builder	builder()
default String	getContentHandling() Specifies how to handle request payload content type conversions.
default Object	getResponseParameters() The response parameters from the backend response that API Gateway sends to the method response.
default Object	getResponseTemplates() The templates that are used to transform the integration response body.
default String	getSelectionPattern() A [regular expression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-regexes.html) that specifies which error strings or status codes from the backend map to the integration response.
String	getStatusCode() The status code that API Gateway uses to map the integration response to a [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) status code.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getStatusCode

@Stability(value=Stable)
 @NotNull
String getStatusCode()

The status code that API Gateway uses to map the integration response to a [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) status code.

getContentHandling

@Stability(value=Stable)
 @Nullable
default String getContentHandling()

Specifies how to handle request payload content type conversions. Valid values are:.

• CONVERT_TO_BINARY : Converts a request payload from a base64-encoded string to a binary blob.
• CONVERT_TO_TEXT : Converts a request payload from a binary blob to a base64-encoded string.

If this property isn't defined, the request payload is passed through from the method request to the integration request without modification.

getResponseParameters

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

The response parameters from the backend response that API Gateway sends to the method response.

Specify response parameters as key-value pairs ( string-to-string mappings ).

Use the destination as the key and the source as the value:

• The destination must be an existing response parameter in the MethodResponse property.
• The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on the destination specified in the request.

For more information about templates, see API Gateway Mapping Template and Access Logging Variable Reference in the API Gateway Developer Guide .

getResponseTemplates

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

The templates that are used to transform the integration response body.

Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value. For more information, see API Gateway Mapping Template and Access Logging Variable Reference in the API Gateway Developer Guide .

getSelectionPattern

@Stability(value=Stable)
 @Nullable
default String getSelectionPattern()

A [regular expression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-regexes.html) that specifies which error strings or status codes from the backend map to the integration response.

builder

@Stability(value=Stable)
static CfnMethod.IntegrationResponseProperty.Builder builder()

Returns:

a CfnMethod.IntegrationResponseProperty.Builder of CfnMethod.IntegrationResponseProperty