CfnIntegrationResponseProps

class aws_cdk.aws_apigatewayv2.CfnIntegrationResponseProps(*, api_id, integration_id, integration_response_key, content_handling_strategy=None, response_parameters=None, response_templates=None, template_selection_expression=None)

Bases: object

Properties for defining a CfnIntegrationResponse.

Parameters
  • api_id (str) – The API identifier.

  • integration_id (str) – The integration ID.

  • integration_response_key (str) – The integration response key.

  • content_handling_strategy (Optional[str]) – 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.

  • response_parameters (Optional[Any]) – 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.

  • response_templates (Optional[Any]) – 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.

  • template_selection_expression (Optional[str]) – The template selection expression for the integration response. Supported only for WebSocket APIs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2

# response_parameters: Any
# response_templates: Any

cfn_integration_response_props = apigatewayv2.CfnIntegrationResponseProps(
    api_id="apiId",
    integration_id="integrationId",
    integration_response_key="integrationResponseKey",

    # the properties below are optional
    content_handling_strategy="contentHandlingStrategy",
    response_parameters=response_parameters,
    response_templates=response_templates,
    template_selection_expression="templateSelectionExpression"
)

Attributes

api_id

The API identifier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-apiid

Return type

str

content_handling_strategy

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-contenthandlingstrategy

Return type

Optional[str]

integration_id

The integration ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationid

Return type

str

integration_response_key

The integration response key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationresponsekey

Return type

str

response_parameters

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responseparameters

Return type

Any

response_templates

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responsetemplates

Return type

Any

template_selection_expression

The template selection expression for the integration response.

Supported only for WebSocket APIs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-templateselectionexpression

Return type

Optional[str]