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

#include <Integration.h>

Public Member Functions

 Integration ()
 
 Integration (Aws::Utils::Json::JsonView jsonValue)
 
Integrationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetApiGatewayManaged () const
 
bool ApiGatewayManagedHasBeenSet () const
 
void SetApiGatewayManaged (bool value)
 
IntegrationWithApiGatewayManaged (bool value)
 
const Aws::StringGetConnectionId () const
 
bool ConnectionIdHasBeenSet () const
 
void SetConnectionId (const Aws::String &value)
 
void SetConnectionId (Aws::String &&value)
 
void SetConnectionId (const char *value)
 
IntegrationWithConnectionId (const Aws::String &value)
 
IntegrationWithConnectionId (Aws::String &&value)
 
IntegrationWithConnectionId (const char *value)
 
const ConnectionTypeGetConnectionType () const
 
bool ConnectionTypeHasBeenSet () const
 
void SetConnectionType (const ConnectionType &value)
 
void SetConnectionType (ConnectionType &&value)
 
IntegrationWithConnectionType (const ConnectionType &value)
 
IntegrationWithConnectionType (ConnectionType &&value)
 
const ContentHandlingStrategyGetContentHandlingStrategy () const
 
bool ContentHandlingStrategyHasBeenSet () const
 
void SetContentHandlingStrategy (const ContentHandlingStrategy &value)
 
void SetContentHandlingStrategy (ContentHandlingStrategy &&value)
 
IntegrationWithContentHandlingStrategy (const ContentHandlingStrategy &value)
 
IntegrationWithContentHandlingStrategy (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)
 
IntegrationWithCredentialsArn (const Aws::String &value)
 
IntegrationWithCredentialsArn (Aws::String &&value)
 
IntegrationWithCredentialsArn (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)
 
IntegrationWithDescription (const Aws::String &value)
 
IntegrationWithDescription (Aws::String &&value)
 
IntegrationWithDescription (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)
 
IntegrationWithIntegrationId (const Aws::String &value)
 
IntegrationWithIntegrationId (Aws::String &&value)
 
IntegrationWithIntegrationId (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)
 
IntegrationWithIntegrationMethod (const Aws::String &value)
 
IntegrationWithIntegrationMethod (Aws::String &&value)
 
IntegrationWithIntegrationMethod (const char *value)
 
const Aws::StringGetIntegrationResponseSelectionExpression () const
 
bool IntegrationResponseSelectionExpressionHasBeenSet () const
 
void SetIntegrationResponseSelectionExpression (const Aws::String &value)
 
void SetIntegrationResponseSelectionExpression (Aws::String &&value)
 
void SetIntegrationResponseSelectionExpression (const char *value)
 
IntegrationWithIntegrationResponseSelectionExpression (const Aws::String &value)
 
IntegrationWithIntegrationResponseSelectionExpression (Aws::String &&value)
 
IntegrationWithIntegrationResponseSelectionExpression (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)
 
IntegrationWithIntegrationSubtype (const Aws::String &value)
 
IntegrationWithIntegrationSubtype (Aws::String &&value)
 
IntegrationWithIntegrationSubtype (const char *value)
 
const IntegrationTypeGetIntegrationType () const
 
bool IntegrationTypeHasBeenSet () const
 
void SetIntegrationType (const IntegrationType &value)
 
void SetIntegrationType (IntegrationType &&value)
 
IntegrationWithIntegrationType (const IntegrationType &value)
 
IntegrationWithIntegrationType (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)
 
IntegrationWithIntegrationUri (const Aws::String &value)
 
IntegrationWithIntegrationUri (Aws::String &&value)
 
IntegrationWithIntegrationUri (const char *value)
 
const PassthroughBehaviorGetPassthroughBehavior () const
 
bool PassthroughBehaviorHasBeenSet () const
 
void SetPassthroughBehavior (const PassthroughBehavior &value)
 
void SetPassthroughBehavior (PassthroughBehavior &&value)
 
IntegrationWithPassthroughBehavior (const PassthroughBehavior &value)
 
IntegrationWithPassthroughBehavior (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)
 
IntegrationWithPayloadFormatVersion (const Aws::String &value)
 
IntegrationWithPayloadFormatVersion (Aws::String &&value)
 
IntegrationWithPayloadFormatVersion (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetRequestParameters () const
 
bool RequestParametersHasBeenSet () const
 
void SetRequestParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRequestParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
IntegrationWithRequestParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
IntegrationWithRequestParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
IntegrationAddRequestParameters (const Aws::String &key, const Aws::String &value)
 
IntegrationAddRequestParameters (Aws::String &&key, const Aws::String &value)
 
IntegrationAddRequestParameters (const Aws::String &key, Aws::String &&value)
 
IntegrationAddRequestParameters (Aws::String &&key, Aws::String &&value)
 
IntegrationAddRequestParameters (const char *key, Aws::String &&value)
 
IntegrationAddRequestParameters (Aws::String &&key, const char *value)
 
IntegrationAddRequestParameters (const char *key, const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetRequestTemplates () const
 
bool RequestTemplatesHasBeenSet () const
 
void SetRequestTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRequestTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
IntegrationWithRequestTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
IntegrationWithRequestTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
IntegrationAddRequestTemplates (const Aws::String &key, const Aws::String &value)
 
IntegrationAddRequestTemplates (Aws::String &&key, const Aws::String &value)
 
IntegrationAddRequestTemplates (const Aws::String &key, Aws::String &&value)
 
IntegrationAddRequestTemplates (Aws::String &&key, Aws::String &&value)
 
IntegrationAddRequestTemplates (const char *key, Aws::String &&value)
 
IntegrationAddRequestTemplates (Aws::String &&key, const char *value)
 
IntegrationAddRequestTemplates (const char *key, const char *value)
 
const Aws::StringGetTemplateSelectionExpression () const
 
bool TemplateSelectionExpressionHasBeenSet () const
 
void SetTemplateSelectionExpression (const Aws::String &value)
 
void SetTemplateSelectionExpression (Aws::String &&value)
 
void SetTemplateSelectionExpression (const char *value)
 
IntegrationWithTemplateSelectionExpression (const Aws::String &value)
 
IntegrationWithTemplateSelectionExpression (Aws::String &&value)
 
IntegrationWithTemplateSelectionExpression (const char *value)
 
int GetTimeoutInMillis () const
 
bool TimeoutInMillisHasBeenSet () const
 
void SetTimeoutInMillis (int value)
 
IntegrationWithTimeoutInMillis (int value)
 
const TlsConfigGetTlsConfig () const
 
bool TlsConfigHasBeenSet () const
 
void SetTlsConfig (const TlsConfig &value)
 
void SetTlsConfig (TlsConfig &&value)
 
IntegrationWithTlsConfig (const TlsConfig &value)
 
IntegrationWithTlsConfig (TlsConfig &&value)
 

Detailed Description

Represents an integration.

See Also:

AWS API Reference

Definition at line 37 of file Integration.h.

Constructor & Destructor Documentation

◆ Integration() [1/2]

Aws::ApiGatewayV2::Model::Integration::Integration ( )

◆ Integration() [2/2]

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

Member Function Documentation

◆ AddRequestParameters() [1/7]

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

◆ AddRequestParameters() [2/7]

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

◆ AddRequestParameters() [3/7]

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

◆ AddRequestParameters() [4/7]

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

◆ AddRequestParameters() [5/7]

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

◆ AddRequestParameters() [6/7]

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

◆ AddRequestParameters() [7/7]

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

◆ AddRequestTemplates() [1/7]

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1268 of file Integration.h.

◆ AddRequestTemplates() [2/7]

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1276 of file Integration.h.

◆ AddRequestTemplates() [3/7]

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1284 of file Integration.h.

◆ AddRequestTemplates() [4/7]

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1292 of file Integration.h.

◆ AddRequestTemplates() [5/7]

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1300 of file Integration.h.

◆ AddRequestTemplates() [6/7]

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1308 of file Integration.h.

◆ AddRequestTemplates() [7/7]

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1316 of file Integration.h.

◆ ApiGatewayManagedHasBeenSet()

bool Aws::ApiGatewayV2::Model::Integration::ApiGatewayManagedHasBeenSet ( ) const
inline

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

Definition at line 58 of file Integration.h.

◆ ConnectionIdHasBeenSet()

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

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

Definition at line 85 of file Integration.h.

◆ ConnectionTypeHasBeenSet()

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

◆ ContentHandlingStrategyHasBeenSet()

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

◆ CredentialsArnHasBeenSet()

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

◆ DescriptionHasBeenSet()

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

Represents the description of an integration.

Definition at line 335 of file Integration.h.

◆ GetApiGatewayManaged()

bool Aws::ApiGatewayV2::Model::Integration::GetApiGatewayManaged ( ) const
inline

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

Definition at line 51 of file Integration.h.

◆ GetConnectionId()

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

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

Definition at line 79 of file Integration.h.

◆ GetConnectionType()

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

◆ GetContentHandlingStrategy()

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

◆ GetCredentialsArn()

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

◆ GetDescription()

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

Represents the description of an integration.

Definition at line 330 of file Integration.h.

◆ GetIntegrationId()

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

Represents the identifier of an integration.

Definition at line 371 of file Integration.h.

◆ GetIntegrationMethod()

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

Specifies the integration's HTTP method type.

Definition at line 412 of file Integration.h.

◆ GetIntegrationResponseSelectionExpression()

const Aws::String& Aws::ApiGatewayV2::Model::Integration::GetIntegrationResponseSelectionExpression ( ) const
inline

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

Definition at line 456 of file Integration.h.

◆ GetIntegrationSubtype()

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

◆ GetIntegrationType()

const IntegrationType& Aws::ApiGatewayV2::Model::Integration::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.

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 597 of file Integration.h.

◆ GetIntegrationUri()

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

◆ GetPassthroughBehavior()

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

◆ GetPayloadFormatVersion()

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

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

Definition at line 895 of file Integration.h.

◆ GetRequestParameters()

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

◆ GetRequestTemplates()

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1220 of file Integration.h.

◆ GetTemplateSelectionExpression()

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

The template selection expression for the integration. Supported only for WebSocket APIs.

Definition at line 1323 of file Integration.h.

◆ GetTimeoutInMillis()

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

◆ GetTlsConfig()

const TlsConfig& Aws::ApiGatewayV2::Model::Integration::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 1402 of file Integration.h.

◆ IntegrationIdHasBeenSet()

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

Represents the identifier of an integration.

Definition at line 376 of file Integration.h.

◆ IntegrationMethodHasBeenSet()

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

Specifies the integration's HTTP method type.

Definition at line 417 of file Integration.h.

◆ IntegrationResponseSelectionExpressionHasBeenSet()

bool Aws::ApiGatewayV2::Model::Integration::IntegrationResponseSelectionExpressionHasBeenSet ( ) const
inline

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

Definition at line 464 of file Integration.h.

◆ IntegrationSubtypeHasBeenSet()

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

◆ IntegrationTypeHasBeenSet()

bool Aws::ApiGatewayV2::Model::Integration::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.

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 616 of file Integration.h.

◆ IntegrationUriHasBeenSet()

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

◆ Jsonize()

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

◆ operator=()

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

◆ PassthroughBehaviorHasBeenSet()

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

◆ PayloadFormatVersionHasBeenSet()

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

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

Definition at line 901 of file Integration.h.

◆ RequestParametersHasBeenSet()

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

◆ RequestTemplatesHasBeenSet()

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1228 of file Integration.h.

◆ SetApiGatewayManaged()

void Aws::ApiGatewayV2::Model::Integration::SetApiGatewayManaged ( bool  value)
inline

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

Definition at line 65 of file Integration.h.

◆ SetConnectionId() [1/3]

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

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

Definition at line 91 of file Integration.h.

◆ SetConnectionId() [2/3]

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

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

Definition at line 97 of file Integration.h.

◆ SetConnectionId() [3/3]

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

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

Definition at line 103 of file Integration.h.

◆ SetConnectionType() [1/2]

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

◆ SetConnectionType() [2/2]

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

◆ SetContentHandlingStrategy() [1/2]

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

◆ SetContentHandlingStrategy() [2/2]

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

◆ SetCredentialsArn() [1/3]

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

◆ SetCredentialsArn() [2/3]

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

◆ SetCredentialsArn() [3/3]

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

◆ SetDescription() [1/3]

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

Represents the description of an integration.

Definition at line 340 of file Integration.h.

◆ SetDescription() [2/3]

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

Represents the description of an integration.

Definition at line 345 of file Integration.h.

◆ SetDescription() [3/3]

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

Represents the description of an integration.

Definition at line 350 of file Integration.h.

◆ SetIntegrationId() [1/3]

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

Represents the identifier of an integration.

Definition at line 381 of file Integration.h.

◆ SetIntegrationId() [2/3]

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

Represents the identifier of an integration.

Definition at line 386 of file Integration.h.

◆ SetIntegrationId() [3/3]

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

Represents the identifier of an integration.

Definition at line 391 of file Integration.h.

◆ SetIntegrationMethod() [1/3]

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

Specifies the integration's HTTP method type.

Definition at line 422 of file Integration.h.

◆ SetIntegrationMethod() [2/3]

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

Specifies the integration's HTTP method type.

Definition at line 427 of file Integration.h.

◆ SetIntegrationMethod() [3/3]

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

Specifies the integration's HTTP method type.

Definition at line 432 of file Integration.h.

◆ SetIntegrationResponseSelectionExpression() [1/3]

void Aws::ApiGatewayV2::Model::Integration::SetIntegrationResponseSelectionExpression ( const Aws::String value)
inline

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

Definition at line 472 of file Integration.h.

◆ SetIntegrationResponseSelectionExpression() [2/3]

void Aws::ApiGatewayV2::Model::Integration::SetIntegrationResponseSelectionExpression ( Aws::String &&  value)
inline

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

Definition at line 480 of file Integration.h.

◆ SetIntegrationResponseSelectionExpression() [3/3]

void Aws::ApiGatewayV2::Model::Integration::SetIntegrationResponseSelectionExpression ( const char *  value)
inline

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

Definition at line 488 of file Integration.h.

◆ SetIntegrationSubtype() [1/3]

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

◆ SetIntegrationSubtype() [2/3]

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

◆ SetIntegrationSubtype() [3/3]

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

◆ SetIntegrationType() [1/2]

void Aws::ApiGatewayV2::Model::Integration::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.

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 635 of file Integration.h.

◆ SetIntegrationType() [2/2]

void Aws::ApiGatewayV2::Model::Integration::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.

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 654 of file Integration.h.

◆ SetIntegrationUri() [1/3]

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

◆ SetIntegrationUri() [2/3]

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

◆ SetIntegrationUri() [3/3]

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

◆ SetPassthroughBehavior() [1/2]

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

◆ SetPassthroughBehavior() [2/2]

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

◆ SetPayloadFormatVersion() [1/3]

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

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

Definition at line 907 of file Integration.h.

◆ SetPayloadFormatVersion() [2/3]

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

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

Definition at line 913 of file Integration.h.

◆ SetPayloadFormatVersion() [3/3]

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

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

Definition at line 919 of file Integration.h.

◆ SetRequestParameters() [1/2]

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

◆ SetRequestParameters() [2/2]

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

◆ SetRequestTemplates() [1/2]

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1236 of file Integration.h.

◆ SetRequestTemplates() [2/2]

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1244 of file Integration.h.

◆ SetTemplateSelectionExpression() [1/3]

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

The template selection expression for the integration. Supported only for WebSocket APIs.

Definition at line 1335 of file Integration.h.

◆ SetTemplateSelectionExpression() [2/3]

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

The template selection expression for the integration. Supported only for WebSocket APIs.

Definition at line 1341 of file Integration.h.

◆ SetTemplateSelectionExpression() [3/3]

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

The template selection expression for the integration. Supported only for WebSocket APIs.

Definition at line 1347 of file Integration.h.

◆ SetTimeoutInMillis()

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

◆ SetTlsConfig() [1/2]

void Aws::ApiGatewayV2::Model::Integration::SetTlsConfig ( const TlsConfig 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 1416 of file Integration.h.

◆ SetTlsConfig() [2/2]

void Aws::ApiGatewayV2::Model::Integration::SetTlsConfig ( TlsConfig &&  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 1423 of file Integration.h.

◆ TemplateSelectionExpressionHasBeenSet()

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

The template selection expression for the integration. Supported only for WebSocket APIs.

Definition at line 1329 of file Integration.h.

◆ TimeoutInMillisHasBeenSet()

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

◆ TlsConfigHasBeenSet()

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

◆ WithApiGatewayManaged()

Integration& Aws::ApiGatewayV2::Model::Integration::WithApiGatewayManaged ( bool  value)
inline

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

Definition at line 72 of file Integration.h.

◆ WithConnectionId() [1/3]

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

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

Definition at line 109 of file Integration.h.

◆ WithConnectionId() [2/3]

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

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

Definition at line 115 of file Integration.h.

◆ WithConnectionId() [3/3]

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

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

Definition at line 121 of file Integration.h.

◆ WithConnectionType() [1/2]

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

◆ WithConnectionType() [2/2]

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

◆ WithContentHandlingStrategy() [1/2]

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

◆ WithContentHandlingStrategy() [2/2]

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

◆ WithCredentialsArn() [1/3]

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

◆ WithCredentialsArn() [2/3]

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

◆ WithCredentialsArn() [3/3]

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

◆ WithDescription() [1/3]

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

Represents the description of an integration.

Definition at line 355 of file Integration.h.

◆ WithDescription() [2/3]

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

Represents the description of an integration.

Definition at line 360 of file Integration.h.

◆ WithDescription() [3/3]

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

Represents the description of an integration.

Definition at line 365 of file Integration.h.

◆ WithIntegrationId() [1/3]

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

Represents the identifier of an integration.

Definition at line 396 of file Integration.h.

◆ WithIntegrationId() [2/3]

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

Represents the identifier of an integration.

Definition at line 401 of file Integration.h.

◆ WithIntegrationId() [3/3]

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

Represents the identifier of an integration.

Definition at line 406 of file Integration.h.

◆ WithIntegrationMethod() [1/3]

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

Specifies the integration's HTTP method type.

Definition at line 437 of file Integration.h.

◆ WithIntegrationMethod() [2/3]

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

Specifies the integration's HTTP method type.

Definition at line 442 of file Integration.h.

◆ WithIntegrationMethod() [3/3]

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

Specifies the integration's HTTP method type.

Definition at line 447 of file Integration.h.

◆ WithIntegrationResponseSelectionExpression() [1/3]

Integration& Aws::ApiGatewayV2::Model::Integration::WithIntegrationResponseSelectionExpression ( const Aws::String value)
inline

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

Definition at line 496 of file Integration.h.

◆ WithIntegrationResponseSelectionExpression() [2/3]

Integration& Aws::ApiGatewayV2::Model::Integration::WithIntegrationResponseSelectionExpression ( Aws::String &&  value)
inline

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

Definition at line 504 of file Integration.h.

◆ WithIntegrationResponseSelectionExpression() [3/3]

Integration& Aws::ApiGatewayV2::Model::Integration::WithIntegrationResponseSelectionExpression ( const char *  value)
inline

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

Definition at line 512 of file Integration.h.

◆ WithIntegrationSubtype() [1/3]

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

◆ WithIntegrationSubtype() [2/3]

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

◆ WithIntegrationSubtype() [3/3]

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

◆ WithIntegrationType() [1/2]

Integration& Aws::ApiGatewayV2::Model::Integration::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.

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 673 of file Integration.h.

◆ WithIntegrationType() [2/2]

Integration& Aws::ApiGatewayV2::Model::Integration::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.

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 692 of file Integration.h.

◆ WithIntegrationUri() [1/3]

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

◆ WithIntegrationUri() [2/3]

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

◆ WithIntegrationUri() [3/3]

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

◆ WithPassthroughBehavior() [1/2]

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

◆ WithPassthroughBehavior() [2/2]

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

◆ WithPayloadFormatVersion() [1/3]

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

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

Definition at line 925 of file Integration.h.

◆ WithPayloadFormatVersion() [2/3]

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

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

Definition at line 931 of file Integration.h.

◆ WithPayloadFormatVersion() [3/3]

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

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

Definition at line 937 of file Integration.h.

◆ WithRequestParameters() [1/2]

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

◆ WithRequestParameters() [2/2]

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

◆ WithRequestTemplates() [1/2]

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1252 of file Integration.h.

◆ WithRequestTemplates() [2/2]

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

Definition at line 1260 of file Integration.h.

◆ WithTemplateSelectionExpression() [1/3]

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

The template selection expression for the integration. Supported only for WebSocket APIs.

Definition at line 1353 of file Integration.h.

◆ WithTemplateSelectionExpression() [2/3]

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

The template selection expression for the integration. Supported only for WebSocket APIs.

Definition at line 1359 of file Integration.h.

◆ WithTemplateSelectionExpression() [3/3]

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

The template selection expression for the integration. Supported only for WebSocket APIs.

Definition at line 1365 of file Integration.h.

◆ WithTimeoutInMillis()

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

◆ WithTlsConfig() [1/2]

Integration& Aws::ApiGatewayV2::Model::Integration::WithTlsConfig ( const TlsConfig 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 1430 of file Integration.h.

◆ WithTlsConfig() [2/2]

Integration& Aws::ApiGatewayV2::Model::Integration::WithTlsConfig ( TlsConfig &&  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 1437 of file Integration.h.


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