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

#include <CreateRestApiRequest.h>

+ Inheritance diagram for Aws::APIGateway::Model::CreateRestApiRequest:

Public Member Functions

 CreateRestApiRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateRestApiRequestWithName (const Aws::String &value)
 
CreateRestApiRequestWithName (Aws::String &&value)
 
CreateRestApiRequestWithName (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)
 
CreateRestApiRequestWithDescription (const Aws::String &value)
 
CreateRestApiRequestWithDescription (Aws::String &&value)
 
CreateRestApiRequestWithDescription (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)
 
CreateRestApiRequestWithVersion (const Aws::String &value)
 
CreateRestApiRequestWithVersion (Aws::String &&value)
 
CreateRestApiRequestWithVersion (const char *value)
 
const Aws::StringGetCloneFrom () const
 
bool CloneFromHasBeenSet () const
 
void SetCloneFrom (const Aws::String &value)
 
void SetCloneFrom (Aws::String &&value)
 
void SetCloneFrom (const char *value)
 
CreateRestApiRequestWithCloneFrom (const Aws::String &value)
 
CreateRestApiRequestWithCloneFrom (Aws::String &&value)
 
CreateRestApiRequestWithCloneFrom (const char *value)
 
const Aws::Vector< Aws::String > & GetBinaryMediaTypes () const
 
bool BinaryMediaTypesHasBeenSet () const
 
void SetBinaryMediaTypes (const Aws::Vector< Aws::String > &value)
 
void SetBinaryMediaTypes (Aws::Vector< Aws::String > &&value)
 
CreateRestApiRequestWithBinaryMediaTypes (const Aws::Vector< Aws::String > &value)
 
CreateRestApiRequestWithBinaryMediaTypes (Aws::Vector< Aws::String > &&value)
 
CreateRestApiRequestAddBinaryMediaTypes (const Aws::String &value)
 
CreateRestApiRequestAddBinaryMediaTypes (Aws::String &&value)
 
CreateRestApiRequestAddBinaryMediaTypes (const char *value)
 
int GetMinimumCompressionSize () const
 
bool MinimumCompressionSizeHasBeenSet () const
 
void SetMinimumCompressionSize (int value)
 
CreateRestApiRequestWithMinimumCompressionSize (int value)
 
const ApiKeySourceTypeGetApiKeySource () const
 
bool ApiKeySourceHasBeenSet () const
 
void SetApiKeySource (const ApiKeySourceType &value)
 
void SetApiKeySource (ApiKeySourceType &&value)
 
CreateRestApiRequestWithApiKeySource (const ApiKeySourceType &value)
 
CreateRestApiRequestWithApiKeySource (ApiKeySourceType &&value)
 
const EndpointConfigurationGetEndpointConfiguration () const
 
bool EndpointConfigurationHasBeenSet () const
 
void SetEndpointConfiguration (const EndpointConfiguration &value)
 
void SetEndpointConfiguration (EndpointConfiguration &&value)
 
CreateRestApiRequestWithEndpointConfiguration (const EndpointConfiguration &value)
 
CreateRestApiRequestWithEndpointConfiguration (EndpointConfiguration &&value)
 
const Aws::StringGetPolicy () const
 
bool PolicyHasBeenSet () const
 
void SetPolicy (const Aws::String &value)
 
void SetPolicy (Aws::String &&value)
 
void SetPolicy (const char *value)
 
CreateRestApiRequestWithPolicy (const Aws::String &value)
 
CreateRestApiRequestWithPolicy (Aws::String &&value)
 
CreateRestApiRequestWithPolicy (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)
 
CreateRestApiRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateRestApiRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateRestApiRequestAddTags (const Aws::String &key, const Aws::String &value)
 
CreateRestApiRequestAddTags (Aws::String &&key, const Aws::String &value)
 
CreateRestApiRequestAddTags (const Aws::String &key, Aws::String &&value)
 
CreateRestApiRequestAddTags (Aws::String &&key, Aws::String &&value)
 
CreateRestApiRequestAddTags (const char *key, Aws::String &&value)
 
CreateRestApiRequestAddTags (Aws::String &&key, const char *value)
 
CreateRestApiRequestAddTags (const char *key, const char *value)
 
bool GetDisableExecuteApiEndpoint () const
 
bool DisableExecuteApiEndpointHasBeenSet () const
 
void SetDisableExecuteApiEndpoint (bool value)
 
CreateRestApiRequestWithDisableExecuteApiEndpoint (bool value)
 
- Public Member Functions inherited from Aws::APIGateway::APIGatewayRequest
virtual ~APIGatewayRequest ()
 
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::APIGateway::APIGatewayRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

The POST Request to add a new RestApi resource to your collection.

See Also:

AWS API Reference

Definition at line 29 of file CreateRestApiRequest.h.

Constructor & Destructor Documentation

◆ CreateRestApiRequest()

Aws::APIGateway::Model::CreateRestApiRequest::CreateRestApiRequest ( )

Member Function Documentation

◆ AddBinaryMediaTypes() [1/3]

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

◆ AddBinaryMediaTypes() [2/3]

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

◆ AddBinaryMediaTypes() [3/3]

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

◆ AddTags() [1/7]

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 508 of file CreateRestApiRequest.h.

◆ AddTags() [2/7]

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 494 of file CreateRestApiRequest.h.

◆ AddTags() [3/7]

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 522 of file CreateRestApiRequest.h.

◆ AddTags() [4/7]

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 501 of file CreateRestApiRequest.h.

◆ AddTags() [5/7]

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 487 of file CreateRestApiRequest.h.

◆ AddTags() [6/7]

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 515 of file CreateRestApiRequest.h.

◆ AddTags() [7/7]

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 529 of file CreateRestApiRequest.h.

◆ ApiKeySourceHasBeenSet()

bool Aws::APIGateway::Model::CreateRestApiRequest::ApiKeySourceHasBeenSet ( ) 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 315 of file CreateRestApiRequest.h.

◆ BinaryMediaTypesHasBeenSet()

bool Aws::APIGateway::Model::CreateRestApiRequest::BinaryMediaTypesHasBeenSet ( ) 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 217 of file CreateRestApiRequest.h.

◆ CloneFromHasBeenSet()

bool Aws::APIGateway::Model::CreateRestApiRequest::CloneFromHasBeenSet ( ) const
inline

The ID of the RestApi that you want to clone from.

Definition at line 174 of file CreateRestApiRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::APIGateway::Model::CreateRestApiRequest::DescriptionHasBeenSet ( ) const
inline

The description of the RestApi.

Definition at line 92 of file CreateRestApiRequest.h.

◆ DisableExecuteApiEndpointHasBeenSet()

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

◆ EndpointConfigurationHasBeenSet()

bool Aws::APIGateway::Model::CreateRestApiRequest::EndpointConfigurationHasBeenSet ( ) const
inline

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

Definition at line 364 of file CreateRestApiRequest.h.

◆ GetApiKeySource()

const ApiKeySourceType& Aws::APIGateway::Model::CreateRestApiRequest::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 306 of file CreateRestApiRequest.h.

◆ GetBinaryMediaTypes()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::CreateRestApiRequest::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 211 of file CreateRestApiRequest.h.

◆ GetCloneFrom()

const Aws::String& Aws::APIGateway::Model::CreateRestApiRequest::GetCloneFrom ( ) const
inline

The ID of the RestApi that you want to clone from.

Definition at line 169 of file CreateRestApiRequest.h.

◆ GetDescription()

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

The description of the RestApi.

Definition at line 87 of file CreateRestApiRequest.h.

◆ GetDisableExecuteApiEndpoint()

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

◆ GetEndpointConfiguration()

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

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

Definition at line 358 of file CreateRestApiRequest.h.

◆ GetMinimumCompressionSize()

int Aws::APIGateway::Model::CreateRestApiRequest::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 269 of file CreateRestApiRequest.h.

◆ GetName()

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

[Required] The name of the RestApi.

Definition at line 46 of file CreateRestApiRequest.h.

◆ GetPolicy()

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

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

Definition at line 395 of file CreateRestApiRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::APIGateway::Model::CreateRestApiRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file CreateRestApiRequest.h.

◆ GetTags()

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 445 of file CreateRestApiRequest.h.

◆ GetVersion()

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

A version identifier for the API.

Definition at line 128 of file CreateRestApiRequest.h.

◆ MinimumCompressionSizeHasBeenSet()

bool Aws::APIGateway::Model::CreateRestApiRequest::MinimumCompressionSizeHasBeenSet ( ) 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 278 of file CreateRestApiRequest.h.

◆ NameHasBeenSet()

bool Aws::APIGateway::Model::CreateRestApiRequest::NameHasBeenSet ( ) const
inline

[Required] The name of the RestApi.

Definition at line 51 of file CreateRestApiRequest.h.

◆ PolicyHasBeenSet()

bool Aws::APIGateway::Model::CreateRestApiRequest::PolicyHasBeenSet ( ) const
inline

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

Definition at line 401 of file CreateRestApiRequest.h.

◆ SerializePayload()

Aws::String Aws::APIGateway::Model::CreateRestApiRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApiKeySource() [1/2]

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

◆ SetApiKeySource() [2/2]

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

◆ SetBinaryMediaTypes() [1/2]

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

◆ SetBinaryMediaTypes() [2/2]

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

◆ SetCloneFrom() [1/3]

void Aws::APIGateway::Model::CreateRestApiRequest::SetCloneFrom ( Aws::String &&  value)
inline

The ID of the RestApi that you want to clone from.

Definition at line 184 of file CreateRestApiRequest.h.

◆ SetCloneFrom() [2/3]

void Aws::APIGateway::Model::CreateRestApiRequest::SetCloneFrom ( const Aws::String value)
inline

The ID of the RestApi that you want to clone from.

Definition at line 179 of file CreateRestApiRequest.h.

◆ SetCloneFrom() [3/3]

void Aws::APIGateway::Model::CreateRestApiRequest::SetCloneFrom ( const char *  value)
inline

The ID of the RestApi that you want to clone from.

Definition at line 189 of file CreateRestApiRequest.h.

◆ SetDescription() [1/3]

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

The description of the RestApi.

Definition at line 102 of file CreateRestApiRequest.h.

◆ SetDescription() [2/3]

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

The description of the RestApi.

Definition at line 97 of file CreateRestApiRequest.h.

◆ SetDescription() [3/3]

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

The description of the RestApi.

Definition at line 107 of file CreateRestApiRequest.h.

◆ SetDisableExecuteApiEndpoint()

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

◆ SetEndpointConfiguration() [1/2]

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

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

Definition at line 370 of file CreateRestApiRequest.h.

◆ SetEndpointConfiguration() [2/2]

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

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

Definition at line 376 of file CreateRestApiRequest.h.

◆ SetMinimumCompressionSize()

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

◆ SetName() [1/3]

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

[Required] The name of the RestApi.

Definition at line 61 of file CreateRestApiRequest.h.

◆ SetName() [2/3]

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

[Required] The name of the RestApi.

Definition at line 56 of file CreateRestApiRequest.h.

◆ SetName() [3/3]

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

[Required] The name of the RestApi.

Definition at line 66 of file CreateRestApiRequest.h.

◆ SetPolicy() [1/3]

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

◆ SetPolicy() [2/3]

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

◆ SetPolicy() [3/3]

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

◆ SetTags() [1/2]

void Aws::APIGateway::Model::CreateRestApiRequest::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 466 of file CreateRestApiRequest.h.

◆ SetTags() [2/2]

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

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 459 of file CreateRestApiRequest.h.

◆ SetVersion() [1/3]

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

A version identifier for the API.

Definition at line 143 of file CreateRestApiRequest.h.

◆ SetVersion() [2/3]

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

A version identifier for the API.

Definition at line 138 of file CreateRestApiRequest.h.

◆ SetVersion() [3/3]

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

A version identifier for the API.

Definition at line 148 of file CreateRestApiRequest.h.

◆ TagsHasBeenSet()

bool Aws::APIGateway::Model::CreateRestApiRequest::TagsHasBeenSet ( ) const
inline

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 452 of file CreateRestApiRequest.h.

◆ VersionHasBeenSet()

bool Aws::APIGateway::Model::CreateRestApiRequest::VersionHasBeenSet ( ) const
inline

A version identifier for the API.

Definition at line 133 of file CreateRestApiRequest.h.

◆ WithApiKeySource() [1/2]

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

◆ WithApiKeySource() [2/2]

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

◆ WithBinaryMediaTypes() [1/2]

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

◆ WithBinaryMediaTypes() [2/2]

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

◆ WithCloneFrom() [1/3]

CreateRestApiRequest& Aws::APIGateway::Model::CreateRestApiRequest::WithCloneFrom ( Aws::String &&  value)
inline

The ID of the RestApi that you want to clone from.

Definition at line 199 of file CreateRestApiRequest.h.

◆ WithCloneFrom() [2/3]

CreateRestApiRequest& Aws::APIGateway::Model::CreateRestApiRequest::WithCloneFrom ( const Aws::String value)
inline

The ID of the RestApi that you want to clone from.

Definition at line 194 of file CreateRestApiRequest.h.

◆ WithCloneFrom() [3/3]

CreateRestApiRequest& Aws::APIGateway::Model::CreateRestApiRequest::WithCloneFrom ( const char *  value)
inline

The ID of the RestApi that you want to clone from.

Definition at line 204 of file CreateRestApiRequest.h.

◆ WithDescription() [1/3]

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

The description of the RestApi.

Definition at line 117 of file CreateRestApiRequest.h.

◆ WithDescription() [2/3]

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

The description of the RestApi.

Definition at line 112 of file CreateRestApiRequest.h.

◆ WithDescription() [3/3]

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

The description of the RestApi.

Definition at line 122 of file CreateRestApiRequest.h.

◆ WithDisableExecuteApiEndpoint()

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

◆ WithEndpointConfiguration() [1/2]

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

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

Definition at line 382 of file CreateRestApiRequest.h.

◆ WithEndpointConfiguration() [2/2]

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

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

Definition at line 388 of file CreateRestApiRequest.h.

◆ WithMinimumCompressionSize()

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

◆ WithName() [1/3]

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

[Required] The name of the RestApi.

Definition at line 76 of file CreateRestApiRequest.h.

◆ WithName() [2/3]

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

[Required] The name of the RestApi.

Definition at line 71 of file CreateRestApiRequest.h.

◆ WithName() [3/3]

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

[Required] The name of the RestApi.

Definition at line 81 of file CreateRestApiRequest.h.

◆ WithPolicy() [1/3]

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

◆ WithPolicy() [2/3]

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

◆ WithPolicy() [3/3]

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

◆ WithTags() [1/2]

CreateRestApiRequest& Aws::APIGateway::Model::CreateRestApiRequest::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 480 of file CreateRestApiRequest.h.

◆ WithTags() [2/2]

CreateRestApiRequest& Aws::APIGateway::Model::CreateRestApiRequest::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Definition at line 473 of file CreateRestApiRequest.h.

◆ WithVersion() [1/3]

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

A version identifier for the API.

Definition at line 158 of file CreateRestApiRequest.h.

◆ WithVersion() [2/3]

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

A version identifier for the API.

Definition at line 153 of file CreateRestApiRequest.h.

◆ WithVersion() [3/3]

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

A version identifier for the API.

Definition at line 163 of file CreateRestApiRequest.h.


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