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

#include <UpdateApiRequest.h>

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

Public Member Functions

 UpdateApiRequest ()
 
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)
 
UpdateApiRequestWithApiId (const Aws::String &value)
 
UpdateApiRequestWithApiId (Aws::String &&value)
 
UpdateApiRequestWithApiId (const char *value)
 
const Aws::StringGetApiKeySelectionExpression () const
 
bool ApiKeySelectionExpressionHasBeenSet () const
 
void SetApiKeySelectionExpression (const Aws::String &value)
 
void SetApiKeySelectionExpression (Aws::String &&value)
 
void SetApiKeySelectionExpression (const char *value)
 
UpdateApiRequestWithApiKeySelectionExpression (const Aws::String &value)
 
UpdateApiRequestWithApiKeySelectionExpression (Aws::String &&value)
 
UpdateApiRequestWithApiKeySelectionExpression (const char *value)
 
const CorsGetCorsConfiguration () const
 
bool CorsConfigurationHasBeenSet () const
 
void SetCorsConfiguration (const Cors &value)
 
void SetCorsConfiguration (Cors &&value)
 
UpdateApiRequestWithCorsConfiguration (const Cors &value)
 
UpdateApiRequestWithCorsConfiguration (Cors &&value)
 
const Aws::StringGetCredentialsArn () const
 
bool CredentialsArnHasBeenSet () const
 
void SetCredentialsArn (const Aws::String &value)
 
void SetCredentialsArn (Aws::String &&value)
 
void SetCredentialsArn (const char *value)
 
UpdateApiRequestWithCredentialsArn (const Aws::String &value)
 
UpdateApiRequestWithCredentialsArn (Aws::String &&value)
 
UpdateApiRequestWithCredentialsArn (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)
 
UpdateApiRequestWithDescription (const Aws::String &value)
 
UpdateApiRequestWithDescription (Aws::String &&value)
 
UpdateApiRequestWithDescription (const char *value)
 
bool GetDisableSchemaValidation () const
 
bool DisableSchemaValidationHasBeenSet () const
 
void SetDisableSchemaValidation (bool value)
 
UpdateApiRequestWithDisableSchemaValidation (bool value)
 
bool GetDisableExecuteApiEndpoint () const
 
bool DisableExecuteApiEndpointHasBeenSet () const
 
void SetDisableExecuteApiEndpoint (bool value)
 
UpdateApiRequestWithDisableExecuteApiEndpoint (bool value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateApiRequestWithName (const Aws::String &value)
 
UpdateApiRequestWithName (Aws::String &&value)
 
UpdateApiRequestWithName (const char *value)
 
const Aws::StringGetRouteKey () const
 
bool RouteKeyHasBeenSet () const
 
void SetRouteKey (const Aws::String &value)
 
void SetRouteKey (Aws::String &&value)
 
void SetRouteKey (const char *value)
 
UpdateApiRequestWithRouteKey (const Aws::String &value)
 
UpdateApiRequestWithRouteKey (Aws::String &&value)
 
UpdateApiRequestWithRouteKey (const char *value)
 
const Aws::StringGetRouteSelectionExpression () const
 
bool RouteSelectionExpressionHasBeenSet () const
 
void SetRouteSelectionExpression (const Aws::String &value)
 
void SetRouteSelectionExpression (Aws::String &&value)
 
void SetRouteSelectionExpression (const char *value)
 
UpdateApiRequestWithRouteSelectionExpression (const Aws::String &value)
 
UpdateApiRequestWithRouteSelectionExpression (Aws::String &&value)
 
UpdateApiRequestWithRouteSelectionExpression (const char *value)
 
const Aws::StringGetTarget () const
 
bool TargetHasBeenSet () const
 
void SetTarget (const Aws::String &value)
 
void SetTarget (Aws::String &&value)
 
void SetTarget (const char *value)
 
UpdateApiRequestWithTarget (const Aws::String &value)
 
UpdateApiRequestWithTarget (Aws::String &&value)
 
UpdateApiRequestWithTarget (const char *value)
 
const Aws::StringGetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
UpdateApiRequestWithVersion (const Aws::String &value)
 
UpdateApiRequestWithVersion (Aws::String &&value)
 
UpdateApiRequestWithVersion (const char *value)
 
- Public Member Functions inherited from Aws::ApiGatewayV2::ApiGatewayV2Request
virtual ~ApiGatewayV2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

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

Detailed Description

Updates an Api.

See Also:

AWS API Reference

Definition at line 25 of file UpdateApiRequest.h.

Constructor & Destructor Documentation

◆ UpdateApiRequest()

Aws::ApiGatewayV2::Model::UpdateApiRequest::UpdateApiRequest ( )

Member Function Documentation

◆ ApiIdHasBeenSet()

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

The API identifier.

Definition at line 47 of file UpdateApiRequest.h.

◆ ApiKeySelectionExpressionHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateApiRequest::ApiKeySelectionExpressionHasBeenSet ( ) const
inline

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

Definition at line 92 of file UpdateApiRequest.h.

◆ CorsConfigurationHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateApiRequest::CorsConfigurationHasBeenSet ( ) const
inline

A CORS configuration. Supported only for HTTP APIs.

Definition at line 145 of file UpdateApiRequest.h.

◆ CredentialsArnHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateApiRequest::CredentialsArnHasBeenSet ( ) const
inline

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/ *. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Definition at line 190 of file UpdateApiRequest.h.

◆ DescriptionHasBeenSet()

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

The description of the API.

Definition at line 273 of file UpdateApiRequest.h.

◆ DisableExecuteApiEndpointHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateApiRequest::DisableExecuteApiEndpointHasBeenSet ( ) const
inline

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Definition at line 347 of file UpdateApiRequest.h.

◆ DisableSchemaValidationHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateApiRequest::DisableSchemaValidationHasBeenSet ( ) const
inline

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

Definition at line 316 of file UpdateApiRequest.h.

◆ GetApiId()

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

The API identifier.

Definition at line 42 of file UpdateApiRequest.h.

◆ GetApiKeySelectionExpression()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateApiRequest::GetApiKeySelectionExpression ( ) const
inline

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

Definition at line 85 of file UpdateApiRequest.h.

◆ GetCorsConfiguration()

const Cors& Aws::ApiGatewayV2::Model::UpdateApiRequest::GetCorsConfiguration ( ) const
inline

A CORS configuration. Supported only for HTTP APIs.

Definition at line 140 of file UpdateApiRequest.h.

◆ GetCredentialsArn()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateApiRequest::GetCredentialsArn ( ) const
inline

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/ *. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Definition at line 178 of file UpdateApiRequest.h.

◆ GetDescription()

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

The description of the API.

Definition at line 268 of file UpdateApiRequest.h.

◆ GetDisableExecuteApiEndpoint()

bool Aws::ApiGatewayV2::Model::UpdateApiRequest::GetDisableExecuteApiEndpoint ( ) const
inline

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Definition at line 338 of file UpdateApiRequest.h.

◆ GetDisableSchemaValidation()

bool Aws::ApiGatewayV2::Model::UpdateApiRequest::GetDisableSchemaValidation ( ) const
inline

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

Definition at line 310 of file UpdateApiRequest.h.

◆ GetName()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateApiRequest::GetName ( ) const
inline

The name of the API.

Definition at line 371 of file UpdateApiRequest.h.

◆ GetRouteKey()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateApiRequest::GetRouteKey ( ) const
inline

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

Definition at line 415 of file UpdateApiRequest.h.

◆ GetRouteSelectionExpression()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateApiRequest::GetRouteSelectionExpression ( ) const
inline

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Definition at line 480 of file UpdateApiRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file UpdateApiRequest.h.

◆ GetTarget()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateApiRequest::GetTarget ( ) const
inline

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

Definition at line 546 of file UpdateApiRequest.h.

◆ GetVersion()

const Aws::String& Aws::ApiGatewayV2::Model::UpdateApiRequest::GetVersion ( ) const
inline

A version identifier for the API.

Definition at line 615 of file UpdateApiRequest.h.

◆ NameHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateApiRequest::NameHasBeenSet ( ) const
inline

The name of the API.

Definition at line 376 of file UpdateApiRequest.h.

◆ RouteKeyHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateApiRequest::RouteKeyHasBeenSet ( ) const
inline

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

Definition at line 423 of file UpdateApiRequest.h.

◆ RouteSelectionExpressionHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateApiRequest::RouteSelectionExpressionHasBeenSet ( ) const
inline

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Definition at line 488 of file UpdateApiRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApiId() [1/3]

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

The API identifier.

Definition at line 52 of file UpdateApiRequest.h.

◆ SetApiId() [2/3]

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

The API identifier.

Definition at line 57 of file UpdateApiRequest.h.

◆ SetApiId() [3/3]

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

The API identifier.

Definition at line 62 of file UpdateApiRequest.h.

◆ SetApiKeySelectionExpression() [1/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetApiKeySelectionExpression ( const Aws::String value)
inline

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

Definition at line 99 of file UpdateApiRequest.h.

◆ SetApiKeySelectionExpression() [2/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetApiKeySelectionExpression ( Aws::String &&  value)
inline

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

Definition at line 106 of file UpdateApiRequest.h.

◆ SetApiKeySelectionExpression() [3/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetApiKeySelectionExpression ( const char *  value)
inline

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

Definition at line 113 of file UpdateApiRequest.h.

◆ SetCorsConfiguration() [1/2]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetCorsConfiguration ( const Cors value)
inline

A CORS configuration. Supported only for HTTP APIs.

Definition at line 150 of file UpdateApiRequest.h.

◆ SetCorsConfiguration() [2/2]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetCorsConfiguration ( Cors &&  value)
inline

A CORS configuration. Supported only for HTTP APIs.

Definition at line 155 of file UpdateApiRequest.h.

◆ SetCredentialsArn() [1/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetCredentialsArn ( const Aws::String value)
inline

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/ *. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Definition at line 202 of file UpdateApiRequest.h.

◆ SetCredentialsArn() [2/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetCredentialsArn ( Aws::String &&  value)
inline

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/ *. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Definition at line 214 of file UpdateApiRequest.h.

◆ SetCredentialsArn() [3/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetCredentialsArn ( const char *  value)
inline

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/ *. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Definition at line 226 of file UpdateApiRequest.h.

◆ SetDescription() [1/3]

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

The description of the API.

Definition at line 278 of file UpdateApiRequest.h.

◆ SetDescription() [2/3]

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

The description of the API.

Definition at line 283 of file UpdateApiRequest.h.

◆ SetDescription() [3/3]

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

The description of the API.

Definition at line 288 of file UpdateApiRequest.h.

◆ SetDisableExecuteApiEndpoint()

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetDisableExecuteApiEndpoint ( bool  value)
inline

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Definition at line 356 of file UpdateApiRequest.h.

◆ SetDisableSchemaValidation()

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetDisableSchemaValidation ( bool  value)
inline

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

Definition at line 322 of file UpdateApiRequest.h.

◆ SetName() [1/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetName ( const Aws::String value)
inline

The name of the API.

Definition at line 381 of file UpdateApiRequest.h.

◆ SetName() [2/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetName ( Aws::String &&  value)
inline

The name of the API.

Definition at line 386 of file UpdateApiRequest.h.

◆ SetName() [3/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetName ( const char *  value)
inline

The name of the API.

Definition at line 391 of file UpdateApiRequest.h.

◆ SetRouteKey() [1/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetRouteKey ( const Aws::String value)
inline

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

Definition at line 431 of file UpdateApiRequest.h.

◆ SetRouteKey() [2/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetRouteKey ( Aws::String &&  value)
inline

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

Definition at line 439 of file UpdateApiRequest.h.

◆ SetRouteKey() [3/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetRouteKey ( const char *  value)
inline

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

Definition at line 447 of file UpdateApiRequest.h.

◆ SetRouteSelectionExpression() [1/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetRouteSelectionExpression ( const Aws::String value)
inline

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Definition at line 496 of file UpdateApiRequest.h.

◆ SetRouteSelectionExpression() [2/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetRouteSelectionExpression ( Aws::String &&  value)
inline

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Definition at line 504 of file UpdateApiRequest.h.

◆ SetRouteSelectionExpression() [3/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetRouteSelectionExpression ( const char *  value)
inline

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Definition at line 512 of file UpdateApiRequest.h.

◆ SetTarget() [1/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetTarget ( const Aws::String value)
inline

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

Definition at line 564 of file UpdateApiRequest.h.

◆ SetTarget() [2/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetTarget ( Aws::String &&  value)
inline

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

Definition at line 573 of file UpdateApiRequest.h.

◆ SetTarget() [3/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetTarget ( const char *  value)
inline

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

Definition at line 582 of file UpdateApiRequest.h.

◆ SetVersion() [1/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetVersion ( const Aws::String value)
inline

A version identifier for the API.

Definition at line 625 of file UpdateApiRequest.h.

◆ SetVersion() [2/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetVersion ( Aws::String &&  value)
inline

A version identifier for the API.

Definition at line 630 of file UpdateApiRequest.h.

◆ SetVersion() [3/3]

void Aws::ApiGatewayV2::Model::UpdateApiRequest::SetVersion ( const char *  value)
inline

A version identifier for the API.

Definition at line 635 of file UpdateApiRequest.h.

◆ TargetHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateApiRequest::TargetHasBeenSet ( ) const
inline

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

Definition at line 555 of file UpdateApiRequest.h.

◆ VersionHasBeenSet()

bool Aws::ApiGatewayV2::Model::UpdateApiRequest::VersionHasBeenSet ( ) const
inline

A version identifier for the API.

Definition at line 620 of file UpdateApiRequest.h.

◆ WithApiId() [1/3]

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

The API identifier.

Definition at line 67 of file UpdateApiRequest.h.

◆ WithApiId() [2/3]

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

The API identifier.

Definition at line 72 of file UpdateApiRequest.h.

◆ WithApiId() [3/3]

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

The API identifier.

Definition at line 77 of file UpdateApiRequest.h.

◆ WithApiKeySelectionExpression() [1/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithApiKeySelectionExpression ( const Aws::String value)
inline

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

Definition at line 120 of file UpdateApiRequest.h.

◆ WithApiKeySelectionExpression() [2/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithApiKeySelectionExpression ( Aws::String &&  value)
inline

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

Definition at line 127 of file UpdateApiRequest.h.

◆ WithApiKeySelectionExpression() [3/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithApiKeySelectionExpression ( const char *  value)
inline

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

Definition at line 134 of file UpdateApiRequest.h.

◆ WithCorsConfiguration() [1/2]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithCorsConfiguration ( const Cors value)
inline

A CORS configuration. Supported only for HTTP APIs.

Definition at line 160 of file UpdateApiRequest.h.

◆ WithCorsConfiguration() [2/2]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithCorsConfiguration ( Cors &&  value)
inline

A CORS configuration. Supported only for HTTP APIs.

Definition at line 165 of file UpdateApiRequest.h.

◆ WithCredentialsArn() [1/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithCredentialsArn ( const Aws::String value)
inline

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/ *. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Definition at line 238 of file UpdateApiRequest.h.

◆ WithCredentialsArn() [2/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithCredentialsArn ( Aws::String &&  value)
inline

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/ *. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Definition at line 250 of file UpdateApiRequest.h.

◆ WithCredentialsArn() [3/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithCredentialsArn ( const char *  value)
inline

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/ *. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Definition at line 262 of file UpdateApiRequest.h.

◆ WithDescription() [1/3]

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

The description of the API.

Definition at line 293 of file UpdateApiRequest.h.

◆ WithDescription() [2/3]

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

The description of the API.

Definition at line 298 of file UpdateApiRequest.h.

◆ WithDescription() [3/3]

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

The description of the API.

Definition at line 303 of file UpdateApiRequest.h.

◆ WithDisableExecuteApiEndpoint()

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithDisableExecuteApiEndpoint ( bool  value)
inline

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Definition at line 365 of file UpdateApiRequest.h.

◆ WithDisableSchemaValidation()

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithDisableSchemaValidation ( bool  value)
inline

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

Definition at line 328 of file UpdateApiRequest.h.

◆ WithName() [1/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithName ( const Aws::String value)
inline

The name of the API.

Definition at line 396 of file UpdateApiRequest.h.

◆ WithName() [2/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithName ( Aws::String &&  value)
inline

The name of the API.

Definition at line 401 of file UpdateApiRequest.h.

◆ WithName() [3/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithName ( const char *  value)
inline

The name of the API.

Definition at line 406 of file UpdateApiRequest.h.

◆ WithRouteKey() [1/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithRouteKey ( const Aws::String value)
inline

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

Definition at line 455 of file UpdateApiRequest.h.

◆ WithRouteKey() [2/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithRouteKey ( Aws::String &&  value)
inline

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

Definition at line 463 of file UpdateApiRequest.h.

◆ WithRouteKey() [3/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithRouteKey ( const char *  value)
inline

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

Definition at line 471 of file UpdateApiRequest.h.

◆ WithRouteSelectionExpression() [1/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithRouteSelectionExpression ( const Aws::String value)
inline

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Definition at line 520 of file UpdateApiRequest.h.

◆ WithRouteSelectionExpression() [2/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithRouteSelectionExpression ( Aws::String &&  value)
inline

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Definition at line 528 of file UpdateApiRequest.h.

◆ WithRouteSelectionExpression() [3/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithRouteSelectionExpression ( const char *  value)
inline

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Definition at line 536 of file UpdateApiRequest.h.

◆ WithTarget() [1/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithTarget ( const Aws::String value)
inline

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

Definition at line 591 of file UpdateApiRequest.h.

◆ WithTarget() [2/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithTarget ( Aws::String &&  value)
inline

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

Definition at line 600 of file UpdateApiRequest.h.

◆ WithTarget() [3/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithTarget ( const char *  value)
inline

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

Definition at line 609 of file UpdateApiRequest.h.

◆ WithVersion() [1/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithVersion ( const Aws::String value)
inline

A version identifier for the API.

Definition at line 640 of file UpdateApiRequest.h.

◆ WithVersion() [2/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithVersion ( Aws::String &&  value)
inline

A version identifier for the API.

Definition at line 645 of file UpdateApiRequest.h.

◆ WithVersion() [3/3]

UpdateApiRequest& Aws::ApiGatewayV2::Model::UpdateApiRequest::WithVersion ( const char *  value)
inline

A version identifier for the API.

Definition at line 650 of file UpdateApiRequest.h.


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