AWS SDK for C++  1.9.124
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::CreateRestApiResult Class Reference

#include <CreateRestApiResult.h>

Public Member Functions

 CreateRestApiResult ()
 
 CreateRestApiResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
CreateRestApiResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetId () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
CreateRestApiResultWithId (const Aws::String &value)
 
CreateRestApiResultWithId (Aws::String &&value)
 
CreateRestApiResultWithId (const char *value)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateRestApiResultWithName (const Aws::String &value)
 
CreateRestApiResultWithName (Aws::String &&value)
 
CreateRestApiResultWithName (const char *value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateRestApiResultWithDescription (const Aws::String &value)
 
CreateRestApiResultWithDescription (Aws::String &&value)
 
CreateRestApiResultWithDescription (const char *value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
CreateRestApiResultWithCreatedDate (const Aws::Utils::DateTime &value)
 
CreateRestApiResultWithCreatedDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetVersion () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
CreateRestApiResultWithVersion (const Aws::String &value)
 
CreateRestApiResultWithVersion (Aws::String &&value)
 
CreateRestApiResultWithVersion (const char *value)
 
const Aws::Vector< Aws::String > & GetWarnings () const
 
void SetWarnings (const Aws::Vector< Aws::String > &value)
 
void SetWarnings (Aws::Vector< Aws::String > &&value)
 
CreateRestApiResultWithWarnings (const Aws::Vector< Aws::String > &value)
 
CreateRestApiResultWithWarnings (Aws::Vector< Aws::String > &&value)
 
CreateRestApiResultAddWarnings (const Aws::String &value)
 
CreateRestApiResultAddWarnings (Aws::String &&value)
 
CreateRestApiResultAddWarnings (const char *value)
 
const Aws::Vector< Aws::String > & GetBinaryMediaTypes () const
 
void SetBinaryMediaTypes (const Aws::Vector< Aws::String > &value)
 
void SetBinaryMediaTypes (Aws::Vector< Aws::String > &&value)
 
CreateRestApiResultWithBinaryMediaTypes (const Aws::Vector< Aws::String > &value)
 
CreateRestApiResultWithBinaryMediaTypes (Aws::Vector< Aws::String > &&value)
 
CreateRestApiResultAddBinaryMediaTypes (const Aws::String &value)
 
CreateRestApiResultAddBinaryMediaTypes (Aws::String &&value)
 
CreateRestApiResultAddBinaryMediaTypes (const char *value)
 
int GetMinimumCompressionSize () const
 
void SetMinimumCompressionSize (int value)
 
CreateRestApiResultWithMinimumCompressionSize (int value)
 
const ApiKeySourceTypeGetApiKeySource () const
 
void SetApiKeySource (const ApiKeySourceType &value)
 
void SetApiKeySource (ApiKeySourceType &&value)
 
CreateRestApiResultWithApiKeySource (const ApiKeySourceType &value)
 
CreateRestApiResultWithApiKeySource (ApiKeySourceType &&value)
 
const EndpointConfigurationGetEndpointConfiguration () const
 
void SetEndpointConfiguration (const EndpointConfiguration &value)
 
void SetEndpointConfiguration (EndpointConfiguration &&value)
 
CreateRestApiResultWithEndpointConfiguration (const EndpointConfiguration &value)
 
CreateRestApiResultWithEndpointConfiguration (EndpointConfiguration &&value)
 
const Aws::StringGetPolicy () const
 
void SetPolicy (const Aws::String &value)
 
void SetPolicy (Aws::String &&value)
 
void SetPolicy (const char *value)
 
CreateRestApiResultWithPolicy (const Aws::String &value)
 
CreateRestApiResultWithPolicy (Aws::String &&value)
 
CreateRestApiResultWithPolicy (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateRestApiResultWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateRestApiResultWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateRestApiResultAddTags (const Aws::String &key, const Aws::String &value)
 
CreateRestApiResultAddTags (Aws::String &&key, const Aws::String &value)
 
CreateRestApiResultAddTags (const Aws::String &key, Aws::String &&value)
 
CreateRestApiResultAddTags (Aws::String &&key, Aws::String &&value)
 
CreateRestApiResultAddTags (const char *key, Aws::String &&value)
 
CreateRestApiResultAddTags (Aws::String &&key, const char *value)
 
CreateRestApiResultAddTags (const char *key, const char *value)
 
bool GetDisableExecuteApiEndpoint () const
 
void SetDisableExecuteApiEndpoint (bool value)
 
CreateRestApiResultWithDisableExecuteApiEndpoint (bool value)
 

Detailed Description

Represents a REST API.

See Also:

AWS API Reference

Definition at line 39 of file CreateRestApiResult.h.

Constructor & Destructor Documentation

◆ CreateRestApiResult() [1/2]

Aws::APIGateway::Model::CreateRestApiResult::CreateRestApiResult ( )

◆ CreateRestApiResult() [2/2]

Aws::APIGateway::Model::CreateRestApiResult::CreateRestApiResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddBinaryMediaTypes() [1/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::AddBinaryMediaTypes ( Aws::String &&  value)
inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 313 of file CreateRestApiResult.h.

◆ AddBinaryMediaTypes() [2/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::AddBinaryMediaTypes ( const Aws::String value)
inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 307 of file CreateRestApiResult.h.

◆ AddBinaryMediaTypes() [3/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::AddBinaryMediaTypes ( const char *  value)
inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 319 of file CreateRestApiResult.h.

◆ AddTags() [1/7]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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

Definition at line 522 of file CreateRestApiResult.h.

◆ AddTags() [2/7]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::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 510 of file CreateRestApiResult.h.

◆ AddTags() [3/7]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

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

Definition at line 534 of file CreateRestApiResult.h.

◆ AddTags() [4/7]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::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 516 of file CreateRestApiResult.h.

◆ AddTags() [5/7]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::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 504 of file CreateRestApiResult.h.

◆ AddTags() [6/7]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

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

Definition at line 528 of file CreateRestApiResult.h.

◆ AddTags() [7/7]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::AddTags ( const char *  key,
const char *  value 
)
inline

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

Definition at line 540 of file CreateRestApiResult.h.

◆ AddWarnings() [1/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::AddWarnings ( Aws::String &&  value)
inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 264 of file CreateRestApiResult.h.

◆ AddWarnings() [2/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::AddWarnings ( const Aws::String value)
inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 258 of file CreateRestApiResult.h.

◆ AddWarnings() [3/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::AddWarnings ( const char *  value)
inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 270 of file CreateRestApiResult.h.

◆ GetApiKeySource()

const ApiKeySourceType& Aws::APIGateway::Model::CreateRestApiResult::GetApiKeySource ( ) const
inline

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Definition at line 357 of file CreateRestApiResult.h.

◆ GetBinaryMediaTypes()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::CreateRestApiResult::GetBinaryMediaTypes ( ) const
inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 277 of file CreateRestApiResult.h.

◆ GetCreatedDate()

const Aws::Utils::DateTime& Aws::APIGateway::Model::CreateRestApiResult::GetCreatedDate ( ) const
inline

The timestamp when the API was created.

Definition at line 165 of file CreateRestApiResult.h.

◆ GetDescription()

const Aws::String& Aws::APIGateway::Model::CreateRestApiResult::GetDescription ( ) const
inline

The API's description.

Definition at line 129 of file CreateRestApiResult.h.

◆ GetDisableExecuteApiEndpoint()

bool Aws::APIGateway::Model::CreateRestApiResult::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 550 of file CreateRestApiResult.h.

◆ GetEndpointConfiguration()

const EndpointConfiguration& Aws::APIGateway::Model::CreateRestApiResult::GetEndpointConfiguration ( ) const
inline

The endpoint configuration of this RestApi showing the endpoint types of the API.

Definition at line 400 of file CreateRestApiResult.h.

◆ GetId()

const Aws::String& Aws::APIGateway::Model::CreateRestApiResult::GetId ( ) const
inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 51 of file CreateRestApiResult.h.

◆ GetMinimumCompressionSize()

int Aws::APIGateway::Model::CreateRestApiResult::GetMinimumCompressionSize ( ) const
inline

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Definition at line 329 of file CreateRestApiResult.h.

◆ GetName()

const Aws::String& Aws::APIGateway::Model::CreateRestApiResult::GetName ( ) const
inline

The API's name.

Definition at line 93 of file CreateRestApiResult.h.

◆ GetPolicy()

const Aws::String& Aws::APIGateway::Model::CreateRestApiResult::GetPolicy ( ) const
inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 431 of file CreateRestApiResult.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::CreateRestApiResult::GetTags ( ) const
inline

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

Definition at line 474 of file CreateRestApiResult.h.

◆ GetVersion()

const Aws::String& Aws::APIGateway::Model::CreateRestApiResult::GetVersion ( ) const
inline

A version identifier for the API.

Definition at line 191 of file CreateRestApiResult.h.

◆ GetWarnings()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::CreateRestApiResult::GetWarnings ( ) const
inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 228 of file CreateRestApiResult.h.

◆ operator=()

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetApiKeySource() [1/2]

void Aws::APIGateway::Model::CreateRestApiResult::SetApiKeySource ( ApiKeySourceType &&  value)
inline

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Definition at line 375 of file CreateRestApiResult.h.

◆ SetApiKeySource() [2/2]

void Aws::APIGateway::Model::CreateRestApiResult::SetApiKeySource ( const ApiKeySourceType value)
inline

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Definition at line 366 of file CreateRestApiResult.h.

◆ SetBinaryMediaTypes() [1/2]

void Aws::APIGateway::Model::CreateRestApiResult::SetBinaryMediaTypes ( Aws::Vector< Aws::String > &&  value)
inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 289 of file CreateRestApiResult.h.

◆ SetBinaryMediaTypes() [2/2]

void Aws::APIGateway::Model::CreateRestApiResult::SetBinaryMediaTypes ( const Aws::Vector< Aws::String > &  value)
inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 283 of file CreateRestApiResult.h.

◆ SetCreatedDate() [1/2]

void Aws::APIGateway::Model::CreateRestApiResult::SetCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the API was created.

Definition at line 175 of file CreateRestApiResult.h.

◆ SetCreatedDate() [2/2]

void Aws::APIGateway::Model::CreateRestApiResult::SetCreatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the API was created.

Definition at line 170 of file CreateRestApiResult.h.

◆ SetDescription() [1/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetDescription ( Aws::String &&  value)
inline

The API's description.

Definition at line 139 of file CreateRestApiResult.h.

◆ SetDescription() [2/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetDescription ( const Aws::String value)
inline

The API's description.

Definition at line 134 of file CreateRestApiResult.h.

◆ SetDescription() [3/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetDescription ( const char *  value)
inline

The API's description.

Definition at line 144 of file CreateRestApiResult.h.

◆ SetDisableExecuteApiEndpoint()

void Aws::APIGateway::Model::CreateRestApiResult::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 559 of file CreateRestApiResult.h.

◆ SetEndpointConfiguration() [1/2]

void Aws::APIGateway::Model::CreateRestApiResult::SetEndpointConfiguration ( const EndpointConfiguration value)
inline

The endpoint configuration of this RestApi showing the endpoint types of the API.

Definition at line 406 of file CreateRestApiResult.h.

◆ SetEndpointConfiguration() [2/2]

void Aws::APIGateway::Model::CreateRestApiResult::SetEndpointConfiguration ( EndpointConfiguration &&  value)
inline

The endpoint configuration of this RestApi showing the endpoint types of the API.

Definition at line 412 of file CreateRestApiResult.h.

◆ SetId() [1/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetId ( Aws::String &&  value)
inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 63 of file CreateRestApiResult.h.

◆ SetId() [2/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetId ( const Aws::String value)
inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 57 of file CreateRestApiResult.h.

◆ SetId() [3/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetId ( const char *  value)
inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 69 of file CreateRestApiResult.h.

◆ SetMinimumCompressionSize()

void Aws::APIGateway::Model::CreateRestApiResult::SetMinimumCompressionSize ( int  value)
inline

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Definition at line 338 of file CreateRestApiResult.h.

◆ SetName() [1/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetName ( Aws::String &&  value)
inline

The API's name.

Definition at line 103 of file CreateRestApiResult.h.

◆ SetName() [2/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetName ( const Aws::String value)
inline

The API's name.

Definition at line 98 of file CreateRestApiResult.h.

◆ SetName() [3/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetName ( const char *  value)
inline

The API's name.

Definition at line 108 of file CreateRestApiResult.h.

◆ SetPolicy() [1/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetPolicy ( Aws::String &&  value)
inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 443 of file CreateRestApiResult.h.

◆ SetPolicy() [2/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetPolicy ( const Aws::String value)
inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 437 of file CreateRestApiResult.h.

◆ SetPolicy() [3/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetPolicy ( const char *  value)
inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 449 of file CreateRestApiResult.h.

◆ SetTags() [1/2]

void Aws::APIGateway::Model::CreateRestApiResult::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 486 of file CreateRestApiResult.h.

◆ SetTags() [2/2]

void Aws::APIGateway::Model::CreateRestApiResult::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 480 of file CreateRestApiResult.h.

◆ SetVersion() [1/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetVersion ( Aws::String &&  value)
inline

A version identifier for the API.

Definition at line 201 of file CreateRestApiResult.h.

◆ SetVersion() [2/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetVersion ( const Aws::String value)
inline

A version identifier for the API.

Definition at line 196 of file CreateRestApiResult.h.

◆ SetVersion() [3/3]

void Aws::APIGateway::Model::CreateRestApiResult::SetVersion ( const char *  value)
inline

A version identifier for the API.

Definition at line 206 of file CreateRestApiResult.h.

◆ SetWarnings() [1/2]

void Aws::APIGateway::Model::CreateRestApiResult::SetWarnings ( Aws::Vector< Aws::String > &&  value)
inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 240 of file CreateRestApiResult.h.

◆ SetWarnings() [2/2]

void Aws::APIGateway::Model::CreateRestApiResult::SetWarnings ( const Aws::Vector< Aws::String > &  value)
inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 234 of file CreateRestApiResult.h.

◆ WithApiKeySource() [1/2]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithApiKeySource ( ApiKeySourceType &&  value)
inline

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Definition at line 393 of file CreateRestApiResult.h.

◆ WithApiKeySource() [2/2]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithApiKeySource ( const ApiKeySourceType value)
inline

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Definition at line 384 of file CreateRestApiResult.h.

◆ WithBinaryMediaTypes() [1/2]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithBinaryMediaTypes ( Aws::Vector< Aws::String > &&  value)
inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 301 of file CreateRestApiResult.h.

◆ WithBinaryMediaTypes() [2/2]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithBinaryMediaTypes ( const Aws::Vector< Aws::String > &  value)
inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 295 of file CreateRestApiResult.h.

◆ WithCreatedDate() [1/2]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the API was created.

Definition at line 185 of file CreateRestApiResult.h.

◆ WithCreatedDate() [2/2]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithCreatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the API was created.

Definition at line 180 of file CreateRestApiResult.h.

◆ WithDescription() [1/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithDescription ( Aws::String &&  value)
inline

The API's description.

Definition at line 154 of file CreateRestApiResult.h.

◆ WithDescription() [2/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithDescription ( const Aws::String value)
inline

The API's description.

Definition at line 149 of file CreateRestApiResult.h.

◆ WithDescription() [3/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithDescription ( const char *  value)
inline

The API's description.

Definition at line 159 of file CreateRestApiResult.h.

◆ WithDisableExecuteApiEndpoint()

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::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 568 of file CreateRestApiResult.h.

◆ WithEndpointConfiguration() [1/2]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithEndpointConfiguration ( const EndpointConfiguration value)
inline

The endpoint configuration of this RestApi showing the endpoint types of the API.

Definition at line 418 of file CreateRestApiResult.h.

◆ WithEndpointConfiguration() [2/2]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithEndpointConfiguration ( EndpointConfiguration &&  value)
inline

The endpoint configuration of this RestApi showing the endpoint types of the API.

Definition at line 424 of file CreateRestApiResult.h.

◆ WithId() [1/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithId ( Aws::String &&  value)
inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 81 of file CreateRestApiResult.h.

◆ WithId() [2/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithId ( const Aws::String value)
inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 75 of file CreateRestApiResult.h.

◆ WithId() [3/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithId ( const char *  value)
inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 87 of file CreateRestApiResult.h.

◆ WithMinimumCompressionSize()

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithMinimumCompressionSize ( int  value)
inline

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Definition at line 347 of file CreateRestApiResult.h.

◆ WithName() [1/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithName ( Aws::String &&  value)
inline

The API's name.

Definition at line 118 of file CreateRestApiResult.h.

◆ WithName() [2/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithName ( const Aws::String value)
inline

The API's name.

Definition at line 113 of file CreateRestApiResult.h.

◆ WithName() [3/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithName ( const char *  value)
inline

The API's name.

Definition at line 123 of file CreateRestApiResult.h.

◆ WithPolicy() [1/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithPolicy ( Aws::String &&  value)
inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 461 of file CreateRestApiResult.h.

◆ WithPolicy() [2/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithPolicy ( const Aws::String value)
inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 455 of file CreateRestApiResult.h.

◆ WithPolicy() [3/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithPolicy ( const char *  value)
inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 467 of file CreateRestApiResult.h.

◆ WithTags() [1/2]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::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 498 of file CreateRestApiResult.h.

◆ WithTags() [2/2]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::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 492 of file CreateRestApiResult.h.

◆ WithVersion() [1/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithVersion ( Aws::String &&  value)
inline

A version identifier for the API.

Definition at line 216 of file CreateRestApiResult.h.

◆ WithVersion() [2/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithVersion ( const Aws::String value)
inline

A version identifier for the API.

Definition at line 211 of file CreateRestApiResult.h.

◆ WithVersion() [3/3]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithVersion ( const char *  value)
inline

A version identifier for the API.

Definition at line 221 of file CreateRestApiResult.h.

◆ WithWarnings() [1/2]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithWarnings ( Aws::Vector< Aws::String > &&  value)
inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 252 of file CreateRestApiResult.h.

◆ WithWarnings() [2/2]

CreateRestApiResult& Aws::APIGateway::Model::CreateRestApiResult::WithWarnings ( const Aws::Vector< Aws::String > &  value)
inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 246 of file CreateRestApiResult.h.


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