Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigatewayv2
  5. Integration

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigatewayv2.Integration

Explore with Pulumi AI

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

An example resource schema demonstrating some basic constructs and validation rules.

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[Mapping[str, str]] = None,
                request_templates: Optional[Mapping[str, str]] = None,
                response_parameters: Optional[Mapping[str, IntegrationResponseParameterMapArgs]] = 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 This property is required. string
The unique name of the resource.
args This property is required. IntegrationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. IntegrationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IntegrationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Integration resource accepts the following input properties:

ApiId This property is required. string
The API identifier.
IntegrationType This property is required. string
The integration type of an integration.
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.
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.
IntegrationSubtype string
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke.
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.
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.
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.
RequestParameters Dictionary<string, string>
A key-value map specifying parameters.
RequestTemplates Dictionary<string, string>
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.
ResponseParameters Dictionary<string, Pulumi.AwsNative.ApiGatewayV2.Inputs.IntegrationResponseParameterMapArgs>
Parameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs.
TemplateSelectionExpression string
The template selection expression for the integration. Supported only for WebSocket APIs.
TimeoutInMillis int
Custom timeout between 50 and 29000 milliseconds for WebSocket APIs and between 50 and 30000 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 This property is required. string
The API identifier.
IntegrationType This property is required. string
The integration type of an integration.
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.
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.
IntegrationSubtype string
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke.
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.
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.
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.
RequestParameters map[string]string
A key-value map specifying parameters.
RequestTemplates map[string]string
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.
ResponseParameters map[string]IntegrationResponseParameterMapArgs
Parameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs.
TemplateSelectionExpression string
The template selection expression for the integration. Supported only for WebSocket APIs.
TimeoutInMillis int
Custom timeout between 50 and 29000 milliseconds for WebSocket APIs and between 50 and 30000 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 This property is required. String
The API identifier.
integrationType This property is required. String
The integration type of an integration.
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.
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.
integrationSubtype String
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke.
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.
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.
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.
requestParameters Map<String,String>
A key-value map specifying parameters.
requestTemplates Map<String,String>
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.
responseParameters Map<String,IntegrationResponseParameterMapArgs>
Parameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs.
templateSelectionExpression String
The template selection expression for the integration. Supported only for WebSocket APIs.
timeoutInMillis Integer
Custom timeout between 50 and 29000 milliseconds for WebSocket APIs and between 50 and 30000 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 This property is required. string
The API identifier.
integrationType This property is required. string
The integration type of an integration.
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.
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.
integrationSubtype string
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke.
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.
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.
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.
requestParameters {[key: string]: string}
A key-value map specifying parameters.
requestTemplates {[key: string]: string}
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.
responseParameters {[key: string]: IntegrationResponseParameterMapArgs}
Parameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs.
templateSelectionExpression string
The template selection expression for the integration. Supported only for WebSocket APIs.
timeoutInMillis number
Custom timeout between 50 and 29000 milliseconds for WebSocket APIs and between 50 and 30000 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 This property is required. str
The API identifier.
integration_type This property is required. str
The integration type of an integration.
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.
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.
integration_subtype str
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke.
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.
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.
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.
request_parameters Mapping[str, str]
A key-value map specifying parameters.
request_templates Mapping[str, str]
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.
response_parameters Mapping[str, IntegrationResponseParameterMapArgs]
Parameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs.
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 29000 milliseconds for WebSocket APIs and between 50 and 30000 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 This property is required. String
The API identifier.
integrationType This property is required. String
The integration type of an integration.
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.
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.
integrationSubtype String
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke.
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.
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.
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.
requestParameters Map<String>
A key-value map specifying parameters.
requestTemplates Map<String>
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.
responseParameters Map<Property Map>
Parameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs.
templateSelectionExpression String
The template selection expression for the integration. Supported only for WebSocket APIs.
timeoutInMillis Number
Custom timeout between 50 and 29000 milliseconds for WebSocket APIs and between 50 and 30000 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:

Id string
The provider-assigned unique ID for this managed resource.
IntegrationId string
The integration ID.
Id string
The provider-assigned unique ID for this managed resource.
IntegrationId string
The integration ID.
id String
The provider-assigned unique ID for this managed resource.
integrationId String
The integration ID.
id string
The provider-assigned unique ID for this managed resource.
integrationId string
The integration ID.
id str
The provider-assigned unique ID for this managed resource.
integration_id str
The integration ID.
id String
The provider-assigned unique ID for this managed resource.
integrationId String
The integration ID.

Supporting Types

IntegrationResponseParameter
, IntegrationResponseParameterArgs

Destination string
Source string
Destination string
Source string
destination String
source String
destination string
source string
destination String
source String

IntegrationResponseParameterMap
, IntegrationResponseParameterMapArgs

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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native