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

#include <PutIntegrationRequest.h>

+ Inheritance diagram for Aws::APIGateway::Model::PutIntegrationRequest:

Public Member Functions

 PutIntegrationRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetRestApiId () const
 
bool RestApiIdHasBeenSet () const
 
void SetRestApiId (const Aws::String &value)
 
void SetRestApiId (Aws::String &&value)
 
void SetRestApiId (const char *value)
 
PutIntegrationRequestWithRestApiId (const Aws::String &value)
 
PutIntegrationRequestWithRestApiId (Aws::String &&value)
 
PutIntegrationRequestWithRestApiId (const char *value)
 
const Aws::StringGetResourceId () const
 
bool ResourceIdHasBeenSet () const
 
void SetResourceId (const Aws::String &value)
 
void SetResourceId (Aws::String &&value)
 
void SetResourceId (const char *value)
 
PutIntegrationRequestWithResourceId (const Aws::String &value)
 
PutIntegrationRequestWithResourceId (Aws::String &&value)
 
PutIntegrationRequestWithResourceId (const char *value)
 
const Aws::StringGetHttpMethod () const
 
bool HttpMethodHasBeenSet () const
 
void SetHttpMethod (const Aws::String &value)
 
void SetHttpMethod (Aws::String &&value)
 
void SetHttpMethod (const char *value)
 
PutIntegrationRequestWithHttpMethod (const Aws::String &value)
 
PutIntegrationRequestWithHttpMethod (Aws::String &&value)
 
PutIntegrationRequestWithHttpMethod (const char *value)
 
const IntegrationTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const IntegrationType &value)
 
void SetType (IntegrationType &&value)
 
PutIntegrationRequestWithType (const IntegrationType &value)
 
PutIntegrationRequestWithType (IntegrationType &&value)
 
const Aws::StringGetIntegrationHttpMethod () const
 
bool IntegrationHttpMethodHasBeenSet () const
 
void SetIntegrationHttpMethod (const Aws::String &value)
 
void SetIntegrationHttpMethod (Aws::String &&value)
 
void SetIntegrationHttpMethod (const char *value)
 
PutIntegrationRequestWithIntegrationHttpMethod (const Aws::String &value)
 
PutIntegrationRequestWithIntegrationHttpMethod (Aws::String &&value)
 
PutIntegrationRequestWithIntegrationHttpMethod (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)
 
PutIntegrationRequestWithUri (const Aws::String &value)
 
PutIntegrationRequestWithUri (Aws::String &&value)
 
PutIntegrationRequestWithUri (const char *value)
 
const ConnectionTypeGetConnectionType () const
 
bool ConnectionTypeHasBeenSet () const
 
void SetConnectionType (const ConnectionType &value)
 
void SetConnectionType (ConnectionType &&value)
 
PutIntegrationRequestWithConnectionType (const ConnectionType &value)
 
PutIntegrationRequestWithConnectionType (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)
 
PutIntegrationRequestWithConnectionId (const Aws::String &value)
 
PutIntegrationRequestWithConnectionId (Aws::String &&value)
 
PutIntegrationRequestWithConnectionId (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)
 
PutIntegrationRequestWithCredentials (const Aws::String &value)
 
PutIntegrationRequestWithCredentials (Aws::String &&value)
 
PutIntegrationRequestWithCredentials (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)
 
PutIntegrationRequestWithRequestParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
PutIntegrationRequestWithRequestParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
PutIntegrationRequestAddRequestParameters (const Aws::String &key, const Aws::String &value)
 
PutIntegrationRequestAddRequestParameters (Aws::String &&key, const Aws::String &value)
 
PutIntegrationRequestAddRequestParameters (const Aws::String &key, Aws::String &&value)
 
PutIntegrationRequestAddRequestParameters (Aws::String &&key, Aws::String &&value)
 
PutIntegrationRequestAddRequestParameters (const char *key, Aws::String &&value)
 
PutIntegrationRequestAddRequestParameters (Aws::String &&key, const char *value)
 
PutIntegrationRequestAddRequestParameters (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)
 
PutIntegrationRequestWithRequestTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
PutIntegrationRequestWithRequestTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
PutIntegrationRequestAddRequestTemplates (const Aws::String &key, const Aws::String &value)
 
PutIntegrationRequestAddRequestTemplates (Aws::String &&key, const Aws::String &value)
 
PutIntegrationRequestAddRequestTemplates (const Aws::String &key, Aws::String &&value)
 
PutIntegrationRequestAddRequestTemplates (Aws::String &&key, Aws::String &&value)
 
PutIntegrationRequestAddRequestTemplates (const char *key, Aws::String &&value)
 
PutIntegrationRequestAddRequestTemplates (Aws::String &&key, const char *value)
 
PutIntegrationRequestAddRequestTemplates (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)
 
PutIntegrationRequestWithPassthroughBehavior (const Aws::String &value)
 
PutIntegrationRequestWithPassthroughBehavior (Aws::String &&value)
 
PutIntegrationRequestWithPassthroughBehavior (const char *value)
 
const Aws::StringGetCacheNamespace () const
 
bool CacheNamespaceHasBeenSet () const
 
void SetCacheNamespace (const Aws::String &value)
 
void SetCacheNamespace (Aws::String &&value)
 
void SetCacheNamespace (const char *value)
 
PutIntegrationRequestWithCacheNamespace (const Aws::String &value)
 
PutIntegrationRequestWithCacheNamespace (Aws::String &&value)
 
PutIntegrationRequestWithCacheNamespace (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)
 
PutIntegrationRequestWithCacheKeyParameters (const Aws::Vector< Aws::String > &value)
 
PutIntegrationRequestWithCacheKeyParameters (Aws::Vector< Aws::String > &&value)
 
PutIntegrationRequestAddCacheKeyParameters (const Aws::String &value)
 
PutIntegrationRequestAddCacheKeyParameters (Aws::String &&value)
 
PutIntegrationRequestAddCacheKeyParameters (const char *value)
 
const ContentHandlingStrategyGetContentHandling () const
 
bool ContentHandlingHasBeenSet () const
 
void SetContentHandling (const ContentHandlingStrategy &value)
 
void SetContentHandling (ContentHandlingStrategy &&value)
 
PutIntegrationRequestWithContentHandling (const ContentHandlingStrategy &value)
 
PutIntegrationRequestWithContentHandling (ContentHandlingStrategy &&value)
 
int GetTimeoutInMillis () const
 
bool TimeoutInMillisHasBeenSet () const
 
void SetTimeoutInMillis (int value)
 
PutIntegrationRequestWithTimeoutInMillis (int value)
 
const TlsConfigGetTlsConfig () const
 
bool TlsConfigHasBeenSet () const
 
void SetTlsConfig (const TlsConfig &value)
 
void SetTlsConfig (TlsConfig &&value)
 
PutIntegrationRequestWithTlsConfig (const TlsConfig &value)
 
PutIntegrationRequestWithTlsConfig (TlsConfig &&value)
 
- Public Member Functions inherited from Aws::APIGateway::APIGatewayRequest
virtual ~APIGatewayRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::APIGateway::APIGatewayRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Sets up a method's integration.

See Also:

AWS API Reference

Definition at line 30 of file PutIntegrationRequest.h.

Constructor & Destructor Documentation

◆ PutIntegrationRequest()

Aws::APIGateway::Model::PutIntegrationRequest::PutIntegrationRequest ( )

Member Function Documentation

◆ AddCacheKeyParameters() [1/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 1183 of file PutIntegrationRequest.h.

◆ AddCacheKeyParameters() [2/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 1176 of file PutIntegrationRequest.h.

◆ AddCacheKeyParameters() [3/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 1190 of file PutIntegrationRequest.h.

◆ AddRequestParameters() [1/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 783 of file PutIntegrationRequest.h.

◆ AddRequestParameters() [2/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 759 of file PutIntegrationRequest.h.

◆ AddRequestParameters() [3/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 807 of file PutIntegrationRequest.h.

◆ AddRequestParameters() [4/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 771 of file PutIntegrationRequest.h.

◆ AddRequestParameters() [5/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 747 of file PutIntegrationRequest.h.

◆ AddRequestParameters() [6/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 795 of file PutIntegrationRequest.h.

◆ AddRequestParameters() [7/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 819 of file PutIntegrationRequest.h.

◆ AddRequestTemplates() [1/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 900 of file PutIntegrationRequest.h.

◆ AddRequestTemplates() [2/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 884 of file PutIntegrationRequest.h.

◆ AddRequestTemplates() [3/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 916 of file PutIntegrationRequest.h.

◆ AddRequestTemplates() [4/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 892 of file PutIntegrationRequest.h.

◆ AddRequestTemplates() [5/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 876 of file PutIntegrationRequest.h.

◆ AddRequestTemplates() [6/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 908 of file PutIntegrationRequest.h.

◆ AddRequestTemplates() [7/7]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 924 of file PutIntegrationRequest.h.

◆ CacheKeyParametersHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationRequest::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 1141 of file PutIntegrationRequest.h.

◆ CacheNamespaceHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationRequest::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 1078 of file PutIntegrationRequest.h.

◆ ConnectionIdHasBeenSet()

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

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

Definition at line 573 of file PutIntegrationRequest.h.

◆ ConnectionTypeHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationRequest::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 520 of file PutIntegrationRequest.h.

◆ ContentHandlingHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationRequest::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 1219 of file PutIntegrationRequest.h.

◆ CredentialsHasBeenSet()

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

Specifies whether credentials are required for a put integration.

Definition at line 632 of file PutIntegrationRequest.h.

◆ GetCacheKeyParameters()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::PutIntegrationRequest::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 1134 of file PutIntegrationRequest.h.

◆ GetCacheNamespace()

const Aws::String& Aws::APIGateway::Model::PutIntegrationRequest::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 1070 of file PutIntegrationRequest.h.

◆ GetConnectionId()

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

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

Definition at line 565 of file PutIntegrationRequest.h.

◆ GetConnectionType()

const ConnectionType& Aws::APIGateway::Model::PutIntegrationRequest::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 511 of file PutIntegrationRequest.h.

◆ GetContentHandling()

const ContentHandlingStrategy& Aws::APIGateway::Model::PutIntegrationRequest::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 1205 of file PutIntegrationRequest.h.

◆ GetCredentials()

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

Specifies whether credentials are required for a put integration.

Definition at line 627 of file PutIntegrationRequest.h.

◆ GetHttpMethod()

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

[Required] Specifies a put integration request's HTTP method.

Definition at line 129 of file PutIntegrationRequest.h.

◆ GetIntegrationHttpMethod()

const Aws::String& Aws::APIGateway::Model::PutIntegrationRequest::GetIntegrationHttpMethod ( ) const
inline

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

Definition at line 202 of file PutIntegrationRequest.h.

◆ GetPassthroughBehavior()

const Aws::String& Aws::APIGateway::Model::PutIntegrationRequest::GetPassthroughBehavior ( ) const
inline

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

Definition at line 942 of file PutIntegrationRequest.h.

◆ GetRequestParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::PutIntegrationRequest::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 675 of file PutIntegrationRequest.h.

◆ GetRequestTemplates()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::PutIntegrationRequest::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 828 of file PutIntegrationRequest.h.

◆ GetResourceId()

const Aws::String& Aws::APIGateway::Model::PutIntegrationRequest::GetResourceId ( ) const
inline

[Required] Specifies a put integration request's resource ID.

Definition at line 88 of file PutIntegrationRequest.h.

◆ GetRestApiId()

const Aws::String& Aws::APIGateway::Model::PutIntegrationRequest::GetRestApiId ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 47 of file PutIntegrationRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::APIGateway::Model::PutIntegrationRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file PutIntegrationRequest.h.

◆ GetTimeoutInMillis()

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

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

Definition at line 1282 of file PutIntegrationRequest.h.

◆ GetTlsConfig()

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

Definition at line 1304 of file PutIntegrationRequest.h.

◆ GetType()

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

[Required] Specifies a put integration input's type.

Definition at line 170 of file PutIntegrationRequest.h.

◆ GetUri()

const Aws::String& Aws::APIGateway::Model::PutIntegrationRequest::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 277 of file PutIntegrationRequest.h.

◆ HttpMethodHasBeenSet()

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

[Required] Specifies a put integration request's HTTP method.

Definition at line 134 of file PutIntegrationRequest.h.

◆ IntegrationHttpMethodHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationRequest::IntegrationHttpMethodHasBeenSet ( ) const
inline

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

Definition at line 208 of file PutIntegrationRequest.h.

◆ PassthroughBehaviorHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationRequest::PassthroughBehaviorHasBeenSet ( ) const
inline

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

Definition at line 959 of file PutIntegrationRequest.h.

◆ RequestParametersHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationRequest::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 687 of file PutIntegrationRequest.h.

◆ RequestTemplatesHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationRequest::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 836 of file PutIntegrationRequest.h.

◆ ResourceIdHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationRequest::ResourceIdHasBeenSet ( ) const
inline

[Required] Specifies a put integration request's resource ID.

Definition at line 93 of file PutIntegrationRequest.h.

◆ RestApiIdHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationRequest::RestApiIdHasBeenSet ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 52 of file PutIntegrationRequest.h.

◆ SerializePayload()

Aws::String Aws::APIGateway::Model::PutIntegrationRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCacheKeyParameters() [1/2]

void Aws::APIGateway::Model::PutIntegrationRequest::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 1155 of file PutIntegrationRequest.h.

◆ SetCacheKeyParameters() [2/2]

void Aws::APIGateway::Model::PutIntegrationRequest::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 1148 of file PutIntegrationRequest.h.

◆ SetCacheNamespace() [1/3]

void Aws::APIGateway::Model::PutIntegrationRequest::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 1094 of file PutIntegrationRequest.h.

◆ SetCacheNamespace() [2/3]

void Aws::APIGateway::Model::PutIntegrationRequest::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 1086 of file PutIntegrationRequest.h.

◆ SetCacheNamespace() [3/3]

void Aws::APIGateway::Model::PutIntegrationRequest::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 1102 of file PutIntegrationRequest.h.

◆ SetConnectionId() [1/3]

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

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

Definition at line 589 of file PutIntegrationRequest.h.

◆ SetConnectionId() [2/3]

void Aws::APIGateway::Model::PutIntegrationRequest::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 581 of file PutIntegrationRequest.h.

◆ SetConnectionId() [3/3]

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

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

Definition at line 597 of file PutIntegrationRequest.h.

◆ SetConnectionType() [1/2]

void Aws::APIGateway::Model::PutIntegrationRequest::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 538 of file PutIntegrationRequest.h.

◆ SetConnectionType() [2/2]

void Aws::APIGateway::Model::PutIntegrationRequest::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 529 of file PutIntegrationRequest.h.

◆ SetContentHandling() [1/2]

void Aws::APIGateway::Model::PutIntegrationRequest::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 1233 of file PutIntegrationRequest.h.

◆ SetContentHandling() [2/2]

void Aws::APIGateway::Model::PutIntegrationRequest::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 1247 of file PutIntegrationRequest.h.

◆ SetCredentials() [1/3]

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

Specifies whether credentials are required for a put integration.

Definition at line 642 of file PutIntegrationRequest.h.

◆ SetCredentials() [2/3]

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

Specifies whether credentials are required for a put integration.

Definition at line 637 of file PutIntegrationRequest.h.

◆ SetCredentials() [3/3]

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

Specifies whether credentials are required for a put integration.

Definition at line 647 of file PutIntegrationRequest.h.

◆ SetHttpMethod() [1/3]

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

[Required] Specifies a put integration request's HTTP method.

Definition at line 144 of file PutIntegrationRequest.h.

◆ SetHttpMethod() [2/3]

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

[Required] Specifies a put integration request's HTTP method.

Definition at line 139 of file PutIntegrationRequest.h.

◆ SetHttpMethod() [3/3]

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

[Required] Specifies a put integration request's HTTP method.

Definition at line 149 of file PutIntegrationRequest.h.

◆ SetIntegrationHttpMethod() [1/3]

void Aws::APIGateway::Model::PutIntegrationRequest::SetIntegrationHttpMethod ( Aws::String &&  value)
inline

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

Definition at line 220 of file PutIntegrationRequest.h.

◆ SetIntegrationHttpMethod() [2/3]

void Aws::APIGateway::Model::PutIntegrationRequest::SetIntegrationHttpMethod ( const Aws::String value)
inline

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

Definition at line 214 of file PutIntegrationRequest.h.

◆ SetIntegrationHttpMethod() [3/3]

void Aws::APIGateway::Model::PutIntegrationRequest::SetIntegrationHttpMethod ( const char *  value)
inline

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

Definition at line 226 of file PutIntegrationRequest.h.

◆ SetPassthroughBehavior() [1/3]

void Aws::APIGateway::Model::PutIntegrationRequest::SetPassthroughBehavior ( Aws::String &&  value)
inline

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

Definition at line 993 of file PutIntegrationRequest.h.

◆ SetPassthroughBehavior() [2/3]

void Aws::APIGateway::Model::PutIntegrationRequest::SetPassthroughBehavior ( const Aws::String value)
inline

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

Definition at line 976 of file PutIntegrationRequest.h.

◆ SetPassthroughBehavior() [3/3]

void Aws::APIGateway::Model::PutIntegrationRequest::SetPassthroughBehavior ( const char *  value)
inline

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

Definition at line 1010 of file PutIntegrationRequest.h.

◆ SetRequestParameters() [1/2]

void Aws::APIGateway::Model::PutIntegrationRequest::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 711 of file PutIntegrationRequest.h.

◆ SetRequestParameters() [2/2]

void Aws::APIGateway::Model::PutIntegrationRequest::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 699 of file PutIntegrationRequest.h.

◆ SetRequestTemplates() [1/2]

void Aws::APIGateway::Model::PutIntegrationRequest::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 852 of file PutIntegrationRequest.h.

◆ SetRequestTemplates() [2/2]

void Aws::APIGateway::Model::PutIntegrationRequest::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 844 of file PutIntegrationRequest.h.

◆ SetResourceId() [1/3]

void Aws::APIGateway::Model::PutIntegrationRequest::SetResourceId ( Aws::String &&  value)
inline

[Required] Specifies a put integration request's resource ID.

Definition at line 103 of file PutIntegrationRequest.h.

◆ SetResourceId() [2/3]

void Aws::APIGateway::Model::PutIntegrationRequest::SetResourceId ( const Aws::String value)
inline

[Required] Specifies a put integration request's resource ID.

Definition at line 98 of file PutIntegrationRequest.h.

◆ SetResourceId() [3/3]

void Aws::APIGateway::Model::PutIntegrationRequest::SetResourceId ( const char *  value)
inline

[Required] Specifies a put integration request's resource ID.

Definition at line 108 of file PutIntegrationRequest.h.

◆ SetRestApiId() [1/3]

void Aws::APIGateway::Model::PutIntegrationRequest::SetRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 62 of file PutIntegrationRequest.h.

◆ SetRestApiId() [2/3]

void Aws::APIGateway::Model::PutIntegrationRequest::SetRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 57 of file PutIntegrationRequest.h.

◆ SetRestApiId() [3/3]

void Aws::APIGateway::Model::PutIntegrationRequest::SetRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 67 of file PutIntegrationRequest.h.

◆ SetTimeoutInMillis()

void Aws::APIGateway::Model::PutIntegrationRequest::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 1294 of file PutIntegrationRequest.h.

◆ SetTlsConfig() [1/2]

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

Definition at line 1310 of file PutIntegrationRequest.h.

◆ SetTlsConfig() [2/2]

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

Definition at line 1313 of file PutIntegrationRequest.h.

◆ SetType() [1/2]

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

[Required] Specifies a put integration input's type.

Definition at line 180 of file PutIntegrationRequest.h.

◆ SetType() [2/2]

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

[Required] Specifies a put integration input's type.

Definition at line 185 of file PutIntegrationRequest.h.

◆ SetUri() [1/3]

void Aws::APIGateway::Model::PutIntegrationRequest::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 373 of file PutIntegrationRequest.h.

◆ SetUri() [2/3]

void Aws::APIGateway::Model::PutIntegrationRequest::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 341 of file PutIntegrationRequest.h.

◆ SetUri() [3/3]

void Aws::APIGateway::Model::PutIntegrationRequest::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 405 of file PutIntegrationRequest.h.

◆ TimeoutInMillisHasBeenSet()

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

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

Definition at line 1288 of file PutIntegrationRequest.h.

◆ TlsConfigHasBeenSet()

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

Definition at line 1307 of file PutIntegrationRequest.h.

◆ TypeHasBeenSet()

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

[Required] Specifies a put integration input's type.

Definition at line 175 of file PutIntegrationRequest.h.

◆ UriHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationRequest::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 309 of file PutIntegrationRequest.h.

◆ WithCacheKeyParameters() [1/2]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 1169 of file PutIntegrationRequest.h.

◆ WithCacheKeyParameters() [2/2]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 1162 of file PutIntegrationRequest.h.

◆ WithCacheNamespace() [1/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 1118 of file PutIntegrationRequest.h.

◆ WithCacheNamespace() [2/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 1110 of file PutIntegrationRequest.h.

◆ WithCacheNamespace() [3/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 1126 of file PutIntegrationRequest.h.

◆ WithConnectionId() [1/3]

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

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

Definition at line 613 of file PutIntegrationRequest.h.

◆ WithConnectionId() [2/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 605 of file PutIntegrationRequest.h.

◆ WithConnectionId() [3/3]

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

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

Definition at line 621 of file PutIntegrationRequest.h.

◆ WithConnectionType() [1/2]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 556 of file PutIntegrationRequest.h.

◆ WithConnectionType() [2/2]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 547 of file PutIntegrationRequest.h.

◆ WithContentHandling() [1/2]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 1261 of file PutIntegrationRequest.h.

◆ WithContentHandling() [2/2]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 1275 of file PutIntegrationRequest.h.

◆ WithCredentials() [1/3]

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

Specifies whether credentials are required for a put integration.

Definition at line 657 of file PutIntegrationRequest.h.

◆ WithCredentials() [2/3]

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

Specifies whether credentials are required for a put integration.

Definition at line 652 of file PutIntegrationRequest.h.

◆ WithCredentials() [3/3]

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

Specifies whether credentials are required for a put integration.

Definition at line 662 of file PutIntegrationRequest.h.

◆ WithHttpMethod() [1/3]

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

[Required] Specifies a put integration request's HTTP method.

Definition at line 159 of file PutIntegrationRequest.h.

◆ WithHttpMethod() [2/3]

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

[Required] Specifies a put integration request's HTTP method.

Definition at line 154 of file PutIntegrationRequest.h.

◆ WithHttpMethod() [3/3]

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

[Required] Specifies a put integration request's HTTP method.

Definition at line 164 of file PutIntegrationRequest.h.

◆ WithIntegrationHttpMethod() [1/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::WithIntegrationHttpMethod ( Aws::String &&  value)
inline

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

Definition at line 238 of file PutIntegrationRequest.h.

◆ WithIntegrationHttpMethod() [2/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::WithIntegrationHttpMethod ( const Aws::String value)
inline

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

Definition at line 232 of file PutIntegrationRequest.h.

◆ WithIntegrationHttpMethod() [3/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::WithIntegrationHttpMethod ( const char *  value)
inline

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

Definition at line 244 of file PutIntegrationRequest.h.

◆ WithPassthroughBehavior() [1/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::WithPassthroughBehavior ( Aws::String &&  value)
inline

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

Definition at line 1044 of file PutIntegrationRequest.h.

◆ WithPassthroughBehavior() [2/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::WithPassthroughBehavior ( const Aws::String value)
inline

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

Definition at line 1027 of file PutIntegrationRequest.h.

◆ WithPassthroughBehavior() [3/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::WithPassthroughBehavior ( const char *  value)
inline

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

Definition at line 1061 of file PutIntegrationRequest.h.

◆ WithRequestParameters() [1/2]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 735 of file PutIntegrationRequest.h.

◆ WithRequestParameters() [2/2]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 723 of file PutIntegrationRequest.h.

◆ WithRequestTemplates() [1/2]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 868 of file PutIntegrationRequest.h.

◆ WithRequestTemplates() [2/2]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 860 of file PutIntegrationRequest.h.

◆ WithResourceId() [1/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::WithResourceId ( Aws::String &&  value)
inline

[Required] Specifies a put integration request's resource ID.

Definition at line 118 of file PutIntegrationRequest.h.

◆ WithResourceId() [2/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::WithResourceId ( const Aws::String value)
inline

[Required] Specifies a put integration request's resource ID.

Definition at line 113 of file PutIntegrationRequest.h.

◆ WithResourceId() [3/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::WithResourceId ( const char *  value)
inline

[Required] Specifies a put integration request's resource ID.

Definition at line 123 of file PutIntegrationRequest.h.

◆ WithRestApiId() [1/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::WithRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 77 of file PutIntegrationRequest.h.

◆ WithRestApiId() [2/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::WithRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 72 of file PutIntegrationRequest.h.

◆ WithRestApiId() [3/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::WithRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 82 of file PutIntegrationRequest.h.

◆ WithTimeoutInMillis()

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 1300 of file PutIntegrationRequest.h.

◆ WithTlsConfig() [1/2]

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

Definition at line 1316 of file PutIntegrationRequest.h.

◆ WithTlsConfig() [2/2]

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

Definition at line 1319 of file PutIntegrationRequest.h.

◆ WithType() [1/2]

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

[Required] Specifies a put integration input's type.

Definition at line 190 of file PutIntegrationRequest.h.

◆ WithType() [2/2]

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

[Required] Specifies a put integration input's type.

Definition at line 195 of file PutIntegrationRequest.h.

◆ WithUri() [1/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 469 of file PutIntegrationRequest.h.

◆ WithUri() [2/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 437 of file PutIntegrationRequest.h.

◆ WithUri() [3/3]

PutIntegrationRequest& Aws::APIGateway::Model::PutIntegrationRequest::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 501 of file PutIntegrationRequest.h.


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