AWS Cloud Control v1.27.0, Apr 14 25

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.apigatewayv2.getIntegration

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Using getIntegration

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getIntegration(args: GetIntegrationArgs, opts?: InvokeOptions): Promise<GetIntegrationResult>
function getIntegrationOutput(args: GetIntegrationOutputArgs, opts?: InvokeOptions): Output<GetIntegrationResult>

def get_integration(api_id: Optional[str] = None,
                    integration_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetIntegrationResult
def get_integration_output(api_id: Optional[pulumi.Input[str]] = None,
                    integration_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetIntegrationResult]

func LookupIntegration(ctx *Context, args *LookupIntegrationArgs, opts ...InvokeOption) (*LookupIntegrationResult, error)
func LookupIntegrationOutput(ctx *Context, args *LookupIntegrationOutputArgs, opts ...InvokeOption) LookupIntegrationResultOutput

> Note: This function is named LookupIntegration in the Go SDK.

public static class GetIntegration 
{
    public static Task<GetIntegrationResult> InvokeAsync(GetIntegrationArgs args, InvokeOptions? opts = null)
    public static Output<GetIntegrationResult> Invoke(GetIntegrationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIntegrationResult> getIntegration(GetIntegrationArgs args, InvokeOptions options)
public static Output<GetIntegrationResult> getIntegration(GetIntegrationArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:apigatewayv2:getIntegration
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiId string: The API identifier.
IntegrationId string: The integration ID.

ApiId string: The API identifier.
IntegrationId string: The integration ID.

apiId String: The API identifier.
integrationId String: The integration ID.

apiId string: The API identifier.
integrationId string: The integration ID.

api_id str: The API identifier.
integration_id str: The integration ID.

apiId String: The API identifier.
integrationId String: The integration ID.

getIntegration Result

The following output properties are available:

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.
IntegrationId string: The integration ID.
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.
IntegrationType string: The integration type of an integration.
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.Outputs.IntegrationResponseParameterMap>: 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.Outputs.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.

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.
IntegrationId string: The integration ID.
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.
IntegrationType string: The integration type of an integration.
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]IntegrationResponseParameterMap: 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 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.

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.
integrationId String: The integration ID.
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.
integrationType String: The integration type of an integration.
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,IntegrationResponseParameterMap>: 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.

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.
integrationId string: The integration ID.
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.
integrationType string: The integration type of an integration.
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]: IntegrationResponseParameterMap}: 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.

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_id str: The integration ID.
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_type str: The integration type of an integration.
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, IntegrationResponseParameterMap]: 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 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.

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.
integrationId String: The integration ID.
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.
integrationType String: The integration type of an integration.
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.

Supporting Types

IntegrationResponseParameter

Destination string
Source string

Destination string
Source string

destination String
source String

destination string
source string

destination str
source str

destination String
source String

IntegrationResponseParameterMap

ResponseParameters List<Pulumi.AwsNative.ApiGatewayV2.Inputs.IntegrationResponseParameter>

ResponseParameters []IntegrationResponseParameter

responseParameters List<IntegrationResponseParameter>

responseParameters IntegrationResponseParameter[]

response_parameters Sequence[IntegrationResponseParameter]

responseParameters List<Property Map>

IntegrationTlsConfig

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.27.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.apigatewayv2.getIntegration

On this page

On this page

Using getIntegration

getIntegration Result

Supporting Types

IntegrationResponseParameter

IntegrationResponseParameterMap

IntegrationTlsConfig

Package Details

On this page

On this page