Package software.amazon.awscdk.services.apigatewayv2

Class CfnIntegrationResponse.Builder

java.lang.Object
software.amazon.awscdk.services.apigatewayv2.CfnIntegrationResponse.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnIntegrationResponse>
Enclosing class:
CfnIntegrationResponse
@Stability(Stable) public static final class CfnIntegrationResponse.Builder extends Object implements software.amazon.jsii.Builder<CfnIntegrationResponse>
A fluent builder for CfnIntegrationResponse.

  • Method Details

    • create

      @Stability(Stable) public static CfnIntegrationResponse.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnIntegrationResponse.Builder.

    • apiId

      @Stability(Stable) public CfnIntegrationResponse.Builder apiId(String apiId)
      The API identifier.

      Parameters:
      apiId - The API identifier. This parameter is required.
      Returns:
      this

    • integrationId

      @Stability(Stable) public CfnIntegrationResponse.Builder integrationId(String integrationId)
      The integration ID.

      Parameters:
      integrationId - The integration ID. This parameter is required.
      Returns:
      this

    • integrationResponseKey

      @Stability(Stable) public CfnIntegrationResponse.Builder integrationResponseKey(String integrationResponseKey)
      The integration response key.

      Parameters:
      integrationResponseKey - The integration response key. This parameter is required.
      Returns:
      this

    • contentHandlingStrategy

      @Stability(Stable) public CfnIntegrationResponse.Builder contentHandlingStrategy(String contentHandlingStrategy)
      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.

      Parameters:
      contentHandlingStrategy - Supported only for WebSocket APIs. This parameter is required.
      Returns:
      this

    • responseParameters

      @Stability(Stable) public CfnIntegrationResponse.Builder responseParameters(Object responseParameters)
      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.

      Parameters:
      responseParameters - A key-value map specifying response parameters that are passed to the method response from the backend. This parameter is required.
      Returns:
      this

    • responseTemplates

      @Stability(Stable) public CfnIntegrationResponse.Builder responseTemplates(Object responseTemplates)
      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.

      Parameters:
      responseTemplates - The collection of response templates for the integration response as a string-to-string map of key-value pairs. This parameter is required.
      Returns:
      this

    • templateSelectionExpression

      @Stability(Stable) public CfnIntegrationResponse.Builder templateSelectionExpression(String templateSelectionExpression)
      The template selection expression for the integration response.

      Supported only for WebSocket APIs.

      Parameters:
      templateSelectionExpression - The template selection expression for the integration response. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnIntegrationResponse build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnIntegrationResponse>
      Returns:
      a newly built instance of CfnIntegrationResponse.