AWS SDK for C++  1.9.109
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::AccessKey Class Reference

#include <AccessKey.h>

Public Member Functions

 AccessKey ()
 
 AccessKey (Aws::Utils::Json::JsonView jsonValue)
 
AccessKeyoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetAccessKeyId () const
 
bool AccessKeyIdHasBeenSet () const
 
void SetAccessKeyId (const Aws::String &value)
 
void SetAccessKeyId (Aws::String &&value)
 
void SetAccessKeyId (const char *value)
 
AccessKeyWithAccessKeyId (const Aws::String &value)
 
AccessKeyWithAccessKeyId (Aws::String &&value)
 
AccessKeyWithAccessKeyId (const char *value)
 
const Aws::StringGetSecretAccessKey () const
 
bool SecretAccessKeyHasBeenSet () const
 
void SetSecretAccessKey (const Aws::String &value)
 
void SetSecretAccessKey (Aws::String &&value)
 
void SetSecretAccessKey (const char *value)
 
AccessKeyWithSecretAccessKey (const Aws::String &value)
 
AccessKeyWithSecretAccessKey (Aws::String &&value)
 
AccessKeyWithSecretAccessKey (const char *value)
 
const StatusTypeGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const StatusType &value)
 
void SetStatus (StatusType &&value)
 
AccessKeyWithStatus (const StatusType &value)
 
AccessKeyWithStatus (StatusType &&value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
AccessKeyWithCreatedAt (const Aws::Utils::DateTime &value)
 
AccessKeyWithCreatedAt (Aws::Utils::DateTime &&value)
 
const AccessKeyLastUsedGetLastUsed () const
 
bool LastUsedHasBeenSet () const
 
void SetLastUsed (const AccessKeyLastUsed &value)
 
void SetLastUsed (AccessKeyLastUsed &&value)
 
AccessKeyWithLastUsed (const AccessKeyLastUsed &value)
 
AccessKeyWithLastUsed (AccessKeyLastUsed &&value)
 

Detailed Description

Describes an access key for an Amazon Lightsail bucket.

Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.

See Also:

AWS API Reference

Definition at line 45 of file AccessKey.h.

Constructor & Destructor Documentation

◆ AccessKey() [1/2]

Aws::Lightsail::Model::AccessKey::AccessKey ( )

◆ AccessKey() [2/2]

Aws::Lightsail::Model::AccessKey::AccessKey ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AccessKeyIdHasBeenSet()

bool Aws::Lightsail::Model::AccessKey::AccessKeyIdHasBeenSet ( ) const
inline

The ID of the access key.

Definition at line 62 of file AccessKey.h.

◆ CreatedAtHasBeenSet()

bool Aws::Lightsail::Model::AccessKey::CreatedAtHasBeenSet ( ) const
inline

The timestamp when the access key was created.

Definition at line 197 of file AccessKey.h.

◆ GetAccessKeyId()

const Aws::String& Aws::Lightsail::Model::AccessKey::GetAccessKeyId ( ) const
inline

The ID of the access key.

Definition at line 57 of file AccessKey.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::Lightsail::Model::AccessKey::GetCreatedAt ( ) const
inline

The timestamp when the access key was created.

Definition at line 192 of file AccessKey.h.

◆ GetLastUsed()

const AccessKeyLastUsed& Aws::Lightsail::Model::AccessKey::GetLastUsed ( ) const
inline

An object that describes the last time the access key was used.

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.

Definition at line 227 of file AccessKey.h.

◆ GetSecretAccessKey()

const Aws::String& Aws::Lightsail::Model::AccessKey::GetSecretAccessKey ( ) const
inline

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

Definition at line 100 of file AccessKey.h.

◆ GetStatus()

const StatusType& Aws::Lightsail::Model::AccessKey::GetStatus ( ) const
inline

The status of the access key.

A status of Active means that the key is valid, while Inactive means it is not.

Definition at line 156 of file AccessKey.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Lightsail::Model::AccessKey::Jsonize ( ) const

◆ LastUsedHasBeenSet()

bool Aws::Lightsail::Model::AccessKey::LastUsedHasBeenSet ( ) const
inline

An object that describes the last time the access key was used.

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.

Definition at line 236 of file AccessKey.h.

◆ operator=()

AccessKey& Aws::Lightsail::Model::AccessKey::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SecretAccessKeyHasBeenSet()

bool Aws::Lightsail::Model::AccessKey::SecretAccessKeyHasBeenSet ( ) const
inline

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

Definition at line 107 of file AccessKey.h.

◆ SetAccessKeyId() [1/3]

void Aws::Lightsail::Model::AccessKey::SetAccessKeyId ( Aws::String &&  value)
inline

The ID of the access key.

Definition at line 72 of file AccessKey.h.

◆ SetAccessKeyId() [2/3]

void Aws::Lightsail::Model::AccessKey::SetAccessKeyId ( const Aws::String value)
inline

The ID of the access key.

Definition at line 67 of file AccessKey.h.

◆ SetAccessKeyId() [3/3]

void Aws::Lightsail::Model::AccessKey::SetAccessKeyId ( const char *  value)
inline

The ID of the access key.

Definition at line 77 of file AccessKey.h.

◆ SetCreatedAt() [1/2]

void Aws::Lightsail::Model::AccessKey::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the access key was created.

Definition at line 207 of file AccessKey.h.

◆ SetCreatedAt() [2/2]

void Aws::Lightsail::Model::AccessKey::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The timestamp when the access key was created.

Definition at line 202 of file AccessKey.h.

◆ SetLastUsed() [1/2]

void Aws::Lightsail::Model::AccessKey::SetLastUsed ( AccessKeyLastUsed &&  value)
inline

An object that describes the last time the access key was used.

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.

Definition at line 254 of file AccessKey.h.

◆ SetLastUsed() [2/2]

void Aws::Lightsail::Model::AccessKey::SetLastUsed ( const AccessKeyLastUsed value)
inline

An object that describes the last time the access key was used.

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.

Definition at line 245 of file AccessKey.h.

◆ SetSecretAccessKey() [1/3]

void Aws::Lightsail::Model::AccessKey::SetSecretAccessKey ( Aws::String &&  value)
inline

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

Definition at line 121 of file AccessKey.h.

◆ SetSecretAccessKey() [2/3]

void Aws::Lightsail::Model::AccessKey::SetSecretAccessKey ( const Aws::String value)
inline

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

Definition at line 114 of file AccessKey.h.

◆ SetSecretAccessKey() [3/3]

void Aws::Lightsail::Model::AccessKey::SetSecretAccessKey ( const char *  value)
inline

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

Definition at line 128 of file AccessKey.h.

◆ SetStatus() [1/2]

void Aws::Lightsail::Model::AccessKey::SetStatus ( const StatusType value)
inline

The status of the access key.

A status of Active means that the key is valid, while Inactive means it is not.

Definition at line 168 of file AccessKey.h.

◆ SetStatus() [2/2]

void Aws::Lightsail::Model::AccessKey::SetStatus ( StatusType &&  value)
inline

The status of the access key.

A status of Active means that the key is valid, while Inactive means it is not.

Definition at line 174 of file AccessKey.h.

◆ StatusHasBeenSet()

bool Aws::Lightsail::Model::AccessKey::StatusHasBeenSet ( ) const
inline

The status of the access key.

A status of Active means that the key is valid, while Inactive means it is not.

Definition at line 162 of file AccessKey.h.

◆ WithAccessKeyId() [1/3]

AccessKey& Aws::Lightsail::Model::AccessKey::WithAccessKeyId ( Aws::String &&  value)
inline

The ID of the access key.

Definition at line 87 of file AccessKey.h.

◆ WithAccessKeyId() [2/3]

AccessKey& Aws::Lightsail::Model::AccessKey::WithAccessKeyId ( const Aws::String value)
inline

The ID of the access key.

Definition at line 82 of file AccessKey.h.

◆ WithAccessKeyId() [3/3]

AccessKey& Aws::Lightsail::Model::AccessKey::WithAccessKeyId ( const char *  value)
inline

The ID of the access key.

Definition at line 92 of file AccessKey.h.

◆ WithCreatedAt() [1/2]

AccessKey& Aws::Lightsail::Model::AccessKey::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the access key was created.

Definition at line 217 of file AccessKey.h.

◆ WithCreatedAt() [2/2]

AccessKey& Aws::Lightsail::Model::AccessKey::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The timestamp when the access key was created.

Definition at line 212 of file AccessKey.h.

◆ WithLastUsed() [1/2]

AccessKey& Aws::Lightsail::Model::AccessKey::WithLastUsed ( AccessKeyLastUsed &&  value)
inline

An object that describes the last time the access key was used.

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.

Definition at line 272 of file AccessKey.h.

◆ WithLastUsed() [2/2]

AccessKey& Aws::Lightsail::Model::AccessKey::WithLastUsed ( const AccessKeyLastUsed value)
inline

An object that describes the last time the access key was used.

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.

Definition at line 263 of file AccessKey.h.

◆ WithSecretAccessKey() [1/3]

AccessKey& Aws::Lightsail::Model::AccessKey::WithSecretAccessKey ( Aws::String &&  value)
inline

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

Definition at line 142 of file AccessKey.h.

◆ WithSecretAccessKey() [2/3]

AccessKey& Aws::Lightsail::Model::AccessKey::WithSecretAccessKey ( const Aws::String value)
inline

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

Definition at line 135 of file AccessKey.h.

◆ WithSecretAccessKey() [3/3]

AccessKey& Aws::Lightsail::Model::AccessKey::WithSecretAccessKey ( const char *  value)
inline

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

Definition at line 149 of file AccessKey.h.

◆ WithStatus() [1/2]

AccessKey& Aws::Lightsail::Model::AccessKey::WithStatus ( const StatusType value)
inline

The status of the access key.

A status of Active means that the key is valid, while Inactive means it is not.

Definition at line 180 of file AccessKey.h.

◆ WithStatus() [2/2]

AccessKey& Aws::Lightsail::Model::AccessKey::WithStatus ( StatusType &&  value)
inline

The status of the access key.

A status of Active means that the key is valid, while Inactive means it is not.

Definition at line 186 of file AccessKey.h.


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