Aws::APIGateway::Model::CreateUsagePlanRequest Class Reference

#include <CreateUsagePlanRequest.h>

Inheritance diagram for Aws::APIGateway::Model::CreateUsagePlanRequest:

Public Member Functions
	CreateUsagePlanRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
const Aws::String &	GetName () const
bool	NameHasBeenSet () const
void	SetName (const Aws::String &value)
void	SetName (Aws::String &&value)
void	SetName (const char *value)
CreateUsagePlanRequest &	WithName (const Aws::String &value)
CreateUsagePlanRequest &	WithName (Aws::String &&value)
CreateUsagePlanRequest &	WithName (const char *value)
const Aws::String &	GetDescription () const
bool	DescriptionHasBeenSet () const
void	SetDescription (const Aws::String &value)
void	SetDescription (Aws::String &&value)
void	SetDescription (const char *value)
CreateUsagePlanRequest &	WithDescription (const Aws::String &value)
CreateUsagePlanRequest &	WithDescription (Aws::String &&value)
CreateUsagePlanRequest &	WithDescription (const char *value)
const Aws::Vector< ApiStage > &	GetApiStages () const
bool	ApiStagesHasBeenSet () const
void	SetApiStages (const Aws::Vector< ApiStage > &value)
void	SetApiStages (Aws::Vector< ApiStage > &&value)
CreateUsagePlanRequest &	WithApiStages (const Aws::Vector< ApiStage > &value)
CreateUsagePlanRequest &	WithApiStages (Aws::Vector< ApiStage > &&value)
CreateUsagePlanRequest &	AddApiStages (const ApiStage &value)
CreateUsagePlanRequest &	AddApiStages (ApiStage &&value)
const ThrottleSettings &	GetThrottle () const
bool	ThrottleHasBeenSet () const
void	SetThrottle (const ThrottleSettings &value)
void	SetThrottle (ThrottleSettings &&value)
CreateUsagePlanRequest &	WithThrottle (const ThrottleSettings &value)
CreateUsagePlanRequest &	WithThrottle (ThrottleSettings &&value)
const QuotaSettings &	GetQuota () const
bool	QuotaHasBeenSet () const
void	SetQuota (const QuotaSettings &value)
void	SetQuota (QuotaSettings &&value)
CreateUsagePlanRequest &	WithQuota (const QuotaSettings &value)
CreateUsagePlanRequest &	WithQuota (QuotaSettings &&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)
CreateUsagePlanRequest &	WithTags (const Aws::Map< Aws::String, Aws::String > &value)
CreateUsagePlanRequest &	WithTags (Aws::Map< Aws::String, Aws::String > &&value)
CreateUsagePlanRequest &	AddTags (const Aws::String &key, const Aws::String &value)
CreateUsagePlanRequest &	AddTags (Aws::String &&key, const Aws::String &value)
CreateUsagePlanRequest &	AddTags (const Aws::String &key, Aws::String &&value)
CreateUsagePlanRequest &	AddTags (Aws::String &&key, Aws::String &&value)
CreateUsagePlanRequest &	AddTags (const char *key, Aws::String &&value)
CreateUsagePlanRequest &	AddTags (Aws::String &&key, const char *value)
CreateUsagePlanRequest &	AddTags (const char *key, const char *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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

See Also:

AWS API Reference

Definition at line 31 of file CreateUsagePlanRequest.h.

Constructor & Destructor Documentation

CreateUsagePlanRequest()

Aws::APIGateway::Model::CreateUsagePlanRequest::CreateUsagePlanRequest

(

)

Member Function Documentation

AddApiStages() [1/2]

CreateUsagePlanRequest& Aws::APIGateway::Model::CreateUsagePlanRequest::AddApiStages ( const ApiStage &  value )

inline

The associated API stages of the usage plan.

Definition at line 160 of file CreateUsagePlanRequest.h.

AddApiStages() [2/2]

CreateUsagePlanRequest& Aws::APIGateway::Model::CreateUsagePlanRequest::AddApiStages ( ApiStage &&  value )

inline

The associated API stages of the usage plan.

Definition at line 165 of file CreateUsagePlanRequest.h.

AddTags() [1/7]

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

AddTags() [2/7]

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

AddTags() [3/7]

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

AddTags() [4/7]

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

AddTags() [5/7]

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

AddTags() [6/7]

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

AddTags() [7/7]

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

ApiStagesHasBeenSet()

bool Aws::APIGateway::Model::CreateUsagePlanRequest::ApiStagesHasBeenSet ( ) const

inline

The associated API stages of the usage plan.

Definition at line 135 of file CreateUsagePlanRequest.h.

DescriptionHasBeenSet()

bool Aws::APIGateway::Model::CreateUsagePlanRequest::DescriptionHasBeenSet ( ) const

inline

The description of the usage plan.

Definition at line 94 of file CreateUsagePlanRequest.h.

GetApiStages()

const Aws::Vector<ApiStage>& Aws::APIGateway::Model::CreateUsagePlanRequest::GetApiStages ( ) const

inline

The associated API stages of the usage plan.

Definition at line 130 of file CreateUsagePlanRequest.h.

GetDescription()

const Aws::String& Aws::APIGateway::Model::CreateUsagePlanRequest::GetDescription ( ) const

inline

The description of the usage plan.

Definition at line 89 of file CreateUsagePlanRequest.h.

GetName()

const Aws::String& Aws::APIGateway::Model::CreateUsagePlanRequest::GetName ( ) const

inline

[Required] The name of the usage plan.

Definition at line 48 of file CreateUsagePlanRequest.h.

GetQuota()

const QuotaSettings& Aws::APIGateway::Model::CreateUsagePlanRequest::GetQuota ( ) const

inline

The quota of the usage plan.

Definition at line 202 of file CreateUsagePlanRequest.h.

GetServiceRequestName()

virtual const char* Aws::APIGateway::Model::CreateUsagePlanRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file CreateUsagePlanRequest.h.

GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::CreateUsagePlanRequest::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 235 of file CreateUsagePlanRequest.h.

GetThrottle()

const ThrottleSettings& Aws::APIGateway::Model::CreateUsagePlanRequest::GetThrottle ( ) const

inline

The throttling limits of the usage plan.

Definition at line 171 of file CreateUsagePlanRequest.h.

NameHasBeenSet()

bool Aws::APIGateway::Model::CreateUsagePlanRequest::NameHasBeenSet ( ) const

inline

[Required] The name of the usage plan.

Definition at line 53 of file CreateUsagePlanRequest.h.

QuotaHasBeenSet()

bool Aws::APIGateway::Model::CreateUsagePlanRequest::QuotaHasBeenSet ( ) const

inline

The quota of the usage plan.

Definition at line 207 of file CreateUsagePlanRequest.h.

SerializePayload()

Aws::String Aws::APIGateway::Model::CreateUsagePlanRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetApiStages() [1/2]

void Aws::APIGateway::Model::CreateUsagePlanRequest::SetApiStages ( const Aws::Vector< ApiStage > &  value )

inline

The associated API stages of the usage plan.

Definition at line 140 of file CreateUsagePlanRequest.h.

SetApiStages() [2/2]

void Aws::APIGateway::Model::CreateUsagePlanRequest::SetApiStages ( Aws::Vector< ApiStage > &&  value )

inline

The associated API stages of the usage plan.

Definition at line 145 of file CreateUsagePlanRequest.h.

SetDescription() [1/3]

void Aws::APIGateway::Model::CreateUsagePlanRequest::SetDescription ( const Aws::String &  value )

inline

The description of the usage plan.

Definition at line 99 of file CreateUsagePlanRequest.h.

SetDescription() [2/3]

void Aws::APIGateway::Model::CreateUsagePlanRequest::SetDescription ( Aws::String &&  value )

inline

The description of the usage plan.

Definition at line 104 of file CreateUsagePlanRequest.h.

SetDescription() [3/3]

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

inline

The description of the usage plan.

Definition at line 109 of file CreateUsagePlanRequest.h.

SetName() [1/3]

void Aws::APIGateway::Model::CreateUsagePlanRequest::SetName ( const Aws::String &  value )

inline

[Required] The name of the usage plan.

Definition at line 58 of file CreateUsagePlanRequest.h.

SetName() [2/3]

void Aws::APIGateway::Model::CreateUsagePlanRequest::SetName ( Aws::String &&  value )

inline

[Required] The name of the usage plan.

Definition at line 63 of file CreateUsagePlanRequest.h.

SetName() [3/3]

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

inline

[Required] The name of the usage plan.

Definition at line 68 of file CreateUsagePlanRequest.h.

SetQuota() [1/2]

void Aws::APIGateway::Model::CreateUsagePlanRequest::SetQuota ( const QuotaSettings &  value )

inline

The quota of the usage plan.

Definition at line 212 of file CreateUsagePlanRequest.h.

SetQuota() [2/2]

void Aws::APIGateway::Model::CreateUsagePlanRequest::SetQuota ( QuotaSettings &&  value )

inline

The quota of the usage plan.

Definition at line 217 of file CreateUsagePlanRequest.h.

SetTags() [1/2]

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

SetTags() [2/2]

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

SetThrottle() [1/2]

void Aws::APIGateway::Model::CreateUsagePlanRequest::SetThrottle ( const ThrottleSettings &  value )

inline

The throttling limits of the usage plan.

Definition at line 181 of file CreateUsagePlanRequest.h.

SetThrottle() [2/2]

void Aws::APIGateway::Model::CreateUsagePlanRequest::SetThrottle ( ThrottleSettings &&  value )

inline

The throttling limits of the usage plan.

Definition at line 186 of file CreateUsagePlanRequest.h.

TagsHasBeenSet()

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

ThrottleHasBeenSet()

bool Aws::APIGateway::Model::CreateUsagePlanRequest::ThrottleHasBeenSet ( ) const

inline

The throttling limits of the usage plan.

Definition at line 176 of file CreateUsagePlanRequest.h.

WithApiStages() [1/2]

CreateUsagePlanRequest& Aws::APIGateway::Model::CreateUsagePlanRequest::WithApiStages ( const Aws::Vector< ApiStage > &  value )

inline

The associated API stages of the usage plan.

Definition at line 150 of file CreateUsagePlanRequest.h.

WithApiStages() [2/2]

CreateUsagePlanRequest& Aws::APIGateway::Model::CreateUsagePlanRequest::WithApiStages ( Aws::Vector< ApiStage > &&  value )

inline

The associated API stages of the usage plan.

Definition at line 155 of file CreateUsagePlanRequest.h.

WithDescription() [1/3]

CreateUsagePlanRequest& Aws::APIGateway::Model::CreateUsagePlanRequest::WithDescription ( const Aws::String &  value )

inline

The description of the usage plan.

Definition at line 114 of file CreateUsagePlanRequest.h.

WithDescription() [2/3]

CreateUsagePlanRequest& Aws::APIGateway::Model::CreateUsagePlanRequest::WithDescription ( Aws::String &&  value )

inline

The description of the usage plan.

Definition at line 119 of file CreateUsagePlanRequest.h.

WithDescription() [3/3]

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

inline

The description of the usage plan.

Definition at line 124 of file CreateUsagePlanRequest.h.

WithName() [1/3]

CreateUsagePlanRequest& Aws::APIGateway::Model::CreateUsagePlanRequest::WithName ( const Aws::String &  value )

inline

[Required] The name of the usage plan.

Definition at line 73 of file CreateUsagePlanRequest.h.

WithName() [2/3]

CreateUsagePlanRequest& Aws::APIGateway::Model::CreateUsagePlanRequest::WithName ( Aws::String &&  value )

inline

[Required] The name of the usage plan.

Definition at line 78 of file CreateUsagePlanRequest.h.

WithName() [3/3]

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

inline

[Required] The name of the usage plan.

Definition at line 83 of file CreateUsagePlanRequest.h.

WithQuota() [1/2]

CreateUsagePlanRequest& Aws::APIGateway::Model::CreateUsagePlanRequest::WithQuota ( const QuotaSettings &  value )

inline

The quota of the usage plan.

Definition at line 222 of file CreateUsagePlanRequest.h.

WithQuota() [2/2]

CreateUsagePlanRequest& Aws::APIGateway::Model::CreateUsagePlanRequest::WithQuota ( QuotaSettings &&  value )

inline

The quota of the usage plan.

Definition at line 227 of file CreateUsagePlanRequest.h.

WithTags() [1/2]

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

WithTags() [2/2]

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

WithThrottle() [1/2]

CreateUsagePlanRequest& Aws::APIGateway::Model::CreateUsagePlanRequest::WithThrottle ( const ThrottleSettings &  value )

inline

The throttling limits of the usage plan.

Definition at line 191 of file CreateUsagePlanRequest.h.

WithThrottle() [2/2]

CreateUsagePlanRequest& Aws::APIGateway::Model::CreateUsagePlanRequest::WithThrottle ( ThrottleSettings &&  value )

inline

The throttling limits of the usage plan.

Definition at line 196 of file CreateUsagePlanRequest.h.

---

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

• aws-cpp-sdk-apigateway/include/aws/apigateway/model/CreateUsagePlanRequest.h