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

#include <ApiKey.h>

Public Member Functions

 ApiKey ()
 
 ApiKey (Aws::Utils::Json::JsonView jsonValue)
 
ApiKeyoperator= (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)
 
ApiKeyWithId (const Aws::String &value)
 
ApiKeyWithId (Aws::String &&value)
 
ApiKeyWithId (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)
 
ApiKeyWithValue (const Aws::String &value)
 
ApiKeyWithValue (Aws::String &&value)
 
ApiKeyWithValue (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)
 
ApiKeyWithName (const Aws::String &value)
 
ApiKeyWithName (Aws::String &&value)
 
ApiKeyWithName (const char *value)
 
const Aws::StringGetCustomerId () const
 
bool CustomerIdHasBeenSet () const
 
void SetCustomerId (const Aws::String &value)
 
void SetCustomerId (Aws::String &&value)
 
void SetCustomerId (const char *value)
 
ApiKeyWithCustomerId (const Aws::String &value)
 
ApiKeyWithCustomerId (Aws::String &&value)
 
ApiKeyWithCustomerId (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)
 
ApiKeyWithDescription (const Aws::String &value)
 
ApiKeyWithDescription (Aws::String &&value)
 
ApiKeyWithDescription (const char *value)
 
bool GetEnabled () const
 
bool EnabledHasBeenSet () const
 
void SetEnabled (bool value)
 
ApiKeyWithEnabled (bool value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
bool CreatedDateHasBeenSet () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
ApiKeyWithCreatedDate (const Aws::Utils::DateTime &value)
 
ApiKeyWithCreatedDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdatedDate () const
 
bool LastUpdatedDateHasBeenSet () const
 
void SetLastUpdatedDate (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedDate (Aws::Utils::DateTime &&value)
 
ApiKeyWithLastUpdatedDate (const Aws::Utils::DateTime &value)
 
ApiKeyWithLastUpdatedDate (Aws::Utils::DateTime &&value)
 
const Aws::Vector< Aws::String > & GetStageKeys () const
 
bool StageKeysHasBeenSet () const
 
void SetStageKeys (const Aws::Vector< Aws::String > &value)
 
void SetStageKeys (Aws::Vector< Aws::String > &&value)
 
ApiKeyWithStageKeys (const Aws::Vector< Aws::String > &value)
 
ApiKeyWithStageKeys (Aws::Vector< Aws::String > &&value)
 
ApiKeyAddStageKeys (const Aws::String &value)
 
ApiKeyAddStageKeys (Aws::String &&value)
 
ApiKeyAddStageKeys (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)
 
ApiKeyWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
ApiKeyWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
ApiKeyAddTags (const Aws::String &key, const Aws::String &value)
 
ApiKeyAddTags (Aws::String &&key, const Aws::String &value)
 
ApiKeyAddTags (const Aws::String &key, Aws::String &&value)
 
ApiKeyAddTags (Aws::String &&key, Aws::String &&value)
 
ApiKeyAddTags (const char *key, Aws::String &&value)
 
ApiKeyAddTags (Aws::String &&key, const char *value)
 
ApiKeyAddTags (const char *key, const char *value)
 

Detailed Description

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

See Also:

AWS API Reference

Definition at line 39 of file ApiKey.h.

Constructor & Destructor Documentation

◆ ApiKey() [1/2]

Aws::APIGateway::Model::ApiKey::ApiKey ( )

◆ ApiKey() [2/2]

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

Member Function Documentation

◆ AddStageKeys() [1/3]

ApiKey& Aws::APIGateway::Model::ApiKey::AddStageKeys ( const Aws::String value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 384 of file ApiKey.h.

◆ AddStageKeys() [2/3]

ApiKey& Aws::APIGateway::Model::ApiKey::AddStageKeys ( Aws::String &&  value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 390 of file ApiKey.h.

◆ AddStageKeys() [3/3]

ApiKey& Aws::APIGateway::Model::ApiKey::AddStageKeys ( const char *  value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 396 of file ApiKey.h.

◆ AddTags() [1/7]

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

◆ AddTags() [2/7]

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

◆ AddTags() [3/7]

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

◆ AddTags() [4/7]

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

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

Definition at line 457 of file ApiKey.h.

◆ AddTags() [5/7]

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

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

Definition at line 463 of file ApiKey.h.

◆ AddTags() [6/7]

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

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

Definition at line 469 of file ApiKey.h.

◆ AddTags() [7/7]

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

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

Definition at line 475 of file ApiKey.h.

◆ CreatedDateHasBeenSet()

bool Aws::APIGateway::Model::ApiKey::CreatedDateHasBeenSet ( ) const
inline

The timestamp when the API Key was created.

Definition at line 290 of file ApiKey.h.

◆ CustomerIdHasBeenSet()

bool Aws::APIGateway::Model::ApiKey::CustomerIdHasBeenSet ( ) const
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 181 of file ApiKey.h.

◆ DescriptionHasBeenSet()

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

The description of the API Key.

Definition at line 228 of file ApiKey.h.

◆ EnabledHasBeenSet()

bool Aws::APIGateway::Model::ApiKey::EnabledHasBeenSet ( ) const
inline

Specifies whether the API Key can be used by callers.

Definition at line 269 of file ApiKey.h.

◆ GetCreatedDate()

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

The timestamp when the API Key was created.

Definition at line 285 of file ApiKey.h.

◆ GetCustomerId()

const Aws::String& Aws::APIGateway::Model::ApiKey::GetCustomerId ( ) const
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 175 of file ApiKey.h.

◆ GetDescription()

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

The description of the API Key.

Definition at line 223 of file ApiKey.h.

◆ GetEnabled()

bool Aws::APIGateway::Model::ApiKey::GetEnabled ( ) const
inline

Specifies whether the API Key can be used by callers.

Definition at line 264 of file ApiKey.h.

◆ GetId()

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

The identifier of the API Key.

Definition at line 51 of file ApiKey.h.

◆ GetLastUpdatedDate()

const Aws::Utils::DateTime& Aws::APIGateway::Model::ApiKey::GetLastUpdatedDate ( ) const
inline

The timestamp when the API Key was last updated.

Definition at line 316 of file ApiKey.h.

◆ GetName()

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

The name of the API Key.

Definition at line 133 of file ApiKey.h.

◆ GetStageKeys()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::ApiKey::GetStageKeys ( ) const
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 348 of file ApiKey.h.

◆ GetTags()

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

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

Definition at line 403 of file ApiKey.h.

◆ GetValue()

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

The value of the API Key.

Definition at line 92 of file ApiKey.h.

◆ IdHasBeenSet()

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

The identifier of the API Key.

Definition at line 56 of file ApiKey.h.

◆ Jsonize()

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

◆ LastUpdatedDateHasBeenSet()

bool Aws::APIGateway::Model::ApiKey::LastUpdatedDateHasBeenSet ( ) const
inline

The timestamp when the API Key was last updated.

Definition at line 321 of file ApiKey.h.

◆ NameHasBeenSet()

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

The name of the API Key.

Definition at line 138 of file ApiKey.h.

◆ operator=()

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

◆ SetCreatedDate() [1/2]

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

The timestamp when the API Key was created.

Definition at line 295 of file ApiKey.h.

◆ SetCreatedDate() [2/2]

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

The timestamp when the API Key was created.

Definition at line 300 of file ApiKey.h.

◆ SetCustomerId() [1/3]

void Aws::APIGateway::Model::ApiKey::SetCustomerId ( const Aws::String value)
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 187 of file ApiKey.h.

◆ SetCustomerId() [2/3]

void Aws::APIGateway::Model::ApiKey::SetCustomerId ( Aws::String &&  value)
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 193 of file ApiKey.h.

◆ SetCustomerId() [3/3]

void Aws::APIGateway::Model::ApiKey::SetCustomerId ( const char *  value)
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 199 of file ApiKey.h.

◆ SetDescription() [1/3]

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

The description of the API Key.

Definition at line 233 of file ApiKey.h.

◆ SetDescription() [2/3]

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

The description of the API Key.

Definition at line 238 of file ApiKey.h.

◆ SetDescription() [3/3]

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

The description of the API Key.

Definition at line 243 of file ApiKey.h.

◆ SetEnabled()

void Aws::APIGateway::Model::ApiKey::SetEnabled ( bool  value)
inline

Specifies whether the API Key can be used by callers.

Definition at line 274 of file ApiKey.h.

◆ SetId() [1/3]

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

The identifier of the API Key.

Definition at line 61 of file ApiKey.h.

◆ SetId() [2/3]

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

The identifier of the API Key.

Definition at line 66 of file ApiKey.h.

◆ SetId() [3/3]

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

The identifier of the API Key.

Definition at line 71 of file ApiKey.h.

◆ SetLastUpdatedDate() [1/2]

void Aws::APIGateway::Model::ApiKey::SetLastUpdatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the API Key was last updated.

Definition at line 326 of file ApiKey.h.

◆ SetLastUpdatedDate() [2/2]

void Aws::APIGateway::Model::ApiKey::SetLastUpdatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the API Key was last updated.

Definition at line 331 of file ApiKey.h.

◆ SetName() [1/3]

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

The name of the API Key.

Definition at line 143 of file ApiKey.h.

◆ SetName() [2/3]

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

The name of the API Key.

Definition at line 148 of file ApiKey.h.

◆ SetName() [3/3]

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

The name of the API Key.

Definition at line 153 of file ApiKey.h.

◆ SetStageKeys() [1/2]

void Aws::APIGateway::Model::ApiKey::SetStageKeys ( const Aws::Vector< Aws::String > &  value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 360 of file ApiKey.h.

◆ SetStageKeys() [2/2]

void Aws::APIGateway::Model::ApiKey::SetStageKeys ( Aws::Vector< Aws::String > &&  value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 366 of file ApiKey.h.

◆ SetTags() [1/2]

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

◆ SetTags() [2/2]

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

◆ SetValue() [1/3]

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

The value of the API Key.

Definition at line 102 of file ApiKey.h.

◆ SetValue() [2/3]

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

The value of the API Key.

Definition at line 107 of file ApiKey.h.

◆ SetValue() [3/3]

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

The value of the API Key.

Definition at line 112 of file ApiKey.h.

◆ StageKeysHasBeenSet()

bool Aws::APIGateway::Model::ApiKey::StageKeysHasBeenSet ( ) const
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 354 of file ApiKey.h.

◆ TagsHasBeenSet()

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

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

Definition at line 409 of file ApiKey.h.

◆ ValueHasBeenSet()

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

The value of the API Key.

Definition at line 97 of file ApiKey.h.

◆ WithCreatedDate() [1/2]

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

The timestamp when the API Key was created.

Definition at line 305 of file ApiKey.h.

◆ WithCreatedDate() [2/2]

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

The timestamp when the API Key was created.

Definition at line 310 of file ApiKey.h.

◆ WithCustomerId() [1/3]

ApiKey& Aws::APIGateway::Model::ApiKey::WithCustomerId ( const Aws::String value)
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 205 of file ApiKey.h.

◆ WithCustomerId() [2/3]

ApiKey& Aws::APIGateway::Model::ApiKey::WithCustomerId ( Aws::String &&  value)
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 211 of file ApiKey.h.

◆ WithCustomerId() [3/3]

ApiKey& Aws::APIGateway::Model::ApiKey::WithCustomerId ( const char *  value)
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 217 of file ApiKey.h.

◆ WithDescription() [1/3]

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

The description of the API Key.

Definition at line 248 of file ApiKey.h.

◆ WithDescription() [2/3]

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

The description of the API Key.

Definition at line 253 of file ApiKey.h.

◆ WithDescription() [3/3]

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

The description of the API Key.

Definition at line 258 of file ApiKey.h.

◆ WithEnabled()

ApiKey& Aws::APIGateway::Model::ApiKey::WithEnabled ( bool  value)
inline

Specifies whether the API Key can be used by callers.

Definition at line 279 of file ApiKey.h.

◆ WithId() [1/3]

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

The identifier of the API Key.

Definition at line 76 of file ApiKey.h.

◆ WithId() [2/3]

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

The identifier of the API Key.

Definition at line 81 of file ApiKey.h.

◆ WithId() [3/3]

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

The identifier of the API Key.

Definition at line 86 of file ApiKey.h.

◆ WithLastUpdatedDate() [1/2]

ApiKey& Aws::APIGateway::Model::ApiKey::WithLastUpdatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the API Key was last updated.

Definition at line 336 of file ApiKey.h.

◆ WithLastUpdatedDate() [2/2]

ApiKey& Aws::APIGateway::Model::ApiKey::WithLastUpdatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the API Key was last updated.

Definition at line 341 of file ApiKey.h.

◆ WithName() [1/3]

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

The name of the API Key.

Definition at line 158 of file ApiKey.h.

◆ WithName() [2/3]

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

The name of the API Key.

Definition at line 163 of file ApiKey.h.

◆ WithName() [3/3]

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

The name of the API Key.

Definition at line 168 of file ApiKey.h.

◆ WithStageKeys() [1/2]

ApiKey& Aws::APIGateway::Model::ApiKey::WithStageKeys ( const Aws::Vector< Aws::String > &  value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 372 of file ApiKey.h.

◆ WithStageKeys() [2/2]

ApiKey& Aws::APIGateway::Model::ApiKey::WithStageKeys ( Aws::Vector< Aws::String > &&  value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 378 of file ApiKey.h.

◆ WithTags() [1/2]

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

◆ WithTags() [2/2]

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

◆ WithValue() [1/3]

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

The value of the API Key.

Definition at line 117 of file ApiKey.h.

◆ WithValue() [2/3]

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

The value of the API Key.

Definition at line 122 of file ApiKey.h.

◆ WithValue() [3/3]

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

The value of the API Key.

Definition at line 127 of file ApiKey.h.


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