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

#include <CreateApiRequest.h>

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

Public Member Functions

 CreateApiRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetApiKeySelectionExpression () const
 
bool ApiKeySelectionExpressionHasBeenSet () const
 
void SetApiKeySelectionExpression (const Aws::String &value)
 
void SetApiKeySelectionExpression (Aws::String &&value)
 
void SetApiKeySelectionExpression (const char *value)
 
CreateApiRequestWithApiKeySelectionExpression (const Aws::String &value)
 
CreateApiRequestWithApiKeySelectionExpression (Aws::String &&value)
 
CreateApiRequestWithApiKeySelectionExpression (const char *value)
 
const CorsGetCorsConfiguration () const
 
bool CorsConfigurationHasBeenSet () const
 
void SetCorsConfiguration (const Cors &value)
 
void SetCorsConfiguration (Cors &&value)
 
CreateApiRequestWithCorsConfiguration (const Cors &value)
 
CreateApiRequestWithCorsConfiguration (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)
 
CreateApiRequestWithCredentialsArn (const Aws::String &value)
 
CreateApiRequestWithCredentialsArn (Aws::String &&value)
 
CreateApiRequestWithCredentialsArn (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)
 
CreateApiRequestWithDescription (const Aws::String &value)
 
CreateApiRequestWithDescription (Aws::String &&value)
 
CreateApiRequestWithDescription (const char *value)
 
bool GetDisableSchemaValidation () const
 
bool DisableSchemaValidationHasBeenSet () const
 
void SetDisableSchemaValidation (bool value)
 
CreateApiRequestWithDisableSchemaValidation (bool value)
 
bool GetDisableExecuteApiEndpoint () const
 
bool DisableExecuteApiEndpointHasBeenSet () const
 
void SetDisableExecuteApiEndpoint (bool value)
 
CreateApiRequestWithDisableExecuteApiEndpoint (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)
 
CreateApiRequestWithName (const Aws::String &value)
 
CreateApiRequestWithName (Aws::String &&value)
 
CreateApiRequestWithName (const char *value)
 
const ProtocolTypeGetProtocolType () const
 
bool ProtocolTypeHasBeenSet () const
 
void SetProtocolType (const ProtocolType &value)
 
void SetProtocolType (ProtocolType &&value)
 
CreateApiRequestWithProtocolType (const ProtocolType &value)
 
CreateApiRequestWithProtocolType (ProtocolType &&value)
 
const Aws::StringGetRouteKey () const
 
bool RouteKeyHasBeenSet () const
 
void SetRouteKey (const Aws::String &value)
 
void SetRouteKey (Aws::String &&value)
 
void SetRouteKey (const char *value)
 
CreateApiRequestWithRouteKey (const Aws::String &value)
 
CreateApiRequestWithRouteKey (Aws::String &&value)
 
CreateApiRequestWithRouteKey (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)
 
CreateApiRequestWithRouteSelectionExpression (const Aws::String &value)
 
CreateApiRequestWithRouteSelectionExpression (Aws::String &&value)
 
CreateApiRequestWithRouteSelectionExpression (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateApiRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateApiRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateApiRequestAddTags (const Aws::String &key, const Aws::String &value)
 
CreateApiRequestAddTags (Aws::String &&key, const Aws::String &value)
 
CreateApiRequestAddTags (const Aws::String &key, Aws::String &&value)
 
CreateApiRequestAddTags (Aws::String &&key, Aws::String &&value)
 
CreateApiRequestAddTags (const char *key, Aws::String &&value)
 
CreateApiRequestAddTags (Aws::String &&key, const char *value)
 
CreateApiRequestAddTags (const char *key, 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)
 
CreateApiRequestWithTarget (const Aws::String &value)
 
CreateApiRequestWithTarget (Aws::String &&value)
 
CreateApiRequestWithTarget (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)
 
CreateApiRequestWithVersion (const Aws::String &value)
 
CreateApiRequestWithVersion (Aws::String &&value)
 
CreateApiRequestWithVersion (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

Creates a new Api resource to represent an API.

See Also:

AWS API Reference

Definition at line 27 of file CreateApiRequest.h.

Constructor & Destructor Documentation

◆ CreateApiRequest()

Aws::ApiGatewayV2::Model::CreateApiRequest::CreateApiRequest ( )

Member Function Documentation

◆ AddTags() [1/7]

CreateApiRequest& Aws::ApiGatewayV2::Model::CreateApiRequest::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 583 of file CreateApiRequest.h.

◆ AddTags() [2/7]

CreateApiRequest& Aws::ApiGatewayV2::Model::CreateApiRequest::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 589 of file CreateApiRequest.h.

◆ AddTags() [3/7]

CreateApiRequest& Aws::ApiGatewayV2::Model::CreateApiRequest::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 595 of file CreateApiRequest.h.

◆ AddTags() [4/7]

CreateApiRequest& Aws::ApiGatewayV2::Model::CreateApiRequest::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 601 of file CreateApiRequest.h.

◆ AddTags() [5/7]

CreateApiRequest& Aws::ApiGatewayV2::Model::CreateApiRequest::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 607 of file CreateApiRequest.h.

◆ AddTags() [6/7]

CreateApiRequest& Aws::ApiGatewayV2::Model::CreateApiRequest::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 613 of file CreateApiRequest.h.

◆ AddTags() [7/7]

CreateApiRequest& Aws::ApiGatewayV2::Model::CreateApiRequest::AddTags ( const char *  key,
const char *  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 619 of file CreateApiRequest.h.

◆ ApiKeySelectionExpressionHasBeenSet()

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

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

Definition at line 53 of file CreateApiRequest.h.

◆ CorsConfigurationHasBeenSet()

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

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Definition at line 110 of file CreateApiRequest.h.

◆ CredentialsArnHasBeenSet()

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

Definition at line 161 of file CreateApiRequest.h.

◆ DescriptionHasBeenSet()

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

The description of the API.

Definition at line 238 of file CreateApiRequest.h.

◆ DisableExecuteApiEndpointHasBeenSet()

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

◆ DisableSchemaValidationHasBeenSet()

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

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

Definition at line 281 of file CreateApiRequest.h.

◆ GetApiKeySelectionExpression()

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

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

Definition at line 46 of file CreateApiRequest.h.

◆ GetCorsConfiguration()

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

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Definition at line 103 of file CreateApiRequest.h.

◆ GetCredentialsArn()

const Aws::String& Aws::ApiGatewayV2::Model::CreateApiRequest::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. Supported only for HTTP APIs.

Definition at line 150 of file CreateApiRequest.h.

◆ GetDescription()

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

The description of the API.

Definition at line 233 of file CreateApiRequest.h.

◆ GetDisableExecuteApiEndpoint()

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

◆ GetDisableSchemaValidation()

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

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

Definition at line 275 of file CreateApiRequest.h.

◆ GetName()

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

The name of the API.

Definition at line 336 of file CreateApiRequest.h.

◆ GetProtocolType()

const ProtocolType& Aws::ApiGatewayV2::Model::CreateApiRequest::GetProtocolType ( ) const
inline

The API protocol.

Definition at line 377 of file CreateApiRequest.h.

◆ GetRouteKey()

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

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

Definition at line 412 of file CreateApiRequest.h.

◆ GetRouteSelectionExpression()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateApiRequest.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::ApiGatewayV2::Model::CreateApiRequest::GetTags ( ) const
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 547 of file CreateApiRequest.h.

◆ GetTarget()

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.

Definition at line 630 of file CreateApiRequest.h.

◆ GetVersion()

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

A version identifier for the API.

Definition at line 706 of file CreateApiRequest.h.

◆ NameHasBeenSet()

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

The name of the API.

Definition at line 341 of file CreateApiRequest.h.

◆ ProtocolTypeHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateApiRequest::ProtocolTypeHasBeenSet ( ) const
inline

The API protocol.

Definition at line 382 of file CreateApiRequest.h.

◆ RouteKeyHasBeenSet()

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

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

Definition at line 421 of file CreateApiRequest.h.

◆ RouteSelectionExpressionHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApiKeySelectionExpression() [1/3]

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

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

Definition at line 60 of file CreateApiRequest.h.

◆ SetApiKeySelectionExpression() [2/3]

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

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

Definition at line 67 of file CreateApiRequest.h.

◆ SetApiKeySelectionExpression() [3/3]

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

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

Definition at line 74 of file CreateApiRequest.h.

◆ SetCorsConfiguration() [1/2]

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

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Definition at line 117 of file CreateApiRequest.h.

◆ SetCorsConfiguration() [2/2]

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

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Definition at line 124 of file CreateApiRequest.h.

◆ SetCredentialsArn() [1/3]

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

Definition at line 172 of file CreateApiRequest.h.

◆ SetCredentialsArn() [2/3]

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

Definition at line 183 of file CreateApiRequest.h.

◆ SetCredentialsArn() [3/3]

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

Definition at line 194 of file CreateApiRequest.h.

◆ SetDescription() [1/3]

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

The description of the API.

Definition at line 243 of file CreateApiRequest.h.

◆ SetDescription() [2/3]

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

The description of the API.

Definition at line 248 of file CreateApiRequest.h.

◆ SetDescription() [3/3]

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

The description of the API.

Definition at line 253 of file CreateApiRequest.h.

◆ SetDisableExecuteApiEndpoint()

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

◆ SetDisableSchemaValidation()

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

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

Definition at line 287 of file CreateApiRequest.h.

◆ SetName() [1/3]

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

The name of the API.

Definition at line 346 of file CreateApiRequest.h.

◆ SetName() [2/3]

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

The name of the API.

Definition at line 351 of file CreateApiRequest.h.

◆ SetName() [3/3]

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

The name of the API.

Definition at line 356 of file CreateApiRequest.h.

◆ SetProtocolType() [1/2]

void Aws::ApiGatewayV2::Model::CreateApiRequest::SetProtocolType ( const ProtocolType value)
inline

The API protocol.

Definition at line 387 of file CreateApiRequest.h.

◆ SetProtocolType() [2/2]

void Aws::ApiGatewayV2::Model::CreateApiRequest::SetProtocolType ( ProtocolType &&  value)
inline

The API protocol.

Definition at line 392 of file CreateApiRequest.h.

◆ SetRouteKey() [1/3]

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

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

Definition at line 430 of file CreateApiRequest.h.

◆ SetRouteKey() [2/3]

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

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

Definition at line 439 of file CreateApiRequest.h.

◆ SetRouteKey() [3/3]

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

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

Definition at line 448 of file CreateApiRequest.h.

◆ SetRouteSelectionExpression() [1/3]

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

◆ SetRouteSelectionExpression() [2/3]

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

◆ SetRouteSelectionExpression() [3/3]

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

◆ SetTags() [1/2]

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

The collection of tags. Each tag element is associated with a given resource.

Definition at line 559 of file CreateApiRequest.h.

◆ SetTags() [2/2]

void Aws::ApiGatewayV2::Model::CreateApiRequest::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 565 of file CreateApiRequest.h.

◆ SetTarget() [1/3]

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.

Definition at line 650 of file CreateApiRequest.h.

◆ SetTarget() [2/3]

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.

Definition at line 660 of file CreateApiRequest.h.

◆ SetTarget() [3/3]

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.

Definition at line 670 of file CreateApiRequest.h.

◆ SetVersion() [1/3]

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

A version identifier for the API.

Definition at line 716 of file CreateApiRequest.h.

◆ SetVersion() [2/3]

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

A version identifier for the API.

Definition at line 721 of file CreateApiRequest.h.

◆ SetVersion() [3/3]

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

A version identifier for the API.

Definition at line 726 of file CreateApiRequest.h.

◆ TagsHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateApiRequest::TagsHasBeenSet ( ) const
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 553 of file CreateApiRequest.h.

◆ TargetHasBeenSet()

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.

Definition at line 640 of file CreateApiRequest.h.

◆ VersionHasBeenSet()

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

A version identifier for the API.

Definition at line 711 of file CreateApiRequest.h.

◆ WithApiKeySelectionExpression() [1/3]

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

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

Definition at line 81 of file CreateApiRequest.h.

◆ WithApiKeySelectionExpression() [2/3]

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

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

Definition at line 88 of file CreateApiRequest.h.

◆ WithApiKeySelectionExpression() [3/3]

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

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

Definition at line 95 of file CreateApiRequest.h.

◆ WithCorsConfiguration() [1/2]

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

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Definition at line 131 of file CreateApiRequest.h.

◆ WithCorsConfiguration() [2/2]

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

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Definition at line 138 of file CreateApiRequest.h.

◆ WithCredentialsArn() [1/3]

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

Definition at line 205 of file CreateApiRequest.h.

◆ WithCredentialsArn() [2/3]

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

Definition at line 216 of file CreateApiRequest.h.

◆ WithCredentialsArn() [3/3]

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

Definition at line 227 of file CreateApiRequest.h.

◆ WithDescription() [1/3]

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

The description of the API.

Definition at line 258 of file CreateApiRequest.h.

◆ WithDescription() [2/3]

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

The description of the API.

Definition at line 263 of file CreateApiRequest.h.

◆ WithDescription() [3/3]

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

The description of the API.

Definition at line 268 of file CreateApiRequest.h.

◆ WithDisableExecuteApiEndpoint()

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

◆ WithDisableSchemaValidation()

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

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

Definition at line 293 of file CreateApiRequest.h.

◆ WithName() [1/3]

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

The name of the API.

Definition at line 361 of file CreateApiRequest.h.

◆ WithName() [2/3]

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

The name of the API.

Definition at line 366 of file CreateApiRequest.h.

◆ WithName() [3/3]

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

The name of the API.

Definition at line 371 of file CreateApiRequest.h.

◆ WithProtocolType() [1/2]

CreateApiRequest& Aws::ApiGatewayV2::Model::CreateApiRequest::WithProtocolType ( const ProtocolType value)
inline

The API protocol.

Definition at line 397 of file CreateApiRequest.h.

◆ WithProtocolType() [2/2]

CreateApiRequest& Aws::ApiGatewayV2::Model::CreateApiRequest::WithProtocolType ( ProtocolType &&  value)
inline

The API protocol.

Definition at line 402 of file CreateApiRequest.h.

◆ WithRouteKey() [1/3]

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

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

Definition at line 457 of file CreateApiRequest.h.

◆ WithRouteKey() [2/3]

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

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

Definition at line 466 of file CreateApiRequest.h.

◆ WithRouteKey() [3/3]

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

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

Definition at line 475 of file CreateApiRequest.h.

◆ WithRouteSelectionExpression() [1/3]

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

◆ WithRouteSelectionExpression() [2/3]

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

◆ WithRouteSelectionExpression() [3/3]

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

◆ WithTags() [1/2]

CreateApiRequest& Aws::ApiGatewayV2::Model::CreateApiRequest::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 571 of file CreateApiRequest.h.

◆ WithTags() [2/2]

CreateApiRequest& Aws::ApiGatewayV2::Model::CreateApiRequest::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 577 of file CreateApiRequest.h.

◆ WithTarget() [1/3]

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.

Definition at line 680 of file CreateApiRequest.h.

◆ WithTarget() [2/3]

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.

Definition at line 690 of file CreateApiRequest.h.

◆ WithTarget() [3/3]

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.

Definition at line 700 of file CreateApiRequest.h.

◆ WithVersion() [1/3]

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

A version identifier for the API.

Definition at line 731 of file CreateApiRequest.h.

◆ WithVersion() [2/3]

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

A version identifier for the API.

Definition at line 736 of file CreateApiRequest.h.

◆ WithVersion() [3/3]

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

A version identifier for the API.

Definition at line 741 of file CreateApiRequest.h.


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