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

#include <UsagePlanKey.h>

Public Member Functions

 UsagePlanKey ()
 
 UsagePlanKey (Aws::Utils::Json::JsonView jsonValue)
 
UsagePlanKeyoperator= (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)
 
UsagePlanKeyWithId (const Aws::String &value)
 
UsagePlanKeyWithId (Aws::String &&value)
 
UsagePlanKeyWithId (const char *value)
 
const Aws::StringGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const Aws::String &value)
 
void SetType (Aws::String &&value)
 
void SetType (const char *value)
 
UsagePlanKeyWithType (const Aws::String &value)
 
UsagePlanKeyWithType (Aws::String &&value)
 
UsagePlanKeyWithType (const char *value)
 
const Aws::StringGetValue () const
 
bool ValueHasBeenSet () const
 
void SetValue (const Aws::String &value)
 
void SetValue (Aws::String &&value)
 
void SetValue (const char *value)
 
UsagePlanKeyWithValue (const Aws::String &value)
 
UsagePlanKeyWithValue (Aws::String &&value)
 
UsagePlanKeyWithValue (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)
 
UsagePlanKeyWithName (const Aws::String &value)
 
UsagePlanKeyWithName (Aws::String &&value)
 
UsagePlanKeyWithName (const char *value)
 

Detailed Description

Represents a usage plan key to identify a plan customer.

To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.

" <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html">Create and Use Usage Plans

See Also:

AWS API Reference

Definition at line 36 of file UsagePlanKey.h.

Constructor & Destructor Documentation

◆ UsagePlanKey() [1/2]

Aws::APIGateway::Model::UsagePlanKey::UsagePlanKey ( )

◆ UsagePlanKey() [2/2]

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

Member Function Documentation

◆ GetId()

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

The Id of a usage plan key.

Definition at line 48 of file UsagePlanKey.h.

◆ GetName()

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

The name of a usage plan key.

Definition at line 179 of file UsagePlanKey.h.

◆ GetType()

const Aws::String& Aws::APIGateway::Model::UsagePlanKey::GetType ( ) const
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 90 of file UsagePlanKey.h.

◆ GetValue()

const Aws::String& Aws::APIGateway::Model::UsagePlanKey::GetValue ( ) const
inline

The value of a usage plan key.

Definition at line 138 of file UsagePlanKey.h.

◆ IdHasBeenSet()

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

The Id of a usage plan key.

Definition at line 53 of file UsagePlanKey.h.

◆ Jsonize()

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

◆ NameHasBeenSet()

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

The name of a usage plan key.

Definition at line 184 of file UsagePlanKey.h.

◆ operator=()

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

◆ SetId() [1/3]

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

The Id of a usage plan key.

Definition at line 58 of file UsagePlanKey.h.

◆ SetId() [2/3]

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

The Id of a usage plan key.

Definition at line 63 of file UsagePlanKey.h.

◆ SetId() [3/3]

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

The Id of a usage plan key.

Definition at line 68 of file UsagePlanKey.h.

◆ SetName() [1/3]

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

The name of a usage plan key.

Definition at line 189 of file UsagePlanKey.h.

◆ SetName() [2/3]

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

The name of a usage plan key.

Definition at line 194 of file UsagePlanKey.h.

◆ SetName() [3/3]

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

The name of a usage plan key.

Definition at line 199 of file UsagePlanKey.h.

◆ SetType() [1/3]

void Aws::APIGateway::Model::UsagePlanKey::SetType ( const Aws::String value)
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 102 of file UsagePlanKey.h.

◆ SetType() [2/3]

void Aws::APIGateway::Model::UsagePlanKey::SetType ( Aws::String &&  value)
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 108 of file UsagePlanKey.h.

◆ SetType() [3/3]

void Aws::APIGateway::Model::UsagePlanKey::SetType ( const char *  value)
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 114 of file UsagePlanKey.h.

◆ SetValue() [1/3]

void Aws::APIGateway::Model::UsagePlanKey::SetValue ( const Aws::String value)
inline

The value of a usage plan key.

Definition at line 148 of file UsagePlanKey.h.

◆ SetValue() [2/3]

void Aws::APIGateway::Model::UsagePlanKey::SetValue ( Aws::String &&  value)
inline

The value of a usage plan key.

Definition at line 153 of file UsagePlanKey.h.

◆ SetValue() [3/3]

void Aws::APIGateway::Model::UsagePlanKey::SetValue ( const char *  value)
inline

The value of a usage plan key.

Definition at line 158 of file UsagePlanKey.h.

◆ TypeHasBeenSet()

bool Aws::APIGateway::Model::UsagePlanKey::TypeHasBeenSet ( ) const
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 96 of file UsagePlanKey.h.

◆ ValueHasBeenSet()

bool Aws::APIGateway::Model::UsagePlanKey::ValueHasBeenSet ( ) const
inline

The value of a usage plan key.

Definition at line 143 of file UsagePlanKey.h.

◆ WithId() [1/3]

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

The Id of a usage plan key.

Definition at line 73 of file UsagePlanKey.h.

◆ WithId() [2/3]

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

The Id of a usage plan key.

Definition at line 78 of file UsagePlanKey.h.

◆ WithId() [3/3]

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

The Id of a usage plan key.

Definition at line 83 of file UsagePlanKey.h.

◆ WithName() [1/3]

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

The name of a usage plan key.

Definition at line 204 of file UsagePlanKey.h.

◆ WithName() [2/3]

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

The name of a usage plan key.

Definition at line 209 of file UsagePlanKey.h.

◆ WithName() [3/3]

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

The name of a usage plan key.

Definition at line 214 of file UsagePlanKey.h.

◆ WithType() [1/3]

UsagePlanKey& Aws::APIGateway::Model::UsagePlanKey::WithType ( const Aws::String value)
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 120 of file UsagePlanKey.h.

◆ WithType() [2/3]

UsagePlanKey& Aws::APIGateway::Model::UsagePlanKey::WithType ( Aws::String &&  value)
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 126 of file UsagePlanKey.h.

◆ WithType() [3/3]

UsagePlanKey& Aws::APIGateway::Model::UsagePlanKey::WithType ( const char *  value)
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 132 of file UsagePlanKey.h.

◆ WithValue() [1/3]

UsagePlanKey& Aws::APIGateway::Model::UsagePlanKey::WithValue ( const Aws::String value)
inline

The value of a usage plan key.

Definition at line 163 of file UsagePlanKey.h.

◆ WithValue() [2/3]

UsagePlanKey& Aws::APIGateway::Model::UsagePlanKey::WithValue ( Aws::String &&  value)
inline

The value of a usage plan key.

Definition at line 168 of file UsagePlanKey.h.

◆ WithValue() [3/3]

UsagePlanKey& Aws::APIGateway::Model::UsagePlanKey::WithValue ( const char *  value)
inline

The value of a usage plan key.

Definition at line 173 of file UsagePlanKey.h.


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