pulumi-aws-native-kotlin/com.pulumi.awsnative.apigatewayv2.kotlin/IntegrationArgs

IntegrationArgs

data class IntegrationArgs(val apiId: Output<String>? = null, val connectionId: Output<String>? = null, val connectionType: Output<String>? = null, val contentHandlingStrategy: Output<String>? = null, val credentialsArn: Output<String>? = null, val description: Output<String>? = null, val integrationMethod: Output<String>? = null, val integrationSubtype: Output<String>? = null, val integrationType: Output<String>? = null, val integrationUri: Output<String>? = null, val passthroughBehavior: Output<String>? = null, val payloadFormatVersion: Output<String>? = null, val requestParameters: Output<Map<String, String>>? = null, val requestTemplates: Output<Map<String, String>>? = null, val responseParameters: Output<Map<String, IntegrationResponseParameterMapArgs>>? = null, val templateSelectionExpression: Output<String>? = null, val timeoutInMillis: Output<Int>? = null, val tlsConfig: Output<IntegrationTlsConfigArgs>? = null) : ConvertibleToJava<IntegrationArgs>

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

Constructors

IntegrationArgs

constructor(apiId: Output<String>? = null, connectionId: Output<String>? = null, connectionType: Output<String>? = null, contentHandlingStrategy: Output<String>? = null, credentialsArn: Output<String>? = null, description: Output<String>? = null, integrationMethod: Output<String>? = null, integrationSubtype: Output<String>? = null, integrationType: Output<String>? = null, integrationUri: Output<String>? = null, passthroughBehavior: Output<String>? = null, payloadFormatVersion: Output<String>? = null, requestParameters: Output<Map<String, String>>? = null, requestTemplates: Output<Map<String, String>>? = null, responseParameters: Output<Map<String, IntegrationResponseParameterMapArgs>>? = null, templateSelectionExpression: Output<String>? = null, timeoutInMillis: Output<Int>? = null, tlsConfig: Output<IntegrationTlsConfigArgs>? = null)

Properties

apiId

val apiId: Output<String>? = null

The API identifier.

connectionId

val connectionId: Output<String>? = null

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

connectionType

val connectionType: Output<String>? = null

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

val contentHandlingStrategy: Output<String>? = null

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

val credentialsArn: Output<String>? = null

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

val description: Output<String>? = null

The description of the integration.

integrationMethod

val integrationMethod: Output<String>? = null

Specifies the integration's HTTP method type.

integrationSubtype

val integrationSubtype: Output<String>? = null

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke.

integrationType

val integrationType: Output<String>? = null

The integration type of an integration.

integrationUri

val integrationUri: Output<String>? = null

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

val passthroughBehavior: Output<String>? = null

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

val payloadFormatVersion: Output<String>? = null

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

val requestParameters: Output<Map<String, String>>? = null

A key-value map specifying parameters.

requestTemplates

val requestTemplates: Output<Map<String, String>>? = null

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

val responseParameters: Output<Map<String, IntegrationResponseParameterMapArgs>>? = null

Parameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs.

templateSelectionExpression

val templateSelectionExpression: Output<String>? = null

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

timeoutInMillis

val timeoutInMillis: Output<Int>? = null

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

val tlsConfig: Output<IntegrationTlsConfigArgs>? = null

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. */

Functions

toJava

open override fun toJava(): IntegrationArgs