Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. apigatewayv2
  5. IntegrationResponse

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigatewayv2.IntegrationResponse

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an WebSocket API. For more information, see Set up WebSocket API Integration Responses in API Gateway in the API Gateway Developer Guide.

    Create IntegrationResponse Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IntegrationResponse(name: string, args: IntegrationResponseArgs, opts?: CustomResourceOptions);
    @overload
def IntegrationResponse(resource_name: str,
                        args: IntegrationResponseArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def IntegrationResponse(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        api_id: Optional[str] = None,
                        integration_id: Optional[str] = None,
                        integration_response_key: Optional[str] = None,
                        content_handling_strategy: Optional[str] = None,
                        response_parameters: Optional[Any] = None,
                        response_templates: Optional[Any] = None,
                        template_selection_expression: Optional[str] = None)
    func NewIntegrationResponse(ctx *Context, name string, args IntegrationResponseArgs, opts ...ResourceOption) (*IntegrationResponse, error)
    public IntegrationResponse(string name, IntegrationResponseArgs args, CustomResourceOptions? opts = null)
    public IntegrationResponse(String name, IntegrationResponseArgs args)
public IntegrationResponse(String name, IntegrationResponseArgs args, CustomResourceOptions options)

    type: aws-native:apigatewayv2:IntegrationResponse
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IntegrationResponseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IntegrationResponseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IntegrationResponseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationResponseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationResponseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    IntegrationResponse Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The IntegrationResponse resource accepts the following input properties:

    ApiId string
    The API identifier.
    IntegrationId string
    The integration ID.
    IntegrationResponseKey string
    The integration response key.
    ContentHandlingStrategy string
    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.
    ResponseParameters object

    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.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

    ResponseTemplates object

    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.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

    TemplateSelectionExpression string
    The template selection expression for the integration response. Supported only for WebSocket APIs.
    ApiId string
    The API identifier.
    IntegrationId string
    The integration ID.
    IntegrationResponseKey string
    The integration response key.
    ContentHandlingStrategy string
    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.
    ResponseParameters interface{}

    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.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

    ResponseTemplates interface{}

    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.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

    TemplateSelectionExpression string
    The template selection expression for the integration response. Supported only for WebSocket APIs.
    apiId String
    The API identifier.
    integrationId String
    The integration ID.
    integrationResponseKey String
    The integration response key.
    contentHandlingStrategy String
    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.
    responseParameters Object

    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.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

    responseTemplates Object

    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.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

    templateSelectionExpression String
    The template selection expression for the integration response. Supported only for WebSocket APIs.
    apiId string
    The API identifier.
    integrationId string
    The integration ID.
    integrationResponseKey string
    The integration response key.
    contentHandlingStrategy string
    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.
    responseParameters 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.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

    responseTemplates 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.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

    templateSelectionExpression string
    The template selection expression for the integration response. Supported only for WebSocket APIs.
    api_id str
    The API identifier.
    integration_id str
    The integration ID.
    integration_response_key str
    The integration response key.
    content_handling_strategy 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 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.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

    response_templates 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.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

    template_selection_expression str
    The template selection expression for the integration response. Supported only for WebSocket APIs.
    apiId String
    The API identifier.
    integrationId String
    The integration ID.
    integrationResponseKey String
    The integration response key.
    contentHandlingStrategy String
    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.
    responseParameters 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.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

    responseTemplates 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.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

    templateSelectionExpression String
    The template selection expression for the integration response. Supported only for WebSocket APIs.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IntegrationResponse resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IntegrationResponseId string
    The integration response ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    IntegrationResponseId string
    The integration response ID.
    id String
    The provider-assigned unique ID for this managed resource.
    integrationResponseId String
    The integration response ID.
    id string
    The provider-assigned unique ID for this managed resource.
    integrationResponseId string
    The integration response ID.
    id str
    The provider-assigned unique ID for this managed resource.
    integration_response_id str
    The integration response ID.
    id String
    The provider-assigned unique ID for this managed resource.
    integrationResponseId String
    The integration response ID.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native