Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. apigatewayv2
  5. Integration

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigatewayv2.Integration

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::ApiGatewayV2::Integration

    Create Integration Resource

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

    Constructor syntax

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

@overload
def Integration(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                api_id: Optional[str] = None,
                integration_type: Optional[str] = None,
                credentials_arn: Optional[str] = None,
                integration_uri: Optional[str] = None,
                connection_type: Optional[str] = None,
                description: Optional[str] = None,
                integration_method: Optional[str] = None,
                integration_subtype: Optional[str] = None,
                connection_id: Optional[str] = None,
                content_handling_strategy: Optional[str] = None,
                passthrough_behavior: Optional[str] = None,
                payload_format_version: Optional[str] = None,
                request_parameters: Optional[Any] = None,
                request_templates: Optional[Any] = None,
                response_parameters: Optional[Any] = None,
                template_selection_expression: Optional[str] = None,
                timeout_in_millis: Optional[int] = None,
                tls_config: Optional[IntegrationTlsConfigArgs] = None)
    func NewIntegration(ctx *Context, name string, args IntegrationArgs, opts ...ResourceOption) (*Integration, error)
    public Integration(string name, IntegrationArgs args, CustomResourceOptions? opts = null)
    public Integration(String name, IntegrationArgs args)
public Integration(String name, IntegrationArgs args, CustomResourceOptions options)

    type: aws-native:apigatewayv2:Integration
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 IntegrationArgs
    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 IntegrationArgs
    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 IntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Integration 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 Integration resource accepts the following input properties:

    ApiId string
    The API identifier.
    IntegrationType string

    The integration type of an integration. One of the following:

    AWS : for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

    AWS_PROXY : for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

    HTTP : for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

    HTTP_PROXY : for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

    MOCK : for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

    ConnectionId string
    The ID of the VPC link for a private integration. Supported only for HTTP APIs.
    ConnectionType string
    The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET .
    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.

    CredentialsArn string
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/* . To use resource-based permissions on supported AWS services, don't specify this parameter.
    Description string
    The description of the integration.
    IntegrationMethod string
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .
    IntegrationSubtype string
    Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference .
    IntegrationUri string

    For a Lambda integration, specify the URI of a Lambda function.

    For an HTTP integration, specify a fully-qualified URL.

    For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances . For private integrations, all resources must be owned by the same AWS account .

    PassthroughBehavior string

    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . Supported only for WebSocket APIs.

    WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

    NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

    WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

    PayloadFormatVersion string
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .
    RequestParameters object

    For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request. {location} . {name} , where {location} is querystring , path , or header ; and {name} must be a valid and unique method request parameter name.

    For HTTP API integrations with a specified integrationSubtype , request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs .

    For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern :<header|querystring|path>. where action can be append , overwrite or remove . For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

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

    RequestTemplates object

    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

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

    ResponseParameters object

    Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. The value is of type ResponseParameterList . To learn more, see Transforming API requests and responses .

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

    TemplateSelectionExpression string
    The template selection expression for the integration. Supported only for WebSocket APIs.
    TimeoutInMillis int
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
    TlsConfig Pulumi.AwsNative.ApiGatewayV2.Inputs.IntegrationTlsConfig
    The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
    ApiId string
    The API identifier.
    IntegrationType string

    The integration type of an integration. One of the following:

    AWS : for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

    AWS_PROXY : for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

    HTTP : for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

    HTTP_PROXY : for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

    MOCK : for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

    ConnectionId string
    The ID of the VPC link for a private integration. Supported only for HTTP APIs.
    ConnectionType string
    The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET .
    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.

    CredentialsArn string
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/* . To use resource-based permissions on supported AWS services, don't specify this parameter.
    Description string
    The description of the integration.
    IntegrationMethod string
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .
    IntegrationSubtype string
    Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference .
    IntegrationUri string

    For a Lambda integration, specify the URI of a Lambda function.

    For an HTTP integration, specify a fully-qualified URL.

    For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances . For private integrations, all resources must be owned by the same AWS account .

    PassthroughBehavior string

    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . Supported only for WebSocket APIs.

    WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

    NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

    WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

    PayloadFormatVersion string
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .
    RequestParameters interface{}

    For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request. {location} . {name} , where {location} is querystring , path , or header ; and {name} must be a valid and unique method request parameter name.

    For HTTP API integrations with a specified integrationSubtype , request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs .

    For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern :<header|querystring|path>. where action can be append , overwrite or remove . For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

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

    RequestTemplates interface{}

    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

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

    ResponseParameters interface{}

    Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. The value is of type ResponseParameterList . To learn more, see Transforming API requests and responses .

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

    TemplateSelectionExpression string
    The template selection expression for the integration. Supported only for WebSocket APIs.
    TimeoutInMillis int
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
    TlsConfig IntegrationTlsConfigArgs
    The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
    apiId String
    The API identifier.
    integrationType String

    The integration type of an integration. One of the following:

    AWS : for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

    AWS_PROXY : for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

    HTTP : for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

    HTTP_PROXY : for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

    MOCK : for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

    connectionId String
    The ID of the VPC link for a private integration. Supported only for HTTP APIs.
    connectionType String
    The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET .
    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.

    credentialsArn String
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/* . To use resource-based permissions on supported AWS services, don't specify this parameter.
    description String
    The description of the integration.
    integrationMethod String
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .
    integrationSubtype String
    Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference .
    integrationUri String

    For a Lambda integration, specify the URI of a Lambda function.

    For an HTTP integration, specify a fully-qualified URL.

    For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances . For private integrations, all resources must be owned by the same AWS account .

    passthroughBehavior String

    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . Supported only for WebSocket APIs.

    WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

    NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

    WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

    payloadFormatVersion String
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .
    requestParameters Object

    For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request. {location} . {name} , where {location} is querystring , path , or header ; and {name} must be a valid and unique method request parameter name.

    For HTTP API integrations with a specified integrationSubtype , request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs .

    For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern :<header|querystring|path>. where action can be append , overwrite or remove . For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

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

    requestTemplates Object

    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

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

    responseParameters Object

    Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. The value is of type ResponseParameterList . To learn more, see Transforming API requests and responses .

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

    templateSelectionExpression String
    The template selection expression for the integration. Supported only for WebSocket APIs.
    timeoutInMillis Integer
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
    tlsConfig IntegrationTlsConfig
    The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
    apiId string
    The API identifier.
    integrationType string

    The integration type of an integration. One of the following:

    AWS : for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

    AWS_PROXY : for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

    HTTP : for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

    HTTP_PROXY : for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

    MOCK : for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

    connectionId string
    The ID of the VPC link for a private integration. Supported only for HTTP APIs.
    connectionType string
    The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET .
    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.

    credentialsArn string
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/* . To use resource-based permissions on supported AWS services, don't specify this parameter.
    description string
    The description of the integration.
    integrationMethod string
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .
    integrationSubtype string
    Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference .
    integrationUri string

    For a Lambda integration, specify the URI of a Lambda function.

    For an HTTP integration, specify a fully-qualified URL.

    For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances . For private integrations, all resources must be owned by the same AWS account .

    passthroughBehavior string

    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . Supported only for WebSocket APIs.

    WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

    NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

    WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

    payloadFormatVersion string
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .
    requestParameters any

    For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request. {location} . {name} , where {location} is querystring , path , or header ; and {name} must be a valid and unique method request parameter name.

    For HTTP API integrations with a specified integrationSubtype , request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs .

    For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern :<header|querystring|path>. where action can be append , overwrite or remove . For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

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

    requestTemplates any

    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

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

    responseParameters any

    Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. The value is of type ResponseParameterList . To learn more, see Transforming API requests and responses .

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

    templateSelectionExpression string
    The template selection expression for the integration. Supported only for WebSocket APIs.
    timeoutInMillis number
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
    tlsConfig IntegrationTlsConfig
    The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
    api_id str
    The API identifier.
    integration_type str

    The integration type of an integration. One of the following:

    AWS : for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

    AWS_PROXY : for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

    HTTP : for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

    HTTP_PROXY : for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

    MOCK : for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

    connection_id str
    The ID of the VPC link for a private integration. Supported only for HTTP APIs.
    connection_type str
    The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET .
    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.

    credentials_arn str
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/* . To use resource-based permissions on supported AWS services, don't specify this parameter.
    description str
    The description of the integration.
    integration_method str
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .
    integration_subtype str
    Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference .
    integration_uri str

    For a Lambda integration, specify the URI of a Lambda function.

    For an HTTP integration, specify a fully-qualified URL.

    For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances . For private integrations, all resources must be owned by the same AWS account .

    passthrough_behavior str

    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . Supported only for WebSocket APIs.

    WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

    NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

    WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

    payload_format_version str
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .
    request_parameters Any

    For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request. {location} . {name} , where {location} is querystring , path , or header ; and {name} must be a valid and unique method request parameter name.

    For HTTP API integrations with a specified integrationSubtype , request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs .

    For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern :<header|querystring|path>. where action can be append , overwrite or remove . For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

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

    request_templates Any

    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

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

    response_parameters Any

    Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. The value is of type ResponseParameterList . To learn more, see Transforming API requests and responses .

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

    template_selection_expression str
    The template selection expression for the integration. Supported only for WebSocket APIs.
    timeout_in_millis int
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
    tls_config IntegrationTlsConfigArgs
    The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
    apiId String
    The API identifier.
    integrationType String

    The integration type of an integration. One of the following:

    AWS : for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

    AWS_PROXY : for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

    HTTP : for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

    HTTP_PROXY : for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

    MOCK : for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

    connectionId String
    The ID of the VPC link for a private integration. Supported only for HTTP APIs.
    connectionType String
    The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET .
    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.

    credentialsArn String
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/* . To use resource-based permissions on supported AWS services, don't specify this parameter.
    description String
    The description of the integration.
    integrationMethod String
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .
    integrationSubtype String
    Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference .
    integrationUri String

    For a Lambda integration, specify the URI of a Lambda function.

    For an HTTP integration, specify a fully-qualified URL.

    For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances . For private integrations, all resources must be owned by the same AWS account .

    passthroughBehavior String

    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . Supported only for WebSocket APIs.

    WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

    NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

    WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

    payloadFormatVersion String
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .
    requestParameters Any

    For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request. {location} . {name} , where {location} is querystring , path , or header ; and {name} must be a valid and unique method request parameter name.

    For HTTP API integrations with a specified integrationSubtype , request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs .

    For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern :<header|querystring|path>. where action can be append , overwrite or remove . For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

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

    requestTemplates Any

    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

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

    responseParameters Any

    Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. The value is of type ResponseParameterList . To learn more, see Transforming API requests and responses .

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

    templateSelectionExpression String
    The template selection expression for the integration. Supported only for WebSocket APIs.
    timeoutInMillis Number
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
    tlsConfig Property Map
    The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

    Outputs

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

    AwsId string
    The identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    The identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    The identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    The identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    The identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    The identifier.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    IntegrationTlsConfig, IntegrationTlsConfigArgs

    ServerNameToVerify string
    If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
    ServerNameToVerify string
    If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
    serverNameToVerify String
    If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
    serverNameToVerify string
    If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
    server_name_to_verify str
    If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
    serverNameToVerify String
    If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native