class Aws::ApiGatewayV2::Types::UpdateIntegrationInput

Represents the input parameters for an UpdateIntegration request.

@!attribute [rw] connection_id

The ID of the VPC link for a private integration. Supported only for
HTTP APIs.
@return [String]

@!attribute [rw] connection_type

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.
@return [String]

@!attribute [rw] content_handling_strategy

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.
@return [String]

@!attribute [rw] credentials_arn

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, specify null.
@return [String]

@!attribute [rw] description

The description of the integration
@return [String]

@!attribute [rw] integration_method

Specifies the integration's HTTP method type.
@return [String]

@!attribute [rw] integration_subtype

Supported only for HTTP API AWS\_PROXY integrations. Specifies the
AWS service action to invoke. To learn more, see [Integration
subtype reference][1].

[1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html
@return [String]

@!attribute [rw] integration_type

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.
@return [String]

@!attribute [rw] integration_uri

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][1]. For private integrations, all
resources must be owned by the same AWS account.

[1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html
@return [String]

@!attribute [rw] passthrough_behavior

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.
@return [String]

@!attribute [rw] payload_format_version

Specifies the format of the payload sent to an integration. Required
for HTTP APIs.
@return [String]

@!attribute [rw] request_parameters

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][1].

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
<action>\:<header\|querystring\|path>.<location>
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][2].

[1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html
[2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.
@return [Hash<String,String>]

@!attribute [rw] response_parameters

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. Response
parameters are a key-value map. The key must match pattern
&lt;action&gt;\:&lt;header&gt;.&lt;location&gt; or
overwrite.statuscode. The action can be append, overwrite or remove.
The value can be a static value, or map to response data, stage
variables, or context variables that are evaluated at runtime. To
learn more, see [Transforming API requests and responses][1].

[1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
@return [Hash<String,Hash<String,String>>]

@!attribute [rw] request_templates

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.
@return [Hash<String,String>]

@!attribute [rw] template_selection_expression

The template selection expression for the integration.
@return [String]

@!attribute [rw] timeout_in_millis

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.
@return [Integer]

@!attribute [rw] tls_config

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.
@return [Types::TlsConfigInput]

Constants

SENSITIVE