Put Integration
apigateway_put_integration | R Documentation |
Sets up a method's integration¶
Description¶
Sets up a method's integration.
Usage¶
apigateway_put_integration(restApiId, resourceId, httpMethod, type,
integrationHttpMethod, uri, connectionType, connectionId, credentials,
requestParameters, requestTemplates, passthroughBehavior,
cacheNamespace, cacheKeyParameters, contentHandling, timeoutInMillis,
tlsConfig)
Arguments¶
restApiId
[required] The string identifier of the associated RestApi.
resourceId
[required] Specifies a put integration request's resource ID.
httpMethod
[required] Specifies the HTTP method for the integration.
type
[required] Specifies a put integration input's type.
integrationHttpMethod
The HTTP method for the integration.
uri
Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or
HTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, 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. ForAWS
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 Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={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 Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services 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}
.connectionType
The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.connectionId
The ID of the VpcLink used for the integration. Specify this value only if you specify
VPC_LINK
as the connection type.credentials
Specifies whether credentials are required for a put integration.
requestParameters
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}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.requestTemplates
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.
passthroughBehavior
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
, andNEVER
.cacheNamespace
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources.cacheKeyParameters
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
.contentHandling
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors: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.timeoutInMillis
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
tlsConfig
Value¶
A list with the following syntax:
list(
type = "HTTP"|"AWS"|"MOCK"|"HTTP_PROXY"|"AWS_PROXY",
httpMethod = "string",
uri = "string",
connectionType = "INTERNET"|"VPC_LINK",
connectionId = "string",
credentials = "string",
requestParameters = list(
"string"
),
requestTemplates = list(
"string"
),
passthroughBehavior = "string",
contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT",
timeoutInMillis = 123,
cacheNamespace = "string",
cacheKeyParameters = list(
"string"
),
integrationResponses = list(
list(
statusCode = "string",
selectionPattern = "string",
responseParameters = list(
"string"
),
responseTemplates = list(
"string"
),
contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT"
)
),
tlsConfig = list(
insecureSkipVerification = TRUE|FALSE
)
)
Request syntax¶
svc$put_integration(
restApiId = "string",
resourceId = "string",
httpMethod = "string",
type = "HTTP"|"AWS"|"MOCK"|"HTTP_PROXY"|"AWS_PROXY",
integrationHttpMethod = "string",
uri = "string",
connectionType = "INTERNET"|"VPC_LINK",
connectionId = "string",
credentials = "string",
requestParameters = list(
"string"
),
requestTemplates = list(
"string"
),
passthroughBehavior = "string",
cacheNamespace = "string",
cacheKeyParameters = list(
"string"
),
contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT",
timeoutInMillis = 123,
tlsConfig = list(
insecureSkipVerification = TRUE|FALSE
)
)