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

#include <UsagePlan.h>

Public Member Functions

 UsagePlan ()
 
 UsagePlan (Aws::Utils::Json::JsonView jsonValue)
 
UsagePlanoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
UsagePlanWithId (const Aws::String &value)
 
UsagePlanWithId (Aws::String &&value)
 
UsagePlanWithId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UsagePlanWithName (const Aws::String &value)
 
UsagePlanWithName (Aws::String &&value)
 
UsagePlanWithName (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)
 
UsagePlanWithDescription (const Aws::String &value)
 
UsagePlanWithDescription (Aws::String &&value)
 
UsagePlanWithDescription (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)
 
UsagePlanWithApiStages (const Aws::Vector< ApiStage > &value)
 
UsagePlanWithApiStages (Aws::Vector< ApiStage > &&value)
 
UsagePlanAddApiStages (const ApiStage &value)
 
UsagePlanAddApiStages (ApiStage &&value)
 
const ThrottleSettingsGetThrottle () const
 
bool ThrottleHasBeenSet () const
 
void SetThrottle (const ThrottleSettings &value)
 
void SetThrottle (ThrottleSettings &&value)
 
UsagePlanWithThrottle (const ThrottleSettings &value)
 
UsagePlanWithThrottle (ThrottleSettings &&value)
 
const QuotaSettingsGetQuota () const
 
bool QuotaHasBeenSet () const
 
void SetQuota (const QuotaSettings &value)
 
void SetQuota (QuotaSettings &&value)
 
UsagePlanWithQuota (const QuotaSettings &value)
 
UsagePlanWithQuota (QuotaSettings &&value)
 
const Aws::StringGetProductCode () const
 
bool ProductCodeHasBeenSet () const
 
void SetProductCode (const Aws::String &value)
 
void SetProductCode (Aws::String &&value)
 
void SetProductCode (const char *value)
 
UsagePlanWithProductCode (const Aws::String &value)
 
UsagePlanWithProductCode (Aws::String &&value)
 
UsagePlanWithProductCode (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)
 
UsagePlanWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
UsagePlanWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
UsagePlanAddTags (const Aws::String &key, const Aws::String &value)
 
UsagePlanAddTags (Aws::String &&key, const Aws::String &value)
 
UsagePlanAddTags (const Aws::String &key, Aws::String &&value)
 
UsagePlanAddTags (Aws::String &&key, Aws::String &&value)
 
UsagePlanAddTags (const char *key, Aws::String &&value)
 
UsagePlanAddTags (Aws::String &&key, const char *value)
 
UsagePlanAddTags (const char *key, const char *value)
 

Detailed Description

Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

See Also:

AWS API Reference

Definition at line 42 of file UsagePlan.h.

Constructor & Destructor Documentation

◆ UsagePlan() [1/2]

Aws::APIGateway::Model::UsagePlan::UsagePlan ( )

◆ UsagePlan() [2/2]

Aws::APIGateway::Model::UsagePlan::UsagePlan ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddApiStages() [1/2]

UsagePlan& Aws::APIGateway::Model::UsagePlan::AddApiStages ( const ApiStage value)
inline

The associated API stages of a usage plan.

Definition at line 207 of file UsagePlan.h.

◆ AddApiStages() [2/2]

UsagePlan& Aws::APIGateway::Model::UsagePlan::AddApiStages ( ApiStage &&  value)
inline

The associated API stages of a usage plan.

Definition at line 212 of file UsagePlan.h.

◆ AddTags() [1/7]

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

◆ AddTags() [2/7]

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

◆ AddTags() [3/7]

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

◆ AddTags() [4/7]

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

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

Definition at line 384 of file UsagePlan.h.

◆ AddTags() [5/7]

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

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

Definition at line 390 of file UsagePlan.h.

◆ AddTags() [6/7]

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

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

Definition at line 396 of file UsagePlan.h.

◆ AddTags() [7/7]

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

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

Definition at line 402 of file UsagePlan.h.

◆ ApiStagesHasBeenSet()

bool Aws::APIGateway::Model::UsagePlan::ApiStagesHasBeenSet ( ) const
inline

The associated API stages of a usage plan.

Definition at line 182 of file UsagePlan.h.

◆ DescriptionHasBeenSet()

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

The description of a usage plan.

Definition at line 141 of file UsagePlan.h.

◆ GetApiStages()

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

The associated API stages of a usage plan.

Definition at line 177 of file UsagePlan.h.

◆ GetDescription()

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

The description of a usage plan.

Definition at line 136 of file UsagePlan.h.

◆ GetId()

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

The identifier of a UsagePlan resource.

Definition at line 54 of file UsagePlan.h.

◆ GetName()

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

The name of a usage plan.

Definition at line 95 of file UsagePlan.h.

◆ GetProductCode()

const Aws::String& Aws::APIGateway::Model::UsagePlan::GetProductCode ( ) const
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 281 of file UsagePlan.h.

◆ GetQuota()

const QuotaSettings& Aws::APIGateway::Model::UsagePlan::GetQuota ( ) const
inline

The maximum number of permitted requests per a given unit time interval.

Definition at line 249 of file UsagePlan.h.

◆ GetTags()

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

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

Definition at line 330 of file UsagePlan.h.

◆ GetThrottle()

const ThrottleSettings& Aws::APIGateway::Model::UsagePlan::GetThrottle ( ) const
inline

The request throttle limits of a usage plan.

Definition at line 218 of file UsagePlan.h.

◆ IdHasBeenSet()

bool Aws::APIGateway::Model::UsagePlan::IdHasBeenSet ( ) const
inline

The identifier of a UsagePlan resource.

Definition at line 59 of file UsagePlan.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::UsagePlan::Jsonize ( ) const

◆ NameHasBeenSet()

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

The name of a usage plan.

Definition at line 100 of file UsagePlan.h.

◆ operator=()

UsagePlan& Aws::APIGateway::Model::UsagePlan::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ProductCodeHasBeenSet()

bool Aws::APIGateway::Model::UsagePlan::ProductCodeHasBeenSet ( ) const
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 287 of file UsagePlan.h.

◆ QuotaHasBeenSet()

bool Aws::APIGateway::Model::UsagePlan::QuotaHasBeenSet ( ) const
inline

The maximum number of permitted requests per a given unit time interval.

Definition at line 254 of file UsagePlan.h.

◆ SetApiStages() [1/2]

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

The associated API stages of a usage plan.

Definition at line 187 of file UsagePlan.h.

◆ SetApiStages() [2/2]

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

The associated API stages of a usage plan.

Definition at line 192 of file UsagePlan.h.

◆ SetDescription() [1/3]

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

The description of a usage plan.

Definition at line 146 of file UsagePlan.h.

◆ SetDescription() [2/3]

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

The description of a usage plan.

Definition at line 151 of file UsagePlan.h.

◆ SetDescription() [3/3]

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

The description of a usage plan.

Definition at line 156 of file UsagePlan.h.

◆ SetId() [1/3]

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

The identifier of a UsagePlan resource.

Definition at line 64 of file UsagePlan.h.

◆ SetId() [2/3]

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

The identifier of a UsagePlan resource.

Definition at line 69 of file UsagePlan.h.

◆ SetId() [3/3]

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

The identifier of a UsagePlan resource.

Definition at line 74 of file UsagePlan.h.

◆ SetName() [1/3]

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

The name of a usage plan.

Definition at line 105 of file UsagePlan.h.

◆ SetName() [2/3]

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

The name of a usage plan.

Definition at line 110 of file UsagePlan.h.

◆ SetName() [3/3]

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

The name of a usage plan.

Definition at line 115 of file UsagePlan.h.

◆ SetProductCode() [1/3]

void Aws::APIGateway::Model::UsagePlan::SetProductCode ( const Aws::String value)
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 293 of file UsagePlan.h.

◆ SetProductCode() [2/3]

void Aws::APIGateway::Model::UsagePlan::SetProductCode ( Aws::String &&  value)
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 299 of file UsagePlan.h.

◆ SetProductCode() [3/3]

void Aws::APIGateway::Model::UsagePlan::SetProductCode ( const char *  value)
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 305 of file UsagePlan.h.

◆ SetQuota() [1/2]

void Aws::APIGateway::Model::UsagePlan::SetQuota ( const QuotaSettings value)
inline

The maximum number of permitted requests per a given unit time interval.

Definition at line 259 of file UsagePlan.h.

◆ SetQuota() [2/2]

void Aws::APIGateway::Model::UsagePlan::SetQuota ( QuotaSettings &&  value)
inline

The maximum number of permitted requests per a given unit time interval.

Definition at line 264 of file UsagePlan.h.

◆ SetTags() [1/2]

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

◆ SetTags() [2/2]

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

◆ SetThrottle() [1/2]

void Aws::APIGateway::Model::UsagePlan::SetThrottle ( const ThrottleSettings value)
inline

The request throttle limits of a usage plan.

Definition at line 228 of file UsagePlan.h.

◆ SetThrottle() [2/2]

void Aws::APIGateway::Model::UsagePlan::SetThrottle ( ThrottleSettings &&  value)
inline

The request throttle limits of a usage plan.

Definition at line 233 of file UsagePlan.h.

◆ TagsHasBeenSet()

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

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

Definition at line 336 of file UsagePlan.h.

◆ ThrottleHasBeenSet()

bool Aws::APIGateway::Model::UsagePlan::ThrottleHasBeenSet ( ) const
inline

The request throttle limits of a usage plan.

Definition at line 223 of file UsagePlan.h.

◆ WithApiStages() [1/2]

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

The associated API stages of a usage plan.

Definition at line 197 of file UsagePlan.h.

◆ WithApiStages() [2/2]

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

The associated API stages of a usage plan.

Definition at line 202 of file UsagePlan.h.

◆ WithDescription() [1/3]

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

The description of a usage plan.

Definition at line 161 of file UsagePlan.h.

◆ WithDescription() [2/3]

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

The description of a usage plan.

Definition at line 166 of file UsagePlan.h.

◆ WithDescription() [3/3]

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

The description of a usage plan.

Definition at line 171 of file UsagePlan.h.

◆ WithId() [1/3]

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

The identifier of a UsagePlan resource.

Definition at line 79 of file UsagePlan.h.

◆ WithId() [2/3]

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

The identifier of a UsagePlan resource.

Definition at line 84 of file UsagePlan.h.

◆ WithId() [3/3]

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

The identifier of a UsagePlan resource.

Definition at line 89 of file UsagePlan.h.

◆ WithName() [1/3]

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

The name of a usage plan.

Definition at line 120 of file UsagePlan.h.

◆ WithName() [2/3]

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

The name of a usage plan.

Definition at line 125 of file UsagePlan.h.

◆ WithName() [3/3]

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

The name of a usage plan.

Definition at line 130 of file UsagePlan.h.

◆ WithProductCode() [1/3]

UsagePlan& Aws::APIGateway::Model::UsagePlan::WithProductCode ( const Aws::String value)
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 311 of file UsagePlan.h.

◆ WithProductCode() [2/3]

UsagePlan& Aws::APIGateway::Model::UsagePlan::WithProductCode ( Aws::String &&  value)
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 317 of file UsagePlan.h.

◆ WithProductCode() [3/3]

UsagePlan& Aws::APIGateway::Model::UsagePlan::WithProductCode ( const char *  value)
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 323 of file UsagePlan.h.

◆ WithQuota() [1/2]

UsagePlan& Aws::APIGateway::Model::UsagePlan::WithQuota ( const QuotaSettings value)
inline

The maximum number of permitted requests per a given unit time interval.

Definition at line 269 of file UsagePlan.h.

◆ WithQuota() [2/2]

UsagePlan& Aws::APIGateway::Model::UsagePlan::WithQuota ( QuotaSettings &&  value)
inline

The maximum number of permitted requests per a given unit time interval.

Definition at line 274 of file UsagePlan.h.

◆ WithTags() [1/2]

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

◆ WithTags() [2/2]

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

◆ WithThrottle() [1/2]

UsagePlan& Aws::APIGateway::Model::UsagePlan::WithThrottle ( const ThrottleSettings value)
inline

The request throttle limits of a usage plan.

Definition at line 238 of file UsagePlan.h.

◆ WithThrottle() [2/2]

UsagePlan& Aws::APIGateway::Model::UsagePlan::WithThrottle ( ThrottleSettings &&  value)
inline

The request throttle limits of a usage plan.

Definition at line 243 of file UsagePlan.h.


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