You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::PutIntegrationRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::PutIntegrationRequest
- Defined in:
- (unknown)
Overview
When passing PutIntegrationRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
rest_api_id: "String", # required
resource_id: "String", # required
http_method: "String", # required
type: "HTTP", # required, accepts HTTP, AWS, MOCK, HTTP_PROXY, AWS_PROXY
integration_http_method: "String",
uri: "String",
connection_type: "INTERNET", # accepts INTERNET, VPC_LINK
connection_id: "String",
credentials: "String",
request_parameters: {
"String" => "String",
},
request_templates: {
"String" => "String",
},
passthrough_behavior: "String",
cache_namespace: "String",
cache_key_parameters: ["String"],
content_handling: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
timeout_in_millis: 1,
tls_config: {
insecure_skip_verification: false,
},
}
Sets up a method's integration.
Instance Attribute Summary collapse
-
#cache_key_parameters ⇒ Array<String>
A list of request parameters whose values API Gateway caches.
-
#cache_namespace ⇒ String
Specifies a group of related cached parameters.
-
#connection_id ⇒ String
The ([
id
][1]) of the VpcLink used for the integration whenconnectionType=VPC_LINK
and undefined, otherwise. -
#connection_type ⇒ String
The type of the network connection to the integration endpoint.
-
#content_handling ⇒ String
Specifies how to handle request payload content type conversions.
-
#credentials ⇒ String
Specifies whether credentials are required for a put integration.
-
#http_method ⇒ String
[Required] Specifies a put integration request\'s HTTP method.
-
#integration_http_method ⇒ String
Specifies a put integration HTTP method.
-
#passthrough_behavior ⇒ 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. -
#request_parameters ⇒ Hash<String,String>
A key-value map specifying request parameters that are passed from the method request to the back end.
-
#request_templates ⇒ Hash<String,String>
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.
-
#resource_id ⇒ String
[Required] Specifies a put integration request\'s resource ID.
-
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
-
#timeout_in_millis ⇒ Integer
Custom timeout between 50 and 29,000 milliseconds.
-
#tls_config ⇒ Types::TlsConfig
-
#type ⇒ String
[Required] Specifies a put integration input\'s type.
-
#uri ⇒ String
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
Instance Attribute Details
#cache_key_parameters ⇒ Array<String>
A list of request parameters whose values API Gateway caches. To be
valid values for cacheKeyParameters
, these parameters must also be
specified for Method requestParameters
.
#cache_namespace ⇒ String
Specifies a group of related cached parameters. By default, API Gateway
uses the resource ID as the cacheNamespace
. You can specify the same
cacheNamespace
across resources to return the same cached data for
requests to different resources.
#connection_id ⇒ String
#connection_type ⇒ String
The type of the network connection to the integration endpoint. The
valid value is INTERNET
for connections through the public routable
internet or VPC_LINK
for private connections between API Gateway and a
network load balancer in a VPC. The default value is INTERNET
.
Possible values:
- INTERNET
- VPC_LINK
#content_handling ⇒ String
Specifies how to handle request payload content type conversions.
Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the
following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the corresponding binary blob.CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
If this property is not defined, the request payload will be passed
through from the method request to integration request without
modification, provided that the passthroughBehavior
is configured to
support payload pass-through.
Possible values:
- CONVERT_TO_BINARY
- CONVERT_TO_TEXT
#credentials ⇒ String
Specifies whether credentials are required for a put integration.
#http_method ⇒ String
[Required] Specifies a put integration request\'s HTTP method.
#integration_http_method ⇒ String
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
#passthrough_behavior ⇒ 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
.
WHEN_NO_MATCH
passes the request body for unmapped content types through to the integration back end 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 415 response.
#request_parameters ⇒ Hash<String,String>
A key-value map specifying request parameters that are passed from the
method request to the back end. 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 back end. 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.
#request_templates ⇒ Hash<String,String>
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.
#resource_id ⇒ String
[Required] Specifies a put integration request\'s resource ID.
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
#timeout_in_millis ⇒ Integer
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
#tls_config ⇒ Types::TlsConfig
#type ⇒ String
[Required] Specifies a put integration input\'s type.
Possible values:
- HTTP
- AWS
- MOCK
- HTTP_PROXY
- AWS_PROXY
#uri ⇒ String
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For
HTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specificationtarget="_blank", for either standard integration, whereconnectionType
is notVPC_LINK
, or private integration, whereconnectionType
isVPC_LINK
. For a private HTTP integration, the URI is not used for routing.For
AWS
orAWS_PROXY
integrations, the URI is of the formarn:aws:apigateway:`{region}:{subdomain.service|service}:path|action/{service_api}`
. Here,`{Region}`
is the API Gateway region (e.g.,us-east-1
);`{service}`
is the name of the integrated AWS service (e.g.,s3
); and`{subdomain}`
is a designated subdomain supported by certain AWS service for fast host-name lookup.action
can be used for an AWS service action-based API, using anAction=`{name}&{p1}={v1}&p2={v2}`...
query string. The ensuing`{service_api}`
refers to a supported action`{name}`
plus any required input parameters. Alternatively,path
can be used for an AWS service path-based API. The ensuingservice_api
refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API ofGetObject
, theuri
can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=`{bucket}&Key={key}`
orarn:aws:apigateway:us-west-2:s3:path/`{bucket}/{key}`