AWS SDK for C++  1.8.126
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::Integration Class Reference

#include <Integration.h>

Public Member Functions

 Integration ()
 
 Integration (Aws::Utils::Json::JsonView jsonValue)
 
Integrationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const IntegrationTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const IntegrationType &value)
 
void SetType (IntegrationType &&value)
 
IntegrationWithType (const IntegrationType &value)
 
IntegrationWithType (IntegrationType &&value)
 
const Aws::StringGetHttpMethod () const
 
bool HttpMethodHasBeenSet () const
 
void SetHttpMethod (const Aws::String &value)
 
void SetHttpMethod (Aws::String &&value)
 
void SetHttpMethod (const char *value)
 
IntegrationWithHttpMethod (const Aws::String &value)
 
IntegrationWithHttpMethod (Aws::String &&value)
 
IntegrationWithHttpMethod (const char *value)
 
const Aws::StringGetUri () const
 
bool UriHasBeenSet () const
 
void SetUri (const Aws::String &value)
 
void SetUri (Aws::String &&value)
 
void SetUri (const char *value)
 
IntegrationWithUri (const Aws::String &value)
 
IntegrationWithUri (Aws::String &&value)
 
IntegrationWithUri (const char *value)
 
const ConnectionTypeGetConnectionType () const
 
bool ConnectionTypeHasBeenSet () const
 
void SetConnectionType (const ConnectionType &value)
 
void SetConnectionType (ConnectionType &&value)
 
IntegrationWithConnectionType (const ConnectionType &value)
 
IntegrationWithConnectionType (ConnectionType &&value)
 
const Aws::StringGetConnectionId () const
 
bool ConnectionIdHasBeenSet () const
 
void SetConnectionId (const Aws::String &value)
 
void SetConnectionId (Aws::String &&value)
 
void SetConnectionId (const char *value)
 
IntegrationWithConnectionId (const Aws::String &value)
 
IntegrationWithConnectionId (Aws::String &&value)
 
IntegrationWithConnectionId (const char *value)
 
const Aws::StringGetCredentials () const
 
bool CredentialsHasBeenSet () const
 
void SetCredentials (const Aws::String &value)
 
void SetCredentials (Aws::String &&value)
 
void SetCredentials (const char *value)
 
IntegrationWithCredentials (const Aws::String &value)
 
IntegrationWithCredentials (Aws::String &&value)
 
IntegrationWithCredentials (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetRequestParameters () const
 
bool RequestParametersHasBeenSet () const
 
void SetRequestParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRequestParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
IntegrationWithRequestParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
IntegrationWithRequestParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
IntegrationAddRequestParameters (const Aws::String &key, const Aws::String &value)
 
IntegrationAddRequestParameters (Aws::String &&key, const Aws::String &value)
 
IntegrationAddRequestParameters (const Aws::String &key, Aws::String &&value)
 
IntegrationAddRequestParameters (Aws::String &&key, Aws::String &&value)
 
IntegrationAddRequestParameters (const char *key, Aws::String &&value)
 
IntegrationAddRequestParameters (Aws::String &&key, const char *value)
 
IntegrationAddRequestParameters (const char *key, const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetRequestTemplates () const
 
bool RequestTemplatesHasBeenSet () const
 
void SetRequestTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRequestTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
IntegrationWithRequestTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
IntegrationWithRequestTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
IntegrationAddRequestTemplates (const Aws::String &key, const Aws::String &value)
 
IntegrationAddRequestTemplates (Aws::String &&key, const Aws::String &value)
 
IntegrationAddRequestTemplates (const Aws::String &key, Aws::String &&value)
 
IntegrationAddRequestTemplates (Aws::String &&key, Aws::String &&value)
 
IntegrationAddRequestTemplates (const char *key, Aws::String &&value)
 
IntegrationAddRequestTemplates (Aws::String &&key, const char *value)
 
IntegrationAddRequestTemplates (const char *key, const char *value)
 
const Aws::StringGetPassthroughBehavior () const
 
bool PassthroughBehaviorHasBeenSet () const
 
void SetPassthroughBehavior (const Aws::String &value)
 
void SetPassthroughBehavior (Aws::String &&value)
 
void SetPassthroughBehavior (const char *value)
 
IntegrationWithPassthroughBehavior (const Aws::String &value)
 
IntegrationWithPassthroughBehavior (Aws::String &&value)
 
IntegrationWithPassthroughBehavior (const char *value)
 
const ContentHandlingStrategyGetContentHandling () const
 
bool ContentHandlingHasBeenSet () const
 
void SetContentHandling (const ContentHandlingStrategy &value)
 
void SetContentHandling (ContentHandlingStrategy &&value)
 
IntegrationWithContentHandling (const ContentHandlingStrategy &value)
 
IntegrationWithContentHandling (ContentHandlingStrategy &&value)
 
int GetTimeoutInMillis () const
 
bool TimeoutInMillisHasBeenSet () const
 
void SetTimeoutInMillis (int value)
 
IntegrationWithTimeoutInMillis (int value)
 
const Aws::StringGetCacheNamespace () const
 
bool CacheNamespaceHasBeenSet () const
 
void SetCacheNamespace (const Aws::String &value)
 
void SetCacheNamespace (Aws::String &&value)
 
void SetCacheNamespace (const char *value)
 
IntegrationWithCacheNamespace (const Aws::String &value)
 
IntegrationWithCacheNamespace (Aws::String &&value)
 
IntegrationWithCacheNamespace (const char *value)
 
const Aws::Vector< Aws::String > & GetCacheKeyParameters () const
 
bool CacheKeyParametersHasBeenSet () const
 
void SetCacheKeyParameters (const Aws::Vector< Aws::String > &value)
 
void SetCacheKeyParameters (Aws::Vector< Aws::String > &&value)
 
IntegrationWithCacheKeyParameters (const Aws::Vector< Aws::String > &value)
 
IntegrationWithCacheKeyParameters (Aws::Vector< Aws::String > &&value)
 
IntegrationAddCacheKeyParameters (const Aws::String &value)
 
IntegrationAddCacheKeyParameters (Aws::String &&value)
 
IntegrationAddCacheKeyParameters (const char *value)
 
const Aws::Map< Aws::String, IntegrationResponse > & GetIntegrationResponses () const
 
bool IntegrationResponsesHasBeenSet () const
 
void SetIntegrationResponses (const Aws::Map< Aws::String, IntegrationResponse > &value)
 
void SetIntegrationResponses (Aws::Map< Aws::String, IntegrationResponse > &&value)
 
IntegrationWithIntegrationResponses (const Aws::Map< Aws::String, IntegrationResponse > &value)
 
IntegrationWithIntegrationResponses (Aws::Map< Aws::String, IntegrationResponse > &&value)
 
IntegrationAddIntegrationResponses (const Aws::String &key, const IntegrationResponse &value)
 
IntegrationAddIntegrationResponses (Aws::String &&key, const IntegrationResponse &value)
 
IntegrationAddIntegrationResponses (const Aws::String &key, IntegrationResponse &&value)
 
IntegrationAddIntegrationResponses (Aws::String &&key, IntegrationResponse &&value)
 
IntegrationAddIntegrationResponses (const char *key, IntegrationResponse &&value)
 
IntegrationAddIntegrationResponses (const char *key, const IntegrationResponse &value)
 
const TlsConfigGetTlsConfig () const
 
bool TlsConfigHasBeenSet () const
 
void SetTlsConfig (const TlsConfig &value)
 
void SetTlsConfig (TlsConfig &&value)
 
IntegrationWithTlsConfig (const TlsConfig &value)
 
IntegrationWithTlsConfig (TlsConfig &&value)
 

Detailed Description

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

In the API Gateway console, the built-in Lambda integration is an AWS integration.

See Also:

AWS API Reference

Definition at line 42 of file Integration.h.

Constructor & Destructor Documentation

◆ Integration() [1/2]

Aws::APIGateway::Model::Integration::Integration ( )

◆ Integration() [2/2]

Aws::APIGateway::Model::Integration::Integration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddCacheKeyParameters() [1/3]

Integration& Aws::APIGateway::Model::Integration::AddCacheKeyParameters ( Aws::String &&  value)
inline

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.

Definition at line 1383 of file Integration.h.

◆ AddCacheKeyParameters() [2/3]

Integration& Aws::APIGateway::Model::Integration::AddCacheKeyParameters ( const Aws::String value)
inline

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.

Definition at line 1376 of file Integration.h.

◆ AddCacheKeyParameters() [3/3]

Integration& Aws::APIGateway::Model::Integration::AddCacheKeyParameters ( const char *  value)
inline

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.

Definition at line 1390 of file Integration.h.

◆ AddIntegrationResponses() [1/6]

Integration& Aws::APIGateway::Model::Integration::AddIntegrationResponses ( Aws::String &&  key,
const IntegrationResponse value 
)
inline

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1615 of file Integration.h.

◆ AddIntegrationResponses() [2/6]

Integration& Aws::APIGateway::Model::Integration::AddIntegrationResponses ( Aws::String &&  key,
IntegrationResponse &&  value 
)
inline

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1671 of file Integration.h.

◆ AddIntegrationResponses() [3/6]

Integration& Aws::APIGateway::Model::Integration::AddIntegrationResponses ( const Aws::String key,
const IntegrationResponse value 
)
inline

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1587 of file Integration.h.

◆ AddIntegrationResponses() [4/6]

Integration& Aws::APIGateway::Model::Integration::AddIntegrationResponses ( const Aws::String key,
IntegrationResponse &&  value 
)
inline

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1643 of file Integration.h.

◆ AddIntegrationResponses() [5/6]

Integration& Aws::APIGateway::Model::Integration::AddIntegrationResponses ( const char *  key,
const IntegrationResponse value 
)
inline

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1727 of file Integration.h.

◆ AddIntegrationResponses() [6/6]

Integration& Aws::APIGateway::Model::Integration::AddIntegrationResponses ( const char *  key,
IntegrationResponse &&  value 
)
inline

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1699 of file Integration.h.

◆ AddRequestParameters() [1/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 825 of file Integration.h.

◆ AddRequestParameters() [2/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 801 of file Integration.h.

◆ AddRequestParameters() [3/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestParameters ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 849 of file Integration.h.

◆ AddRequestParameters() [4/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 813 of file Integration.h.

◆ AddRequestParameters() [5/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestParameters ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 789 of file Integration.h.

◆ AddRequestParameters() [6/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestParameters ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 837 of file Integration.h.

◆ AddRequestParameters() [7/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestParameters ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 861 of file Integration.h.

◆ AddRequestTemplates() [1/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestTemplates ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 942 of file Integration.h.

◆ AddRequestTemplates() [2/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestTemplates ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 926 of file Integration.h.

◆ AddRequestTemplates() [3/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestTemplates ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 958 of file Integration.h.

◆ AddRequestTemplates() [4/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestTemplates ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 934 of file Integration.h.

◆ AddRequestTemplates() [5/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestTemplates ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 918 of file Integration.h.

◆ AddRequestTemplates() [6/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestTemplates ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 950 of file Integration.h.

◆ AddRequestTemplates() [7/7]

Integration& Aws::APIGateway::Model::Integration::AddRequestTemplates ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 966 of file Integration.h.

◆ CacheKeyParametersHasBeenSet()

bool Aws::APIGateway::Model::Integration::CacheKeyParametersHasBeenSet ( ) const
inline

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.

Definition at line 1341 of file Integration.h.

◆ CacheNamespaceHasBeenSet()

bool Aws::APIGateway::Model::Integration::CacheNamespaceHasBeenSet ( ) const
inline

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.

Definition at line 1278 of file Integration.h.

◆ ConnectionIdHasBeenSet()

bool Aws::APIGateway::Model::Integration::ConnectionIdHasBeenSet ( ) const
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 575 of file Integration.h.

◆ ConnectionTypeHasBeenSet()

bool Aws::APIGateway::Model::Integration::ConnectionTypeHasBeenSet ( ) const
inline

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.

Definition at line 522 of file Integration.h.

◆ ContentHandlingHasBeenSet()

bool Aws::APIGateway::Model::Integration::ContentHandlingHasBeenSet ( ) const
inline

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.

Definition at line 1180 of file Integration.h.

◆ CredentialsHasBeenSet()

bool Aws::APIGateway::Model::Integration::CredentialsHasBeenSet ( ) const
inline

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.

Definition at line 644 of file Integration.h.

◆ GetCacheKeyParameters()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::Integration::GetCacheKeyParameters ( ) const
inline

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.

Definition at line 1334 of file Integration.h.

◆ GetCacheNamespace()

const Aws::String& Aws::APIGateway::Model::Integration::GetCacheNamespace ( ) const
inline

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.

Definition at line 1270 of file Integration.h.

◆ GetConnectionId()

const Aws::String& Aws::APIGateway::Model::Integration::GetConnectionId ( ) const
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 567 of file Integration.h.

◆ GetConnectionType()

const ConnectionType& Aws::APIGateway::Model::Integration::GetConnectionType ( ) const
inline

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.

Definition at line 513 of file Integration.h.

◆ GetContentHandling()

const ContentHandlingStrategy& Aws::APIGateway::Model::Integration::GetContentHandling ( ) const
inline

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.

Definition at line 1166 of file Integration.h.

◆ GetCredentials()

const Aws::String& Aws::APIGateway::Model::Integration::GetCredentials ( ) const
inline

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.

Definition at line 634 of file Integration.h.

◆ GetHttpMethod()

const Aws::String& Aws::APIGateway::Model::Integration::GetHttpMethod ( ) const
inline

Specifies the integration's HTTP method type.

Definition at line 211 of file Integration.h.

◆ GetIntegrationResponses()

const Aws::Map<Aws::String, IntegrationResponse>& Aws::APIGateway::Model::Integration::GetIntegrationResponses ( ) const
inline

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1419 of file Integration.h.

◆ GetPassthroughBehavior()

const Aws::String& Aws::APIGateway::Model::Integration::GetPassthroughBehavior ( ) const
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 990 of file Integration.h.

◆ GetRequestParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::Integration::GetRequestParameters ( ) const
inline

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.

Definition at line 717 of file Integration.h.

◆ GetRequestTemplates()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::Integration::GetRequestTemplates ( ) const
inline

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.

Definition at line 870 of file Integration.h.

◆ GetTimeoutInMillis()

int Aws::APIGateway::Model::Integration::GetTimeoutInMillis ( ) const
inline

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Definition at line 1243 of file Integration.h.

◆ GetTlsConfig()

const TlsConfig& Aws::APIGateway::Model::Integration::GetTlsConfig ( ) const
inline

Specifies the TLS configuration for an integration.

Definition at line 1733 of file Integration.h.

◆ GetType()

const IntegrationType& Aws::APIGateway::Model::Integration::GetType ( ) const
inline

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API 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.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

Definition at line 75 of file Integration.h.

◆ GetUri()

const Aws::String& Aws::APIGateway::Model::Integration::GetUri ( ) const
inline

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, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn: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 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 AWS service path-based API. The ensuing service_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 of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 279 of file Integration.h.

◆ HttpMethodHasBeenSet()

bool Aws::APIGateway::Model::Integration::HttpMethodHasBeenSet ( ) const
inline

Specifies the integration's HTTP method type.

Definition at line 216 of file Integration.h.

◆ IntegrationResponsesHasBeenSet()

bool Aws::APIGateway::Model::Integration::IntegrationResponsesHasBeenSet ( ) const
inline

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1447 of file Integration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::Integration::Jsonize ( ) const

◆ operator=()

Integration& Aws::APIGateway::Model::Integration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PassthroughBehaviorHasBeenSet()

bool Aws::APIGateway::Model::Integration::PassthroughBehaviorHasBeenSet ( ) const
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 1013 of file Integration.h.

◆ RequestParametersHasBeenSet()

bool Aws::APIGateway::Model::Integration::RequestParametersHasBeenSet ( ) const
inline

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.

Definition at line 729 of file Integration.h.

◆ RequestTemplatesHasBeenSet()

bool Aws::APIGateway::Model::Integration::RequestTemplatesHasBeenSet ( ) const
inline

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.

Definition at line 878 of file Integration.h.

◆ SetCacheKeyParameters() [1/2]

void Aws::APIGateway::Model::Integration::SetCacheKeyParameters ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 1355 of file Integration.h.

◆ SetCacheKeyParameters() [2/2]

void Aws::APIGateway::Model::Integration::SetCacheKeyParameters ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 1348 of file Integration.h.

◆ SetCacheNamespace() [1/3]

void Aws::APIGateway::Model::Integration::SetCacheNamespace ( Aws::String &&  value)
inline

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.

Definition at line 1294 of file Integration.h.

◆ SetCacheNamespace() [2/3]

void Aws::APIGateway::Model::Integration::SetCacheNamespace ( const Aws::String value)
inline

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.

Definition at line 1286 of file Integration.h.

◆ SetCacheNamespace() [3/3]

void Aws::APIGateway::Model::Integration::SetCacheNamespace ( const char *  value)
inline

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.

Definition at line 1302 of file Integration.h.

◆ SetConnectionId() [1/3]

void Aws::APIGateway::Model::Integration::SetConnectionId ( Aws::String &&  value)
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 591 of file Integration.h.

◆ SetConnectionId() [2/3]

void Aws::APIGateway::Model::Integration::SetConnectionId ( const Aws::String value)
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 583 of file Integration.h.

◆ SetConnectionId() [3/3]

void Aws::APIGateway::Model::Integration::SetConnectionId ( const char *  value)
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 599 of file Integration.h.

◆ SetConnectionType() [1/2]

void Aws::APIGateway::Model::Integration::SetConnectionType ( ConnectionType &&  value)
inline

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.

Definition at line 540 of file Integration.h.

◆ SetConnectionType() [2/2]

void Aws::APIGateway::Model::Integration::SetConnectionType ( const ConnectionType value)
inline

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.

Definition at line 531 of file Integration.h.

◆ SetContentHandling() [1/2]

void Aws::APIGateway::Model::Integration::SetContentHandling ( const ContentHandlingStrategy value)
inline

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.

Definition at line 1194 of file Integration.h.

◆ SetContentHandling() [2/2]

void Aws::APIGateway::Model::Integration::SetContentHandling ( ContentHandlingStrategy &&  value)
inline

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.

Definition at line 1208 of file Integration.h.

◆ SetCredentials() [1/3]

void Aws::APIGateway::Model::Integration::SetCredentials ( Aws::String &&  value)
inline

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.

Definition at line 664 of file Integration.h.

◆ SetCredentials() [2/3]

void Aws::APIGateway::Model::Integration::SetCredentials ( const Aws::String value)
inline

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.

Definition at line 654 of file Integration.h.

◆ SetCredentials() [3/3]

void Aws::APIGateway::Model::Integration::SetCredentials ( const char *  value)
inline

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.

Definition at line 674 of file Integration.h.

◆ SetHttpMethod() [1/3]

void Aws::APIGateway::Model::Integration::SetHttpMethod ( Aws::String &&  value)
inline

Specifies the integration's HTTP method type.

Definition at line 226 of file Integration.h.

◆ SetHttpMethod() [2/3]

void Aws::APIGateway::Model::Integration::SetHttpMethod ( const Aws::String value)
inline

Specifies the integration's HTTP method type.

Definition at line 221 of file Integration.h.

◆ SetHttpMethod() [3/3]

void Aws::APIGateway::Model::Integration::SetHttpMethod ( const char *  value)
inline

Specifies the integration's HTTP method type.

Definition at line 231 of file Integration.h.

◆ SetIntegrationResponses() [1/2]

void Aws::APIGateway::Model::Integration::SetIntegrationResponses ( Aws::Map< Aws::String, IntegrationResponse > &&  value)
inline

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1503 of file Integration.h.

◆ SetIntegrationResponses() [2/2]

void Aws::APIGateway::Model::Integration::SetIntegrationResponses ( const Aws::Map< Aws::String, IntegrationResponse > &  value)
inline

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1475 of file Integration.h.

◆ SetPassthroughBehavior() [1/3]

void Aws::APIGateway::Model::Integration::SetPassthroughBehavior ( Aws::String &&  value)
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 1059 of file Integration.h.

◆ SetPassthroughBehavior() [2/3]

void Aws::APIGateway::Model::Integration::SetPassthroughBehavior ( const Aws::String value)
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 1036 of file Integration.h.

◆ SetPassthroughBehavior() [3/3]

void Aws::APIGateway::Model::Integration::SetPassthroughBehavior ( const char *  value)
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 1082 of file Integration.h.

◆ SetRequestParameters() [1/2]

void Aws::APIGateway::Model::Integration::SetRequestParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 753 of file Integration.h.

◆ SetRequestParameters() [2/2]

void Aws::APIGateway::Model::Integration::SetRequestParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 741 of file Integration.h.

◆ SetRequestTemplates() [1/2]

void Aws::APIGateway::Model::Integration::SetRequestTemplates ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 894 of file Integration.h.

◆ SetRequestTemplates() [2/2]

void Aws::APIGateway::Model::Integration::SetRequestTemplates ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 886 of file Integration.h.

◆ SetTimeoutInMillis()

void Aws::APIGateway::Model::Integration::SetTimeoutInMillis ( int  value)
inline

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Definition at line 1255 of file Integration.h.

◆ SetTlsConfig() [1/2]

void Aws::APIGateway::Model::Integration::SetTlsConfig ( const TlsConfig value)
inline

Specifies the TLS configuration for an integration.

Definition at line 1743 of file Integration.h.

◆ SetTlsConfig() [2/2]

void Aws::APIGateway::Model::Integration::SetTlsConfig ( TlsConfig &&  value)
inline

Specifies the TLS configuration for an integration.

Definition at line 1748 of file Integration.h.

◆ SetType() [1/2]

void Aws::APIGateway::Model::Integration::SetType ( const IntegrationType value)
inline

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API 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.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

Definition at line 127 of file Integration.h.

◆ SetType() [2/2]

void Aws::APIGateway::Model::Integration::SetType ( IntegrationType &&  value)
inline

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API 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.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

Definition at line 153 of file Integration.h.

◆ SetUri() [1/3]

void Aws::APIGateway::Model::Integration::SetUri ( Aws::String &&  value)
inline

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, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn: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 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 AWS service path-based API. The ensuing service_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 of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 375 of file Integration.h.

◆ SetUri() [2/3]

void Aws::APIGateway::Model::Integration::SetUri ( const Aws::String value)
inline

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, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn: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 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 AWS service path-based API. The ensuing service_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 of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 343 of file Integration.h.

◆ SetUri() [3/3]

void Aws::APIGateway::Model::Integration::SetUri ( const char *  value)
inline

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, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn: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 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 AWS service path-based API. The ensuing service_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 of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 407 of file Integration.h.

◆ TimeoutInMillisHasBeenSet()

bool Aws::APIGateway::Model::Integration::TimeoutInMillisHasBeenSet ( ) const
inline

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Definition at line 1249 of file Integration.h.

◆ TlsConfigHasBeenSet()

bool Aws::APIGateway::Model::Integration::TlsConfigHasBeenSet ( ) const
inline

Specifies the TLS configuration for an integration.

Definition at line 1738 of file Integration.h.

◆ TypeHasBeenSet()

bool Aws::APIGateway::Model::Integration::TypeHasBeenSet ( ) const
inline

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API 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.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

Definition at line 101 of file Integration.h.

◆ UriHasBeenSet()

bool Aws::APIGateway::Model::Integration::UriHasBeenSet ( ) const
inline

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, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn: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 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 AWS service path-based API. The ensuing service_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 of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 311 of file Integration.h.

◆ WithCacheKeyParameters() [1/2]

Integration& Aws::APIGateway::Model::Integration::WithCacheKeyParameters ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 1369 of file Integration.h.

◆ WithCacheKeyParameters() [2/2]

Integration& Aws::APIGateway::Model::Integration::WithCacheKeyParameters ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 1362 of file Integration.h.

◆ WithCacheNamespace() [1/3]

Integration& Aws::APIGateway::Model::Integration::WithCacheNamespace ( Aws::String &&  value)
inline

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.

Definition at line 1318 of file Integration.h.

◆ WithCacheNamespace() [2/3]

Integration& Aws::APIGateway::Model::Integration::WithCacheNamespace ( const Aws::String value)
inline

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.

Definition at line 1310 of file Integration.h.

◆ WithCacheNamespace() [3/3]

Integration& Aws::APIGateway::Model::Integration::WithCacheNamespace ( const char *  value)
inline

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.

Definition at line 1326 of file Integration.h.

◆ WithConnectionId() [1/3]

Integration& Aws::APIGateway::Model::Integration::WithConnectionId ( Aws::String &&  value)
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 615 of file Integration.h.

◆ WithConnectionId() [2/3]

Integration& Aws::APIGateway::Model::Integration::WithConnectionId ( const Aws::String value)
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 607 of file Integration.h.

◆ WithConnectionId() [3/3]

Integration& Aws::APIGateway::Model::Integration::WithConnectionId ( const char *  value)
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 623 of file Integration.h.

◆ WithConnectionType() [1/2]

Integration& Aws::APIGateway::Model::Integration::WithConnectionType ( ConnectionType &&  value)
inline

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.

Definition at line 558 of file Integration.h.

◆ WithConnectionType() [2/2]

Integration& Aws::APIGateway::Model::Integration::WithConnectionType ( const ConnectionType value)
inline

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.

Definition at line 549 of file Integration.h.

◆ WithContentHandling() [1/2]

Integration& Aws::APIGateway::Model::Integration::WithContentHandling ( const ContentHandlingStrategy value)
inline

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.

Definition at line 1222 of file Integration.h.

◆ WithContentHandling() [2/2]

Integration& Aws::APIGateway::Model::Integration::WithContentHandling ( ContentHandlingStrategy &&  value)
inline

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.

Definition at line 1236 of file Integration.h.

◆ WithCredentials() [1/3]

Integration& Aws::APIGateway::Model::Integration::WithCredentials ( Aws::String &&  value)
inline

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.

Definition at line 694 of file Integration.h.

◆ WithCredentials() [2/3]

Integration& Aws::APIGateway::Model::Integration::WithCredentials ( const Aws::String value)
inline

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.

Definition at line 684 of file Integration.h.

◆ WithCredentials() [3/3]

Integration& Aws::APIGateway::Model::Integration::WithCredentials ( const char *  value)
inline

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.

Definition at line 704 of file Integration.h.

◆ WithHttpMethod() [1/3]

Integration& Aws::APIGateway::Model::Integration::WithHttpMethod ( Aws::String &&  value)
inline

Specifies the integration's HTTP method type.

Definition at line 241 of file Integration.h.

◆ WithHttpMethod() [2/3]

Integration& Aws::APIGateway::Model::Integration::WithHttpMethod ( const Aws::String value)
inline

Specifies the integration's HTTP method type.

Definition at line 236 of file Integration.h.

◆ WithHttpMethod() [3/3]

Integration& Aws::APIGateway::Model::Integration::WithHttpMethod ( const char *  value)
inline

Specifies the integration's HTTP method type.

Definition at line 246 of file Integration.h.

◆ WithIntegrationResponses() [1/2]

Integration& Aws::APIGateway::Model::Integration::WithIntegrationResponses ( Aws::Map< Aws::String, IntegrationResponse > &&  value)
inline

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1559 of file Integration.h.

◆ WithIntegrationResponses() [2/2]

Integration& Aws::APIGateway::Model::Integration::WithIntegrationResponses ( const Aws::Map< Aws::String, IntegrationResponse > &  value)
inline

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1531 of file Integration.h.

◆ WithPassthroughBehavior() [1/3]

Integration& Aws::APIGateway::Model::Integration::WithPassthroughBehavior ( Aws::String &&  value)
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 1128 of file Integration.h.

◆ WithPassthroughBehavior() [2/3]

Integration& Aws::APIGateway::Model::Integration::WithPassthroughBehavior ( const Aws::String value)
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 1105 of file Integration.h.

◆ WithPassthroughBehavior() [3/3]

Integration& Aws::APIGateway::Model::Integration::WithPassthroughBehavior ( const char *  value)
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 1151 of file Integration.h.

◆ WithRequestParameters() [1/2]

Integration& Aws::APIGateway::Model::Integration::WithRequestParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 777 of file Integration.h.

◆ WithRequestParameters() [2/2]

Integration& Aws::APIGateway::Model::Integration::WithRequestParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 765 of file Integration.h.

◆ WithRequestTemplates() [1/2]

Integration& Aws::APIGateway::Model::Integration::WithRequestTemplates ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 910 of file Integration.h.

◆ WithRequestTemplates() [2/2]

Integration& Aws::APIGateway::Model::Integration::WithRequestTemplates ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 902 of file Integration.h.

◆ WithTimeoutInMillis()

Integration& Aws::APIGateway::Model::Integration::WithTimeoutInMillis ( int  value)
inline

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Definition at line 1261 of file Integration.h.

◆ WithTlsConfig() [1/2]

Integration& Aws::APIGateway::Model::Integration::WithTlsConfig ( const TlsConfig value)
inline

Specifies the TLS configuration for an integration.

Definition at line 1753 of file Integration.h.

◆ WithTlsConfig() [2/2]

Integration& Aws::APIGateway::Model::Integration::WithTlsConfig ( TlsConfig &&  value)
inline

Specifies the TLS configuration for an integration.

Definition at line 1758 of file Integration.h.

◆ WithType() [1/2]

Integration& Aws::APIGateway::Model::Integration::WithType ( const IntegrationType value)
inline

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API 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.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

Definition at line 179 of file Integration.h.

◆ WithType() [2/2]

Integration& Aws::APIGateway::Model::Integration::WithType ( IntegrationType &&  value)
inline

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API 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.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

Definition at line 205 of file Integration.h.

◆ WithUri() [1/3]

Integration& Aws::APIGateway::Model::Integration::WithUri ( Aws::String &&  value)
inline

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, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn: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 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 AWS service path-based API. The ensuing service_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 of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 471 of file Integration.h.

◆ WithUri() [2/3]

Integration& Aws::APIGateway::Model::Integration::WithUri ( const Aws::String value)
inline

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, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn: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 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 AWS service path-based API. The ensuing service_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 of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 439 of file Integration.h.

◆ WithUri() [3/3]

Integration& Aws::APIGateway::Model::Integration::WithUri ( const char *  value)
inline

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, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn: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 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 AWS service path-based API. The ensuing service_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 of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 503 of file Integration.h.


The documentation for this class was generated from the following file: