class Aws::ApiGatewayV2::Types::UpdateIntegrationInput

@return [Types::TlsConfigInput]
protocol. Supported only for HTTP APIs.
TLS configuration, private integration traffic uses the HTTPS
The TLS configuration for a private integration. If you specify a
@!attribute [rw] tls_config
@return [Integer]
APIs.
timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP
and between 50 and 30,000 milliseconds for HTTP APIs. The default
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs
@!attribute [rw] timeout_in_millis
@return [String]
The template selection expression for the integration.
@!attribute [rw] template_selection_expression
@return [Hash<String,String>]
WebSocket APIs.
the template (as a String) is the value. Supported only for
by the client. The content type value is the key in this map, and
request payload based on the value of the Content-Type header sent
Represents a map of Velocity templates that are applied on the
@!attribute [rw] request_templates
@return [Hash<String,Hash<String,String>>]<br>: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html<br><br><br><br>learn more, see [Transforming API requests and responses].
variables, or context variables that are evaluated at runtime. To
The value can be a static value, or map to response data, stage
overwrite.statuscode. The action can be append, overwrite or remove.
&lt;action&gt;:&lt;header&gt;.&lt;location&gt; or
parameters are a key-value map. The key must match pattern
valid HTTP status code within the range of 200-599. Response
selection key to response parameters. The selection key must be a
returning the response to clients. Specify a key-value map from a
transform the HTTP response from a backend integration before
Supported only for HTTP APIs. You use response parameters to
@!attribute [rw] response_parameters
@return [Hash<String,String>]<br>: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.<br>[1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html<br><br><br><br>[Transforming API requests and responses].
context variables that are evaluated at runtime. To learn more, see
provide static values, or map request data, stage variables, or
where action can be append, overwrite or remove. For values, you can
&lt;action&gt;:&lt;header|querystring|path&gt;.&lt;location&gt;
follow the pattern
HTTP requests before sending them to the backend. The key should
request parameters are a key-value map specifying how to transform
For HTTP API integrations, without a specified integrationSubtype
service integrations for HTTP APIs].
that are evaluated at runtime. To learn more, see [Working with AWS
values, or map request data, stage variables, or context variables
are passed to AWS_PROXY integrations. You can provide static
request parameters are a key-value map specifying parameters that
For HTTP API integrations with a specified integrationSubtype,
must be a valid and unique method request parameter name.
*\{location\}* is querystring, path, or header; and *\{name\}*
method.request.*\{location\}.\{name\}* , where
method request parameter value must match the pattern of
within single quotes and pre-encoded as required by the backend. The
method request parameter value or static value that must be enclosed
an integration request parameter name and the associated value is a
that are passed from the method request to the backend. The key is
For WebSocket APIs, a key-value map specifying request parameters
@!attribute [rw] request_parameters
@return [String]
for HTTP APIs.
Specifies the format of the payload sent to an integration. Required
@!attribute [rw] payload_format_version
@return [String]
the same HTTP 415 Unsupported Media Type response.
content type defined, unmapped content types will be rejected with
content types mapped to templates. However, if there is at least one
WHEN_NO_TEMPLATES allows pass-through when the integration has no
Media Type response.
NEVER rejects unmapped content types with an HTTP 415 Unsupported
through to the integration backend without transformation.
WHEN_NO_MATCH passes the request body for unmapped content types
WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
Integration resource. There are three valid values: WHEN_NO_MATCH,
templates specified as the requestTemplates property on the
the Content-Type header in the request, and the available mapping
Specifies the pass-through behavior for incoming requests based on
@!attribute [rw] passthrough_behavior
@return [String]<br>: docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html<br><br><br><br>resources must be owned by the same AWS account.
more, see [DiscoverInstances]. For private integrations, all
You can use query parameters to target specific resources. To learn
service, API Gateway uses DiscoverInstances to identify resources.
or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map
Application Load Balancer listener, Network Load Balancer listener,
For an HTTP API private integration, specify the ARN of an
For an HTTP integration, specify a fully-qualified URL.
For a Lambda integration, specify the URI of a Lambda function.
@!attribute [rw] integration_uri
@return [String]
only for WebSocket APIs.
as a “loopback” endpoint without invoking any backend. Supported
MOCK: for integrating the route or method request with API Gateway
integrations, use an HTTP_PROXY integration.
also referred to as HTTP proxy integration. For HTTP API private
HTTP endpoint, with the client request passed through as-is. This is
HTTP_PROXY: for integrating the route or method request with an
integration. Supported only for WebSocket APIs.
endpoint. This integration is also referred to as the HTTP custom
HTTP: for integrating the route or method request with an HTTP
also referred to as a Lambda proxy integration.
Lambda function or other AWS service action. This integration is
AWS_PROXY: for integrating the route or method request with a
as AWS integration. Supported only for WebSocket APIs.
custom integration. With any other AWS service action, this is known
Lambda function-invoking action, this is referred to as the Lambda
action, including the Lambda function-invoking action. With the
AWS: for integrating the route or method request with an AWS service
The integration type of an integration. One of the following:
@!attribute [rw] integration_type
@return [String]<br>: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html<br><br><br><br>subtype reference].
AWS service action to invoke. To learn more, see [Integration
Supported only for HTTP API AWS_PROXY integrations. Specifies the
@!attribute [rw] integration_subtype
@return [String]
Specifies the integration’s HTTP method type.
@!attribute [rw] integration_method
@return [String]
The description of the integration
@!attribute [rw] description
@return [String]
resource-based permissions on supported AWS services, specify null.
the request, specify the string arn:aws:iam:::user/. To use
(ARN). To require that the caller’s identity be passed through from
Role for API Gateway to assume, use the role’s Amazon Resource Name
AWS integrations, three options are available. To specify an IAM
Specifies the credentials required for the integration, if any. For
@!attribute [rw] credentials_arn
@return [String]
method response without modification.
through from the integration response to the route response or
If this property is not defined, the response payload will be passed
a Base64-encoded string.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to
Base64-encoded string to the corresponding binary blob.
CONVERT_TO_BINARY: Converts a response payload from a
behaviors:
CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following
payload content type conversions. Supported values are
Supported only for WebSocket APIs. Specifies how to handle response
@!attribute [rw] content_handling_strategy
@return [String]
and resources in a VPC. The default value is INTERNET.
internet or VPC_LINK for private connections between API Gateway
Specify INTERNET for connections through the public routable
The type of the network connection to the integration endpoint.
@!attribute [rw] connection_type
@return [String]
HTTP APIs.
The ID of the VPC link for a private integration. Supported only for
@!attribute [rw] connection_id
Represents the input parameters for an UpdateIntegration request.