AWS SDK for C++  1.8.76
AWS SDK for C++
Public Member Functions | List of all members
Aws::ApiGatewayV2::Model::UpdateIntegrationRequest Class Reference

#include <UpdateIntegrationRequest.h>

+ Inheritance diagram for Aws::ApiGatewayV2::Model::UpdateIntegrationRequest:

Public Member Functions

 UpdateIntegrationRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetApiId () const
 
bool ApiIdHasBeenSet () const
 
void SetApiId (const Aws::String &value)
 
void SetApiId (Aws::String &&value)
 
void SetApiId (const char *value)
 
UpdateIntegrationRequestWithApiId (const Aws::String &value)
 
UpdateIntegrationRequestWithApiId (Aws::String &&value)
 
UpdateIntegrationRequestWithApiId (const char *value)
 
const Aws::StringGetConnectionId () const
 
bool ConnectionIdHasBeenSet () const
 
void SetConnectionId (const Aws::String &value)
 
void SetConnectionId (Aws::String &&value)
 
void SetConnectionId (const char *value)
 
UpdateIntegrationRequestWithConnectionId (const Aws::String &value)
 
UpdateIntegrationRequestWithConnectionId (Aws::String &&value)
 
UpdateIntegrationRequestWithConnectionId (const char *value)
 
const ConnectionTypeGetConnectionType () const
 
bool ConnectionTypeHasBeenSet () const
 
void SetConnectionType (const ConnectionType &value)
 
void SetConnectionType (ConnectionType &&value)
 
UpdateIntegrationRequestWithConnectionType (const ConnectionType &value)
 
UpdateIntegrationRequestWithConnectionType (ConnectionType &&value)
 
const ContentHandlingStrategyGetContentHandlingStrategy () const
 
bool ContentHandlingStrategyHasBeenSet () const
 
void SetContentHandlingStrategy (const ContentHandlingStrategy &value)
 
void SetContentHandlingStrategy (ContentHandlingStrategy &&value)
 
UpdateIntegrationRequestWithContentHandlingStrategy (const ContentHandlingStrategy &value)
 
UpdateIntegrationRequestWithContentHandlingStrategy (ContentHandlingStrategy &&value)
 
const Aws::StringGetCredentialsArn () const
 
bool CredentialsArnHasBeenSet () const
 
void SetCredentialsArn (const Aws::String &value)
 
void SetCredentialsArn (Aws::String &&value)
 
void SetCredentialsArn (const char *value)
 
UpdateIntegrationRequestWithCredentialsArn (const Aws::String &value)
 
UpdateIntegrationRequestWithCredentialsArn (Aws::String &&value)
 
UpdateIntegrationRequestWithCredentialsArn (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
UpdateIntegrationRequestWithDescription (const Aws::String &value)
 
UpdateIntegrationRequestWithDescription (Aws::String &&value)
 
UpdateIntegrationRequestWithDescription (const char *value)
 
const Aws::StringGetIntegrationId () const
 
bool IntegrationIdHasBeenSet () const
 
void SetIntegrationId (const Aws::String &value)
 
void SetIntegrationId (Aws::String &&value)
 
void SetIntegrationId (const char *value)
 
UpdateIntegrationRequestWithIntegrationId (const Aws::String &value)
 
UpdateIntegrationRequestWithIntegrationId (Aws::String &&value)
 
UpdateIntegrationRequestWithIntegrationId (const char *value)
 
const Aws::StringGetIntegrationMethod () const
 
bool IntegrationMethodHasBeenSet () const
 
void SetIntegrationMethod (const Aws::String &value)
 
void SetIntegrationMethod (Aws::String &&value)
 
void SetIntegrationMethod (const char *value)
 
UpdateIntegrationRequestWithIntegrationMethod (const Aws::String &value)
 
UpdateIntegrationRequestWithIntegrationMethod (Aws::String &&value)
 
UpdateIntegrationRequestWithIntegrationMethod (const char *value)
 
const Aws::StringGetIntegrationSubtype () const
 
bool IntegrationSubtypeHasBeenSet () const
 
void SetIntegrationSubtype (const Aws::String &value)
 
void SetIntegrationSubtype (Aws::String &&value)
 
void SetIntegrationSubtype (const char *value)
 
UpdateIntegrationRequestWithIntegrationSubtype (const Aws::String &value)
 
UpdateIntegrationRequestWithIntegrationSubtype (Aws::String &&value)
 
UpdateIntegrationRequestWithIntegrationSubtype (const char *value)
 
const IntegrationTypeGetIntegrationType () const
 
bool IntegrationTypeHasBeenSet () const
 
void SetIntegrationType (const IntegrationType &value)
 
void SetIntegrationType (IntegrationType &&value)
 
UpdateIntegrationRequestWithIntegrationType (const IntegrationType &value)
 
UpdateIntegrationRequestWithIntegrationType (IntegrationType &&value)
 
const Aws::StringGetIntegrationUri () const
 
bool IntegrationUriHasBeenSet () const
 
void SetIntegrationUri (const Aws::String &value)
 
void SetIntegrationUri (Aws::String &&value)
 
void SetIntegrationUri (const char *value)
 
UpdateIntegrationRequestWithIntegrationUri (const Aws::String &value)
 
UpdateIntegrationRequestWithIntegrationUri (Aws::String &&value)
 
UpdateIntegrationRequestWithIntegrationUri (const char *value)
 
const PassthroughBehaviorGetPassthroughBehavior () const
 
bool PassthroughBehaviorHasBeenSet () const
 
void SetPassthroughBehavior (const PassthroughBehavior &value)
 
void SetPassthroughBehavior (PassthroughBehavior &&value)
 
UpdateIntegrationRequestWithPassthroughBehavior (const PassthroughBehavior &value)
 
UpdateIntegrationRequestWithPassthroughBehavior (PassthroughBehavior &&value)
 
const Aws::StringGetPayloadFormatVersion () const
 
bool PayloadFormatVersionHasBeenSet () const
 
void SetPayloadFormatVersion (const Aws::String &value)
 
void SetPayloadFormatVersion (Aws::String &&value)
 
void SetPayloadFormatVersion (const char *value)
 
UpdateIntegrationRequestWithPayloadFormatVersion (const Aws::String &value)
 
UpdateIntegrationRequestWithPayloadFormatVersion (Aws::String &&value)
 
UpdateIntegrationRequestWithPayloadFormatVersion (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)
 
UpdateIntegrationRequestWithRequestParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
UpdateIntegrationRequestWithRequestParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateIntegrationRequestAddRequestParameters (const Aws::String &key, const Aws::String &value)
 
UpdateIntegrationRequestAddRequestParameters (Aws::String &&key, const Aws::String &value)
 
UpdateIntegrationRequestAddRequestParameters (const Aws::String &key, Aws::String &&value)
 
UpdateIntegrationRequestAddRequestParameters (Aws::String &&key, Aws::String &&value)
 
UpdateIntegrationRequestAddRequestParameters (const char *key, Aws::String &&value)
 
UpdateIntegrationRequestAddRequestParameters (Aws::String &&key, const char *value)
 
UpdateIntegrationRequestAddRequestParameters (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)
 
UpdateIntegrationRequestWithRequestTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
UpdateIntegrationRequestWithRequestTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateIntegrationRequestAddRequestTemplates (const Aws::String &key, const Aws::String &value)
 
UpdateIntegrationRequestAddRequestTemplates (Aws::String &&key, const Aws::String &value)
 
UpdateIntegrationRequestAddRequestTemplates (const Aws::String &key, Aws::String &&value)
 
UpdateIntegrationRequestAddRequestTemplates (Aws::String &&key, Aws::String &&value)
 
UpdateIntegrationRequestAddRequestTemplates (const char *key, Aws::String &&value)
 
UpdateIntegrationRequestAddRequestTemplates (Aws::String &&key, const char *value)
 
UpdateIntegrationRequestAddRequestTemplates (const char *key, const char *value)
 
const Aws::StringGetTemplateSelectionExpression () const
 
bool TemplateSelectionExpressionHasBeenSet () const
 
void SetTemplateSelectionExpression (const Aws::String &value)
 
void SetTemplateSelectionExpression (Aws::String &&value)
 
void SetTemplateSelectionExpression (const char *value)
 
UpdateIntegrationRequestWithTemplateSelectionExpression (const Aws::String &value)
 
UpdateIntegrationRequestWithTemplateSelectionExpression (Aws::String &&value)
 
UpdateIntegrationRequestWithTemplateSelectionExpression (const char *value)
 
int GetTimeoutInMillis () const
 
bool TimeoutInMillisHasBeenSet () const
 
void SetTimeoutInMillis (int value)
 
UpdateIntegrationRequestWithTimeoutInMillis (int value)
 
const TlsConfigInputGetTlsConfig () const
 
bool TlsConfigHasBeenSet () const
 
void SetTlsConfig (const TlsConfigInput &value)
 
void SetTlsConfig (TlsConfigInput &&value)
 
UpdateIntegrationRequestWithTlsConfig (const TlsConfigInput &value)
 
UpdateIntegrationRequestWithTlsConfig (TlsConfigInput &&value)
 
- Public Member Functions inherited from Aws::ApiGatewayV2::ApiGatewayV2Request
virtual ~ApiGatewayV2Request ()
 
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::ApiGatewayV2::ApiGatewayV2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Updates an Integration.

See Also:

AWS API Reference

Definition at line 30 of file UpdateIntegrationRequest.h.

Constructor & Destructor Documentation

◆ UpdateIntegrationRequest()

Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::UpdateIntegrationRequest ( )

Member Function Documentation

◆ AddRequestParameters() [1/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::AddRequestParameters ( const Aws::String key,
const Aws::String value 
)
inline

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 1036 of file UpdateIntegrationRequest.h.

◆ AddRequestParameters() [2/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::AddRequestParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 1057 of file UpdateIntegrationRequest.h.

◆ AddRequestParameters() [3/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::AddRequestParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 1078 of file UpdateIntegrationRequest.h.

◆ AddRequestParameters() [4/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::AddRequestParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 1099 of file UpdateIntegrationRequest.h.

◆ AddRequestParameters() [5/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::AddRequestParameters ( const char *  key,
Aws::String &&  value 
)
inline

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 1120 of file UpdateIntegrationRequest.h.

◆ AddRequestParameters() [6/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::AddRequestParameters ( Aws::String &&  key,
const char *  value 
)
inline

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 1141 of file UpdateIntegrationRequest.h.

◆ AddRequestParameters() [7/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::AddRequestParameters ( const char *  key,
const char *  value 
)
inline

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 1162 of file UpdateIntegrationRequest.h.

◆ AddRequestTemplates() [1/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1219 of file UpdateIntegrationRequest.h.

◆ AddRequestTemplates() [2/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1227 of file UpdateIntegrationRequest.h.

◆ AddRequestTemplates() [3/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1235 of file UpdateIntegrationRequest.h.

◆ AddRequestTemplates() [4/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1243 of file UpdateIntegrationRequest.h.

◆ AddRequestTemplates() [5/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1251 of file UpdateIntegrationRequest.h.

◆ AddRequestTemplates() [6/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1259 of file UpdateIntegrationRequest.h.

◆ AddRequestTemplates() [7/7]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1267 of file UpdateIntegrationRequest.h.

◆ ApiIdHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::ApiIdHasBeenSet ( ) const
inline

The API identifier.

Definition at line 52 of file UpdateIntegrationRequest.h.

◆ ConnectionIdHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::ConnectionIdHasBeenSet ( ) const
inline

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

Definition at line 95 of file UpdateIntegrationRequest.h.

◆ ConnectionTypeHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::ConnectionTypeHasBeenSet ( ) const
inline

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

Definition at line 148 of file UpdateIntegrationRequest.h.

◆ ContentHandlingStrategyHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::ContentHandlingStrategyHasBeenSet ( ) const
inline

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Definition at line 205 of file UpdateIntegrationRequest.h.

◆ CredentialsArnHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::CredentialsArnHasBeenSet ( ) 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 274 of file UpdateIntegrationRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::DescriptionHasBeenSet ( ) const
inline

The description of the integration

Definition at line 345 of file UpdateIntegrationRequest.h.

◆ GetApiId()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetApiId ( ) const
inline

The API identifier.

Definition at line 47 of file UpdateIntegrationRequest.h.

◆ GetConnectionId()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetConnectionId ( ) const
inline

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

Definition at line 89 of file UpdateIntegrationRequest.h.

◆ GetConnectionType()

const ConnectionType& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetConnectionType ( ) const
inline

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

Definition at line 140 of file UpdateIntegrationRequest.h.

◆ GetContentHandlingStrategy()

const ContentHandlingStrategy& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetContentHandlingStrategy ( ) const
inline

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Definition at line 193 of file UpdateIntegrationRequest.h.

◆ GetCredentialsArn()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetCredentialsArn ( ) 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 264 of file UpdateIntegrationRequest.h.

◆ GetDescription()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetDescription ( ) const
inline

The description of the integration

Definition at line 340 of file UpdateIntegrationRequest.h.

◆ GetIntegrationId()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetIntegrationId ( ) const
inline

The integration ID.

Definition at line 381 of file UpdateIntegrationRequest.h.

◆ GetIntegrationMethod()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetIntegrationMethod ( ) const
inline

Specifies the integration's HTTP method type.

Definition at line 422 of file UpdateIntegrationRequest.h.

◆ GetIntegrationSubtype()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetIntegrationSubtype ( ) const
inline

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

Definition at line 466 of file UpdateIntegrationRequest.h.

◆ GetIntegrationType()

const IntegrationType& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetIntegrationType ( ) const
inline

The integration type of an integration. One of the following:

AWS: for integrating the route or 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. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

Definition at line 543 of file UpdateIntegrationRequest.h.

◆ GetIntegrationUri()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetIntegrationUri ( ) const
inline

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

Definition at line 657 of file UpdateIntegrationRequest.h.

◆ GetPassthroughBehavior()

const PassthroughBehavior& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.

Definition at line 764 of file UpdateIntegrationRequest.h.

◆ GetPayloadFormatVersion()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetPayloadFormatVersion ( ) const
inline

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

Definition at line 846 of file UpdateIntegrationRequest.h.

◆ GetRequestParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetRequestParameters ( ) const
inline

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 910 of file UpdateIntegrationRequest.h.

◆ GetRequestTemplates()

const Aws::Map<Aws::String, Aws::String>& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1171 of file UpdateIntegrationRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file UpdateIntegrationRequest.h.

◆ GetTemplateSelectionExpression()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetTemplateSelectionExpression ( ) const
inline

The template selection expression for the integration.

Definition at line 1273 of file UpdateIntegrationRequest.h.

◆ GetTimeoutInMillis()

int Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetTimeoutInMillis ( ) const
inline

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

Definition at line 1316 of file UpdateIntegrationRequest.h.

◆ GetTlsConfig()

const TlsConfigInput& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::GetTlsConfig ( ) const
inline

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Definition at line 1345 of file UpdateIntegrationRequest.h.

◆ IntegrationIdHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::IntegrationIdHasBeenSet ( ) const
inline

The integration ID.

Definition at line 386 of file UpdateIntegrationRequest.h.

◆ IntegrationMethodHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::IntegrationMethodHasBeenSet ( ) const
inline

Specifies the integration's HTTP method type.

Definition at line 427 of file UpdateIntegrationRequest.h.

◆ IntegrationSubtypeHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::IntegrationSubtypeHasBeenSet ( ) const
inline

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

Definition at line 474 of file UpdateIntegrationRequest.h.

◆ IntegrationTypeHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::IntegrationTypeHasBeenSet ( ) const
inline

The integration type of an integration. One of the following:

AWS: for integrating the route or 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. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

Definition at line 563 of file UpdateIntegrationRequest.h.

◆ IntegrationUriHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::IntegrationUriHasBeenSet ( ) const
inline

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

Definition at line 670 of file UpdateIntegrationRequest.h.

◆ PassthroughBehaviorHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.

Definition at line 779 of file UpdateIntegrationRequest.h.

◆ PayloadFormatVersionHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::PayloadFormatVersionHasBeenSet ( ) const
inline

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

Definition at line 852 of file UpdateIntegrationRequest.h.

◆ RequestParametersHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::RequestParametersHasBeenSet ( ) const
inline

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 931 of file UpdateIntegrationRequest.h.

◆ RequestTemplatesHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1179 of file UpdateIntegrationRequest.h.

◆ SerializePayload()

Aws::String Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApiId() [1/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetApiId ( const Aws::String value)
inline

The API identifier.

Definition at line 57 of file UpdateIntegrationRequest.h.

◆ SetApiId() [2/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetApiId ( Aws::String &&  value)
inline

The API identifier.

Definition at line 62 of file UpdateIntegrationRequest.h.

◆ SetApiId() [3/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetApiId ( const char *  value)
inline

The API identifier.

Definition at line 67 of file UpdateIntegrationRequest.h.

◆ SetConnectionId() [1/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetConnectionId ( const Aws::String value)
inline

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

Definition at line 101 of file UpdateIntegrationRequest.h.

◆ SetConnectionId() [2/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetConnectionId ( Aws::String &&  value)
inline

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

Definition at line 107 of file UpdateIntegrationRequest.h.

◆ SetConnectionId() [3/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetConnectionId ( const char *  value)
inline

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

Definition at line 113 of file UpdateIntegrationRequest.h.

◆ SetConnectionType() [1/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetConnectionType ( const ConnectionType value)
inline

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

Definition at line 156 of file UpdateIntegrationRequest.h.

◆ SetConnectionType() [2/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetConnectionType ( ConnectionType &&  value)
inline

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

Definition at line 164 of file UpdateIntegrationRequest.h.

◆ SetContentHandlingStrategy() [1/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetContentHandlingStrategy ( const ContentHandlingStrategy value)
inline

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Definition at line 217 of file UpdateIntegrationRequest.h.

◆ SetContentHandlingStrategy() [2/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetContentHandlingStrategy ( ContentHandlingStrategy &&  value)
inline

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Definition at line 229 of file UpdateIntegrationRequest.h.

◆ SetCredentialsArn() [1/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetCredentialsArn ( 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 284 of file UpdateIntegrationRequest.h.

◆ SetCredentialsArn() [2/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetCredentialsArn ( 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 294 of file UpdateIntegrationRequest.h.

◆ SetCredentialsArn() [3/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetCredentialsArn ( 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 304 of file UpdateIntegrationRequest.h.

◆ SetDescription() [1/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetDescription ( const Aws::String value)
inline

The description of the integration

Definition at line 350 of file UpdateIntegrationRequest.h.

◆ SetDescription() [2/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetDescription ( Aws::String &&  value)
inline

The description of the integration

Definition at line 355 of file UpdateIntegrationRequest.h.

◆ SetDescription() [3/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetDescription ( const char *  value)
inline

The description of the integration

Definition at line 360 of file UpdateIntegrationRequest.h.

◆ SetIntegrationId() [1/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationId ( const Aws::String value)
inline

The integration ID.

Definition at line 391 of file UpdateIntegrationRequest.h.

◆ SetIntegrationId() [2/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationId ( Aws::String &&  value)
inline

The integration ID.

Definition at line 396 of file UpdateIntegrationRequest.h.

◆ SetIntegrationId() [3/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationId ( const char *  value)
inline

The integration ID.

Definition at line 401 of file UpdateIntegrationRequest.h.

◆ SetIntegrationMethod() [1/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationMethod ( const Aws::String value)
inline

Specifies the integration's HTTP method type.

Definition at line 432 of file UpdateIntegrationRequest.h.

◆ SetIntegrationMethod() [2/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationMethod ( Aws::String &&  value)
inline

Specifies the integration's HTTP method type.

Definition at line 437 of file UpdateIntegrationRequest.h.

◆ SetIntegrationMethod() [3/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationMethod ( const char *  value)
inline

Specifies the integration's HTTP method type.

Definition at line 442 of file UpdateIntegrationRequest.h.

◆ SetIntegrationSubtype() [1/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationSubtype ( const Aws::String value)
inline

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

Definition at line 482 of file UpdateIntegrationRequest.h.

◆ SetIntegrationSubtype() [2/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationSubtype ( Aws::String &&  value)
inline

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

Definition at line 490 of file UpdateIntegrationRequest.h.

◆ SetIntegrationSubtype() [3/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationSubtype ( const char *  value)
inline

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

Definition at line 498 of file UpdateIntegrationRequest.h.

◆ SetIntegrationType() [1/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationType ( const IntegrationType value)
inline

The integration type of an integration. One of the following:

AWS: for integrating the route or 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. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

Definition at line 583 of file UpdateIntegrationRequest.h.

◆ SetIntegrationType() [2/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationType ( IntegrationType &&  value)
inline

The integration type of an integration. One of the following:

AWS: for integrating the route or 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. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

Definition at line 603 of file UpdateIntegrationRequest.h.

◆ SetIntegrationUri() [1/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationUri ( const Aws::String value)
inline

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

Definition at line 683 of file UpdateIntegrationRequest.h.

◆ SetIntegrationUri() [2/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationUri ( Aws::String &&  value)
inline

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

Definition at line 696 of file UpdateIntegrationRequest.h.

◆ SetIntegrationUri() [3/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetIntegrationUri ( const char *  value)
inline

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

Definition at line 709 of file UpdateIntegrationRequest.h.

◆ SetPassthroughBehavior() [1/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetPassthroughBehavior ( const PassthroughBehavior 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. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.

Definition at line 794 of file UpdateIntegrationRequest.h.

◆ SetPassthroughBehavior() [2/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetPassthroughBehavior ( PassthroughBehavior &&  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. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.

Definition at line 809 of file UpdateIntegrationRequest.h.

◆ SetPayloadFormatVersion() [1/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetPayloadFormatVersion ( const Aws::String value)
inline

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

Definition at line 858 of file UpdateIntegrationRequest.h.

◆ SetPayloadFormatVersion() [2/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetPayloadFormatVersion ( Aws::String &&  value)
inline

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

Definition at line 864 of file UpdateIntegrationRequest.h.

◆ SetPayloadFormatVersion() [3/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetPayloadFormatVersion ( const char *  value)
inline

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

Definition at line 870 of file UpdateIntegrationRequest.h.

◆ SetRequestParameters() [1/2]

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

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 952 of file UpdateIntegrationRequest.h.

◆ SetRequestParameters() [2/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetRequestParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 973 of file UpdateIntegrationRequest.h.

◆ SetRequestTemplates() [1/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1187 of file UpdateIntegrationRequest.h.

◆ SetRequestTemplates() [2/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1195 of file UpdateIntegrationRequest.h.

◆ SetTemplateSelectionExpression() [1/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetTemplateSelectionExpression ( const Aws::String value)
inline

The template selection expression for the integration.

Definition at line 1283 of file UpdateIntegrationRequest.h.

◆ SetTemplateSelectionExpression() [2/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetTemplateSelectionExpression ( Aws::String &&  value)
inline

The template selection expression for the integration.

Definition at line 1288 of file UpdateIntegrationRequest.h.

◆ SetTemplateSelectionExpression() [3/3]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetTemplateSelectionExpression ( const char *  value)
inline

The template selection expression for the integration.

Definition at line 1293 of file UpdateIntegrationRequest.h.

◆ SetTimeoutInMillis()

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetTimeoutInMillis ( int  value)
inline

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

Definition at line 1330 of file UpdateIntegrationRequest.h.

◆ SetTlsConfig() [1/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetTlsConfig ( const TlsConfigInput value)
inline

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Definition at line 1359 of file UpdateIntegrationRequest.h.

◆ SetTlsConfig() [2/2]

void Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::SetTlsConfig ( TlsConfigInput &&  value)
inline

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Definition at line 1366 of file UpdateIntegrationRequest.h.

◆ TemplateSelectionExpressionHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::TemplateSelectionExpressionHasBeenSet ( ) const
inline

The template selection expression for the integration.

Definition at line 1278 of file UpdateIntegrationRequest.h.

◆ TimeoutInMillisHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::TimeoutInMillisHasBeenSet ( ) const
inline

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

Definition at line 1323 of file UpdateIntegrationRequest.h.

◆ TlsConfigHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::TlsConfigHasBeenSet ( ) const
inline

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Definition at line 1352 of file UpdateIntegrationRequest.h.

◆ WithApiId() [1/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithApiId ( const Aws::String value)
inline

The API identifier.

Definition at line 72 of file UpdateIntegrationRequest.h.

◆ WithApiId() [2/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithApiId ( Aws::String &&  value)
inline

The API identifier.

Definition at line 77 of file UpdateIntegrationRequest.h.

◆ WithApiId() [3/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithApiId ( const char *  value)
inline

The API identifier.

Definition at line 82 of file UpdateIntegrationRequest.h.

◆ WithConnectionId() [1/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithConnectionId ( const Aws::String value)
inline

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

Definition at line 119 of file UpdateIntegrationRequest.h.

◆ WithConnectionId() [2/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithConnectionId ( Aws::String &&  value)
inline

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

Definition at line 125 of file UpdateIntegrationRequest.h.

◆ WithConnectionId() [3/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithConnectionId ( const char *  value)
inline

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

Definition at line 131 of file UpdateIntegrationRequest.h.

◆ WithConnectionType() [1/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithConnectionType ( const ConnectionType value)
inline

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

Definition at line 172 of file UpdateIntegrationRequest.h.

◆ WithConnectionType() [2/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithConnectionType ( ConnectionType &&  value)
inline

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

Definition at line 180 of file UpdateIntegrationRequest.h.

◆ WithContentHandlingStrategy() [1/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithContentHandlingStrategy ( const ContentHandlingStrategy value)
inline

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Definition at line 241 of file UpdateIntegrationRequest.h.

◆ WithContentHandlingStrategy() [2/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithContentHandlingStrategy ( ContentHandlingStrategy &&  value)
inline

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Definition at line 253 of file UpdateIntegrationRequest.h.

◆ WithCredentialsArn() [1/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithCredentialsArn ( 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 314 of file UpdateIntegrationRequest.h.

◆ WithCredentialsArn() [2/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithCredentialsArn ( 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 324 of file UpdateIntegrationRequest.h.

◆ WithCredentialsArn() [3/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithCredentialsArn ( 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 334 of file UpdateIntegrationRequest.h.

◆ WithDescription() [1/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithDescription ( const Aws::String value)
inline

The description of the integration

Definition at line 365 of file UpdateIntegrationRequest.h.

◆ WithDescription() [2/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithDescription ( Aws::String &&  value)
inline

The description of the integration

Definition at line 370 of file UpdateIntegrationRequest.h.

◆ WithDescription() [3/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithDescription ( const char *  value)
inline

The description of the integration

Definition at line 375 of file UpdateIntegrationRequest.h.

◆ WithIntegrationId() [1/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationId ( const Aws::String value)
inline

The integration ID.

Definition at line 406 of file UpdateIntegrationRequest.h.

◆ WithIntegrationId() [2/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationId ( Aws::String &&  value)
inline

The integration ID.

Definition at line 411 of file UpdateIntegrationRequest.h.

◆ WithIntegrationId() [3/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationId ( const char *  value)
inline

The integration ID.

Definition at line 416 of file UpdateIntegrationRequest.h.

◆ WithIntegrationMethod() [1/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationMethod ( const Aws::String value)
inline

Specifies the integration's HTTP method type.

Definition at line 447 of file UpdateIntegrationRequest.h.

◆ WithIntegrationMethod() [2/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationMethod ( Aws::String &&  value)
inline

Specifies the integration's HTTP method type.

Definition at line 452 of file UpdateIntegrationRequest.h.

◆ WithIntegrationMethod() [3/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationMethod ( const char *  value)
inline

Specifies the integration's HTTP method type.

Definition at line 457 of file UpdateIntegrationRequest.h.

◆ WithIntegrationSubtype() [1/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationSubtype ( const Aws::String value)
inline

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

Definition at line 506 of file UpdateIntegrationRequest.h.

◆ WithIntegrationSubtype() [2/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationSubtype ( Aws::String &&  value)
inline

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

Definition at line 514 of file UpdateIntegrationRequest.h.

◆ WithIntegrationSubtype() [3/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationSubtype ( const char *  value)
inline

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

Definition at line 522 of file UpdateIntegrationRequest.h.

◆ WithIntegrationType() [1/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationType ( const IntegrationType value)
inline

The integration type of an integration. One of the following:

AWS: for integrating the route or 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. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

Definition at line 623 of file UpdateIntegrationRequest.h.

◆ WithIntegrationType() [2/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationType ( IntegrationType &&  value)
inline

The integration type of an integration. One of the following:

AWS: for integrating the route or 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. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

Definition at line 643 of file UpdateIntegrationRequest.h.

◆ WithIntegrationUri() [1/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationUri ( const Aws::String value)
inline

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

Definition at line 722 of file UpdateIntegrationRequest.h.

◆ WithIntegrationUri() [2/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationUri ( Aws::String &&  value)
inline

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

Definition at line 735 of file UpdateIntegrationRequest.h.

◆ WithIntegrationUri() [3/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithIntegrationUri ( const char *  value)
inline

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

Definition at line 748 of file UpdateIntegrationRequest.h.

◆ WithPassthroughBehavior() [1/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithPassthroughBehavior ( const PassthroughBehavior 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. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.

Definition at line 824 of file UpdateIntegrationRequest.h.

◆ WithPassthroughBehavior() [2/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithPassthroughBehavior ( PassthroughBehavior &&  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. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.

Definition at line 839 of file UpdateIntegrationRequest.h.

◆ WithPayloadFormatVersion() [1/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithPayloadFormatVersion ( const Aws::String value)
inline

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

Definition at line 876 of file UpdateIntegrationRequest.h.

◆ WithPayloadFormatVersion() [2/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithPayloadFormatVersion ( Aws::String &&  value)
inline

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

Definition at line 882 of file UpdateIntegrationRequest.h.

◆ WithPayloadFormatVersion() [3/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithPayloadFormatVersion ( const char *  value)
inline

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

Definition at line 888 of file UpdateIntegrationRequest.h.

◆ WithRequestParameters() [1/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithRequestParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 994 of file UpdateIntegrationRequest.h.

◆ WithRequestParameters() [2/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithRequestParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>

, where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

Definition at line 1015 of file UpdateIntegrationRequest.h.

◆ WithRequestTemplates() [1/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1203 of file UpdateIntegrationRequest.h.

◆ WithRequestTemplates() [2/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::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. Supported only for WebSocket APIs.

Definition at line 1211 of file UpdateIntegrationRequest.h.

◆ WithTemplateSelectionExpression() [1/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithTemplateSelectionExpression ( const Aws::String value)
inline

The template selection expression for the integration.

Definition at line 1298 of file UpdateIntegrationRequest.h.

◆ WithTemplateSelectionExpression() [2/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithTemplateSelectionExpression ( Aws::String &&  value)
inline

The template selection expression for the integration.

Definition at line 1303 of file UpdateIntegrationRequest.h.

◆ WithTemplateSelectionExpression() [3/3]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithTemplateSelectionExpression ( const char *  value)
inline

The template selection expression for the integration.

Definition at line 1308 of file UpdateIntegrationRequest.h.

◆ WithTimeoutInMillis()

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithTimeoutInMillis ( int  value)
inline

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

Definition at line 1337 of file UpdateIntegrationRequest.h.

◆ WithTlsConfig() [1/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithTlsConfig ( const TlsConfigInput value)
inline

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Definition at line 1373 of file UpdateIntegrationRequest.h.

◆ WithTlsConfig() [2/2]

UpdateIntegrationRequest& Aws::ApiGatewayV2::Model::UpdateIntegrationRequest::WithTlsConfig ( TlsConfigInput &&  value)
inline

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Definition at line 1380 of file UpdateIntegrationRequest.h.


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