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

#include <CreateIntegrationRequest.h>

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

Public Member Functions

 CreateIntegrationRequest ()
 
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)
 
CreateIntegrationRequestWithApiId (const Aws::String &value)
 
CreateIntegrationRequestWithApiId (Aws::String &&value)
 
CreateIntegrationRequestWithApiId (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)
 
CreateIntegrationRequestWithConnectionId (const Aws::String &value)
 
CreateIntegrationRequestWithConnectionId (Aws::String &&value)
 
CreateIntegrationRequestWithConnectionId (const char *value)
 
const ConnectionTypeGetConnectionType () const
 
bool ConnectionTypeHasBeenSet () const
 
void SetConnectionType (const ConnectionType &value)
 
void SetConnectionType (ConnectionType &&value)
 
CreateIntegrationRequestWithConnectionType (const ConnectionType &value)
 
CreateIntegrationRequestWithConnectionType (ConnectionType &&value)
 
const ContentHandlingStrategyGetContentHandlingStrategy () const
 
bool ContentHandlingStrategyHasBeenSet () const
 
void SetContentHandlingStrategy (const ContentHandlingStrategy &value)
 
void SetContentHandlingStrategy (ContentHandlingStrategy &&value)
 
CreateIntegrationRequestWithContentHandlingStrategy (const ContentHandlingStrategy &value)
 
CreateIntegrationRequestWithContentHandlingStrategy (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)
 
CreateIntegrationRequestWithCredentialsArn (const Aws::String &value)
 
CreateIntegrationRequestWithCredentialsArn (Aws::String &&value)
 
CreateIntegrationRequestWithCredentialsArn (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)
 
CreateIntegrationRequestWithDescription (const Aws::String &value)
 
CreateIntegrationRequestWithDescription (Aws::String &&value)
 
CreateIntegrationRequestWithDescription (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)
 
CreateIntegrationRequestWithIntegrationMethod (const Aws::String &value)
 
CreateIntegrationRequestWithIntegrationMethod (Aws::String &&value)
 
CreateIntegrationRequestWithIntegrationMethod (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)
 
CreateIntegrationRequestWithIntegrationSubtype (const Aws::String &value)
 
CreateIntegrationRequestWithIntegrationSubtype (Aws::String &&value)
 
CreateIntegrationRequestWithIntegrationSubtype (const char *value)
 
const IntegrationTypeGetIntegrationType () const
 
bool IntegrationTypeHasBeenSet () const
 
void SetIntegrationType (const IntegrationType &value)
 
void SetIntegrationType (IntegrationType &&value)
 
CreateIntegrationRequestWithIntegrationType (const IntegrationType &value)
 
CreateIntegrationRequestWithIntegrationType (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)
 
CreateIntegrationRequestWithIntegrationUri (const Aws::String &value)
 
CreateIntegrationRequestWithIntegrationUri (Aws::String &&value)
 
CreateIntegrationRequestWithIntegrationUri (const char *value)
 
const PassthroughBehaviorGetPassthroughBehavior () const
 
bool PassthroughBehaviorHasBeenSet () const
 
void SetPassthroughBehavior (const PassthroughBehavior &value)
 
void SetPassthroughBehavior (PassthroughBehavior &&value)
 
CreateIntegrationRequestWithPassthroughBehavior (const PassthroughBehavior &value)
 
CreateIntegrationRequestWithPassthroughBehavior (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)
 
CreateIntegrationRequestWithPayloadFormatVersion (const Aws::String &value)
 
CreateIntegrationRequestWithPayloadFormatVersion (Aws::String &&value)
 
CreateIntegrationRequestWithPayloadFormatVersion (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)
 
CreateIntegrationRequestWithRequestParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateIntegrationRequestWithRequestParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateIntegrationRequestAddRequestParameters (const Aws::String &key, const Aws::String &value)
 
CreateIntegrationRequestAddRequestParameters (Aws::String &&key, const Aws::String &value)
 
CreateIntegrationRequestAddRequestParameters (const Aws::String &key, Aws::String &&value)
 
CreateIntegrationRequestAddRequestParameters (Aws::String &&key, Aws::String &&value)
 
CreateIntegrationRequestAddRequestParameters (const char *key, Aws::String &&value)
 
CreateIntegrationRequestAddRequestParameters (Aws::String &&key, const char *value)
 
CreateIntegrationRequestAddRequestParameters (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)
 
CreateIntegrationRequestWithRequestTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateIntegrationRequestWithRequestTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateIntegrationRequestAddRequestTemplates (const Aws::String &key, const Aws::String &value)
 
CreateIntegrationRequestAddRequestTemplates (Aws::String &&key, const Aws::String &value)
 
CreateIntegrationRequestAddRequestTemplates (const Aws::String &key, Aws::String &&value)
 
CreateIntegrationRequestAddRequestTemplates (Aws::String &&key, Aws::String &&value)
 
CreateIntegrationRequestAddRequestTemplates (const char *key, Aws::String &&value)
 
CreateIntegrationRequestAddRequestTemplates (Aws::String &&key, const char *value)
 
CreateIntegrationRequestAddRequestTemplates (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)
 
CreateIntegrationRequestWithTemplateSelectionExpression (const Aws::String &value)
 
CreateIntegrationRequestWithTemplateSelectionExpression (Aws::String &&value)
 
CreateIntegrationRequestWithTemplateSelectionExpression (const char *value)
 
int GetTimeoutInMillis () const
 
bool TimeoutInMillisHasBeenSet () const
 
void SetTimeoutInMillis (int value)
 
CreateIntegrationRequestWithTimeoutInMillis (int value)
 
const TlsConfigInputGetTlsConfig () const
 
bool TlsConfigHasBeenSet () const
 
void SetTlsConfig (const TlsConfigInput &value)
 
void SetTlsConfig (TlsConfigInput &&value)
 
CreateIntegrationRequestWithTlsConfig (const TlsConfigInput &value)
 
CreateIntegrationRequestWithTlsConfig (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

Creates a new Integration resource to represent an integration.

See Also:

AWS API Reference

Definition at line 31 of file CreateIntegrationRequest.h.

Constructor & Destructor Documentation

◆ CreateIntegrationRequest()

Aws::ApiGatewayV2::Model::CreateIntegrationRequest::CreateIntegrationRequest ( )

Member Function Documentation

◆ AddRequestParameters() [1/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 996 of file CreateIntegrationRequest.h.

◆ AddRequestParameters() [2/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1017 of file CreateIntegrationRequest.h.

◆ AddRequestParameters() [3/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1038 of file CreateIntegrationRequest.h.

◆ AddRequestParameters() [4/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1059 of file CreateIntegrationRequest.h.

◆ AddRequestParameters() [5/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1080 of file CreateIntegrationRequest.h.

◆ AddRequestParameters() [6/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1101 of file CreateIntegrationRequest.h.

◆ AddRequestParameters() [7/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1122 of file CreateIntegrationRequest.h.

◆ AddRequestTemplates() [1/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1179 of file CreateIntegrationRequest.h.

◆ AddRequestTemplates() [2/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1187 of file CreateIntegrationRequest.h.

◆ AddRequestTemplates() [3/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1195 of file CreateIntegrationRequest.h.

◆ AddRequestTemplates() [4/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1203 of file CreateIntegrationRequest.h.

◆ AddRequestTemplates() [5/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1211 of file CreateIntegrationRequest.h.

◆ AddRequestTemplates() [6/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1219 of file CreateIntegrationRequest.h.

◆ AddRequestTemplates() [7/7]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1227 of file CreateIntegrationRequest.h.

◆ ApiIdHasBeenSet()

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

The API identifier.

Definition at line 53 of file CreateIntegrationRequest.h.

◆ ConnectionIdHasBeenSet()

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

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

Definition at line 96 of file CreateIntegrationRequest.h.

◆ ConnectionTypeHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 149 of file CreateIntegrationRequest.h.

◆ ContentHandlingStrategyHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 206 of file CreateIntegrationRequest.h.

◆ CredentialsArnHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 275 of file CreateIntegrationRequest.h.

◆ DescriptionHasBeenSet()

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

The description of the integration.

Definition at line 346 of file CreateIntegrationRequest.h.

◆ GetApiId()

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

The API identifier.

Definition at line 48 of file CreateIntegrationRequest.h.

◆ GetConnectionId()

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

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

Definition at line 90 of file CreateIntegrationRequest.h.

◆ GetConnectionType()

const ConnectionType& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 141 of file CreateIntegrationRequest.h.

◆ GetContentHandlingStrategy()

const ContentHandlingStrategy& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 194 of file CreateIntegrationRequest.h.

◆ GetCredentialsArn()

const Aws::String& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 265 of file CreateIntegrationRequest.h.

◆ GetDescription()

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

The description of the integration.

Definition at line 341 of file CreateIntegrationRequest.h.

◆ GetIntegrationMethod()

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

Specifies the integration's HTTP method type.

Definition at line 382 of file CreateIntegrationRequest.h.

◆ GetIntegrationSubtype()

const Aws::String& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 426 of file CreateIntegrationRequest.h.

◆ GetIntegrationType()

const IntegrationType& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 503 of file CreateIntegrationRequest.h.

◆ GetIntegrationUri()

const Aws::String& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 617 of file CreateIntegrationRequest.h.

◆ GetPassthroughBehavior()

const PassthroughBehavior& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 724 of file CreateIntegrationRequest.h.

◆ GetPayloadFormatVersion()

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

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

Definition at line 806 of file CreateIntegrationRequest.h.

◆ GetRequestParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 870 of file CreateIntegrationRequest.h.

◆ GetRequestTemplates()

const Aws::Map<Aws::String, Aws::String>& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1131 of file CreateIntegrationRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file CreateIntegrationRequest.h.

◆ GetTemplateSelectionExpression()

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

The template selection expression for the integration.

Definition at line 1233 of file CreateIntegrationRequest.h.

◆ GetTimeoutInMillis()

int Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1276 of file CreateIntegrationRequest.h.

◆ GetTlsConfig()

const TlsConfigInput& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1305 of file CreateIntegrationRequest.h.

◆ IntegrationMethodHasBeenSet()

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

Specifies the integration's HTTP method type.

Definition at line 387 of file CreateIntegrationRequest.h.

◆ IntegrationSubtypeHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 434 of file CreateIntegrationRequest.h.

◆ IntegrationTypeHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 523 of file CreateIntegrationRequest.h.

◆ IntegrationUriHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 630 of file CreateIntegrationRequest.h.

◆ PassthroughBehaviorHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 739 of file CreateIntegrationRequest.h.

◆ PayloadFormatVersionHasBeenSet()

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

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

Definition at line 812 of file CreateIntegrationRequest.h.

◆ RequestParametersHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 891 of file CreateIntegrationRequest.h.

◆ RequestTemplatesHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1139 of file CreateIntegrationRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApiId() [1/3]

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

The API identifier.

Definition at line 58 of file CreateIntegrationRequest.h.

◆ SetApiId() [2/3]

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

The API identifier.

Definition at line 63 of file CreateIntegrationRequest.h.

◆ SetApiId() [3/3]

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

The API identifier.

Definition at line 68 of file CreateIntegrationRequest.h.

◆ SetConnectionId() [1/3]

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

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

Definition at line 102 of file CreateIntegrationRequest.h.

◆ SetConnectionId() [2/3]

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

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

Definition at line 108 of file CreateIntegrationRequest.h.

◆ SetConnectionId() [3/3]

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

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

Definition at line 114 of file CreateIntegrationRequest.h.

◆ SetConnectionType() [1/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 157 of file CreateIntegrationRequest.h.

◆ SetConnectionType() [2/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 165 of file CreateIntegrationRequest.h.

◆ SetContentHandlingStrategy() [1/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 218 of file CreateIntegrationRequest.h.

◆ SetContentHandlingStrategy() [2/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 230 of file CreateIntegrationRequest.h.

◆ SetCredentialsArn() [1/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 285 of file CreateIntegrationRequest.h.

◆ SetCredentialsArn() [2/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 295 of file CreateIntegrationRequest.h.

◆ SetCredentialsArn() [3/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 305 of file CreateIntegrationRequest.h.

◆ SetDescription() [1/3]

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

The description of the integration.

Definition at line 351 of file CreateIntegrationRequest.h.

◆ SetDescription() [2/3]

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

The description of the integration.

Definition at line 356 of file CreateIntegrationRequest.h.

◆ SetDescription() [3/3]

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

The description of the integration.

Definition at line 361 of file CreateIntegrationRequest.h.

◆ SetIntegrationMethod() [1/3]

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

Specifies the integration's HTTP method type.

Definition at line 392 of file CreateIntegrationRequest.h.

◆ SetIntegrationMethod() [2/3]

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

Specifies the integration's HTTP method type.

Definition at line 397 of file CreateIntegrationRequest.h.

◆ SetIntegrationMethod() [3/3]

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

Specifies the integration's HTTP method type.

Definition at line 402 of file CreateIntegrationRequest.h.

◆ SetIntegrationSubtype() [1/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 442 of file CreateIntegrationRequest.h.

◆ SetIntegrationSubtype() [2/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 450 of file CreateIntegrationRequest.h.

◆ SetIntegrationSubtype() [3/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 458 of file CreateIntegrationRequest.h.

◆ SetIntegrationType() [1/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 543 of file CreateIntegrationRequest.h.

◆ SetIntegrationType() [2/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 563 of file CreateIntegrationRequest.h.

◆ SetIntegrationUri() [1/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 643 of file CreateIntegrationRequest.h.

◆ SetIntegrationUri() [2/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 656 of file CreateIntegrationRequest.h.

◆ SetIntegrationUri() [3/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 669 of file CreateIntegrationRequest.h.

◆ SetPassthroughBehavior() [1/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 754 of file CreateIntegrationRequest.h.

◆ SetPassthroughBehavior() [2/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 769 of file CreateIntegrationRequest.h.

◆ SetPayloadFormatVersion() [1/3]

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

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

Definition at line 818 of file CreateIntegrationRequest.h.

◆ SetPayloadFormatVersion() [2/3]

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

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

Definition at line 824 of file CreateIntegrationRequest.h.

◆ SetPayloadFormatVersion() [3/3]

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

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

Definition at line 830 of file CreateIntegrationRequest.h.

◆ SetRequestParameters() [1/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 912 of file CreateIntegrationRequest.h.

◆ SetRequestParameters() [2/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 933 of file CreateIntegrationRequest.h.

◆ SetRequestTemplates() [1/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1147 of file CreateIntegrationRequest.h.

◆ SetRequestTemplates() [2/2]

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

◆ SetTemplateSelectionExpression() [1/3]

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

The template selection expression for the integration.

Definition at line 1243 of file CreateIntegrationRequest.h.

◆ SetTemplateSelectionExpression() [2/3]

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

The template selection expression for the integration.

Definition at line 1248 of file CreateIntegrationRequest.h.

◆ SetTemplateSelectionExpression() [3/3]

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

The template selection expression for the integration.

Definition at line 1253 of file CreateIntegrationRequest.h.

◆ SetTimeoutInMillis()

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1290 of file CreateIntegrationRequest.h.

◆ SetTlsConfig() [1/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1319 of file CreateIntegrationRequest.h.

◆ SetTlsConfig() [2/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1326 of file CreateIntegrationRequest.h.

◆ TemplateSelectionExpressionHasBeenSet()

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

The template selection expression for the integration.

Definition at line 1238 of file CreateIntegrationRequest.h.

◆ TimeoutInMillisHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1283 of file CreateIntegrationRequest.h.

◆ TlsConfigHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1312 of file CreateIntegrationRequest.h.

◆ WithApiId() [1/3]

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

The API identifier.

Definition at line 73 of file CreateIntegrationRequest.h.

◆ WithApiId() [2/3]

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

The API identifier.

Definition at line 78 of file CreateIntegrationRequest.h.

◆ WithApiId() [3/3]

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

The API identifier.

Definition at line 83 of file CreateIntegrationRequest.h.

◆ WithConnectionId() [1/3]

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

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

Definition at line 120 of file CreateIntegrationRequest.h.

◆ WithConnectionId() [2/3]

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

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

Definition at line 126 of file CreateIntegrationRequest.h.

◆ WithConnectionId() [3/3]

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

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

Definition at line 132 of file CreateIntegrationRequest.h.

◆ WithConnectionType() [1/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 173 of file CreateIntegrationRequest.h.

◆ WithConnectionType() [2/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 181 of file CreateIntegrationRequest.h.

◆ WithContentHandlingStrategy() [1/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 242 of file CreateIntegrationRequest.h.

◆ WithContentHandlingStrategy() [2/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 254 of file CreateIntegrationRequest.h.

◆ WithCredentialsArn() [1/3]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 315 of file CreateIntegrationRequest.h.

◆ WithCredentialsArn() [2/3]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 325 of file CreateIntegrationRequest.h.

◆ WithCredentialsArn() [3/3]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 335 of file CreateIntegrationRequest.h.

◆ WithDescription() [1/3]

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

The description of the integration.

Definition at line 366 of file CreateIntegrationRequest.h.

◆ WithDescription() [2/3]

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

The description of the integration.

Definition at line 371 of file CreateIntegrationRequest.h.

◆ WithDescription() [3/3]

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

The description of the integration.

Definition at line 376 of file CreateIntegrationRequest.h.

◆ WithIntegrationMethod() [1/3]

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

Specifies the integration's HTTP method type.

Definition at line 407 of file CreateIntegrationRequest.h.

◆ WithIntegrationMethod() [2/3]

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

Specifies the integration's HTTP method type.

Definition at line 412 of file CreateIntegrationRequest.h.

◆ WithIntegrationMethod() [3/3]

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

Specifies the integration's HTTP method type.

Definition at line 417 of file CreateIntegrationRequest.h.

◆ WithIntegrationSubtype() [1/3]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 466 of file CreateIntegrationRequest.h.

◆ WithIntegrationSubtype() [2/3]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 474 of file CreateIntegrationRequest.h.

◆ WithIntegrationSubtype() [3/3]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 482 of file CreateIntegrationRequest.h.

◆ WithIntegrationType() [1/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 583 of file CreateIntegrationRequest.h.

◆ WithIntegrationType() [2/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 603 of file CreateIntegrationRequest.h.

◆ WithIntegrationUri() [1/3]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 682 of file CreateIntegrationRequest.h.

◆ WithIntegrationUri() [2/3]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 695 of file CreateIntegrationRequest.h.

◆ WithIntegrationUri() [3/3]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 708 of file CreateIntegrationRequest.h.

◆ WithPassthroughBehavior() [1/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 784 of file CreateIntegrationRequest.h.

◆ WithPassthroughBehavior() [2/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 799 of file CreateIntegrationRequest.h.

◆ WithPayloadFormatVersion() [1/3]

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

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

Definition at line 836 of file CreateIntegrationRequest.h.

◆ WithPayloadFormatVersion() [2/3]

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

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

Definition at line 842 of file CreateIntegrationRequest.h.

◆ WithPayloadFormatVersion() [3/3]

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

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

Definition at line 848 of file CreateIntegrationRequest.h.

◆ WithRequestParameters() [1/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 954 of file CreateIntegrationRequest.h.

◆ WithRequestParameters() [2/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 975 of file CreateIntegrationRequest.h.

◆ WithRequestTemplates() [1/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1163 of file CreateIntegrationRequest.h.

◆ WithRequestTemplates() [2/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1171 of file CreateIntegrationRequest.h.

◆ WithTemplateSelectionExpression() [1/3]

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

The template selection expression for the integration.

Definition at line 1258 of file CreateIntegrationRequest.h.

◆ WithTemplateSelectionExpression() [2/3]

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

The template selection expression for the integration.

Definition at line 1263 of file CreateIntegrationRequest.h.

◆ WithTemplateSelectionExpression() [3/3]

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

The template selection expression for the integration.

Definition at line 1268 of file CreateIntegrationRequest.h.

◆ WithTimeoutInMillis()

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1297 of file CreateIntegrationRequest.h.

◆ WithTlsConfig() [1/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1333 of file CreateIntegrationRequest.h.

◆ WithTlsConfig() [2/2]

CreateIntegrationRequest& Aws::ApiGatewayV2::Model::CreateIntegrationRequest::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 1340 of file CreateIntegrationRequest.h.


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