Interface CfnIntegrationResponseProps

All Superinterfaces:
All Known Implementing Classes:

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


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Object responseParameters;
 Object responseTemplates;
 CfnIntegrationResponseProps cfnIntegrationResponseProps = CfnIntegrationResponseProps.builder()
         // the properties below are optional
  • 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()
      a CfnIntegrationResponseProps.Builder of CfnIntegrationResponseProps