AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::AppSync::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::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)
 
long long GetExpires () const
 
bool ExpiresHasBeenSet () const
 
void SetExpires (long long value)
 
ApiKeyWithExpires (long long value)
 
long long GetDeletes () const
 
bool DeletesHasBeenSet () const
 
void SetDeletes (long long value)
 
ApiKeyWithDeletes (long long value)
 

Detailed Description

Describes an API key.

Customers invoke AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:

da1: This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that date.

da2: This version was introduced in February 2018 when AppSync added support to extend key expiration.

See Also:

AWS API Reference

Definition at line 58 of file ApiKey.h.

Constructor & Destructor Documentation

◆ ApiKey() [1/2]

Aws::AppSync::Model::ApiKey::ApiKey ( )

◆ ApiKey() [2/2]

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

Member Function Documentation

◆ DeletesHasBeenSet()

bool Aws::AppSync::Model::ApiKey::DeletesHasBeenSet ( ) const
inline

The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Definition at line 184 of file ApiKey.h.

◆ DescriptionHasBeenSet()

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

A description of the purpose of the API key.

Definition at line 116 of file ApiKey.h.

◆ ExpiresHasBeenSet()

bool Aws::AppSync::Model::ApiKey::ExpiresHasBeenSet ( ) const
inline

The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Definition at line 159 of file ApiKey.h.

◆ GetDeletes()

long long Aws::AppSync::Model::ApiKey::GetDeletes ( ) const
inline

The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Definition at line 178 of file ApiKey.h.

◆ GetDescription()

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

A description of the purpose of the API key.

Definition at line 111 of file ApiKey.h.

◆ GetExpires()

long long Aws::AppSync::Model::ApiKey::GetExpires ( ) const
inline

The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Definition at line 153 of file ApiKey.h.

◆ GetId()

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

The API key ID.

Definition at line 70 of file ApiKey.h.

◆ IdHasBeenSet()

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

The API key ID.

Definition at line 75 of file ApiKey.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetDeletes()

void Aws::AppSync::Model::ApiKey::SetDeletes ( long long  value)
inline

The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Definition at line 190 of file ApiKey.h.

◆ SetDescription() [1/3]

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

A description of the purpose of the API key.

Definition at line 126 of file ApiKey.h.

◆ SetDescription() [2/3]

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

A description of the purpose of the API key.

Definition at line 121 of file ApiKey.h.

◆ SetDescription() [3/3]

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

A description of the purpose of the API key.

Definition at line 131 of file ApiKey.h.

◆ SetExpires()

void Aws::AppSync::Model::ApiKey::SetExpires ( long long  value)
inline

The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Definition at line 165 of file ApiKey.h.

◆ SetId() [1/3]

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

The API key ID.

Definition at line 85 of file ApiKey.h.

◆ SetId() [2/3]

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

The API key ID.

Definition at line 80 of file ApiKey.h.

◆ SetId() [3/3]

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

The API key ID.

Definition at line 90 of file ApiKey.h.

◆ WithDeletes()

ApiKey& Aws::AppSync::Model::ApiKey::WithDeletes ( long long  value)
inline

The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Definition at line 196 of file ApiKey.h.

◆ WithDescription() [1/3]

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

A description of the purpose of the API key.

Definition at line 141 of file ApiKey.h.

◆ WithDescription() [2/3]

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

A description of the purpose of the API key.

Definition at line 136 of file ApiKey.h.

◆ WithDescription() [3/3]

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

A description of the purpose of the API key.

Definition at line 146 of file ApiKey.h.

◆ WithExpires()

ApiKey& Aws::AppSync::Model::ApiKey::WithExpires ( long long  value)
inline

The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Definition at line 171 of file ApiKey.h.

◆ WithId() [1/3]

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

The API key ID.

Definition at line 100 of file ApiKey.h.

◆ WithId() [2/3]

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

The API key ID.

Definition at line 95 of file ApiKey.h.

◆ WithId() [3/3]

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

The API key ID.

Definition at line 105 of file ApiKey.h.


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