AWS SDK for C++  1.9.70
AWS SDK for C++
Public Member Functions | List of all members
Aws::SecurityHub::Model::AwsKmsKeyDetails Class Reference

#include <AwsKmsKeyDetails.h>

Public Member Functions

 AwsKmsKeyDetails ()
 
 AwsKmsKeyDetails (Aws::Utils::Json::JsonView jsonValue)
 
AwsKmsKeyDetailsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetAWSAccountId () const
 
bool AWSAccountIdHasBeenSet () const
 
void SetAWSAccountId (const Aws::String &value)
 
void SetAWSAccountId (Aws::String &&value)
 
void SetAWSAccountId (const char *value)
 
AwsKmsKeyDetailsWithAWSAccountId (const Aws::String &value)
 
AwsKmsKeyDetailsWithAWSAccountId (Aws::String &&value)
 
AwsKmsKeyDetailsWithAWSAccountId (const char *value)
 
double GetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (double value)
 
AwsKmsKeyDetailsWithCreationDate (double value)
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
AwsKmsKeyDetailsWithKeyId (const Aws::String &value)
 
AwsKmsKeyDetailsWithKeyId (Aws::String &&value)
 
AwsKmsKeyDetailsWithKeyId (const char *value)
 
const Aws::StringGetKeyManager () const
 
bool KeyManagerHasBeenSet () const
 
void SetKeyManager (const Aws::String &value)
 
void SetKeyManager (Aws::String &&value)
 
void SetKeyManager (const char *value)
 
AwsKmsKeyDetailsWithKeyManager (const Aws::String &value)
 
AwsKmsKeyDetailsWithKeyManager (Aws::String &&value)
 
AwsKmsKeyDetailsWithKeyManager (const char *value)
 
const Aws::StringGetKeyState () const
 
bool KeyStateHasBeenSet () const
 
void SetKeyState (const Aws::String &value)
 
void SetKeyState (Aws::String &&value)
 
void SetKeyState (const char *value)
 
AwsKmsKeyDetailsWithKeyState (const Aws::String &value)
 
AwsKmsKeyDetailsWithKeyState (Aws::String &&value)
 
AwsKmsKeyDetailsWithKeyState (const char *value)
 
const Aws::StringGetOrigin () const
 
bool OriginHasBeenSet () const
 
void SetOrigin (const Aws::String &value)
 
void SetOrigin (Aws::String &&value)
 
void SetOrigin (const char *value)
 
AwsKmsKeyDetailsWithOrigin (const Aws::String &value)
 
AwsKmsKeyDetailsWithOrigin (Aws::String &&value)
 
AwsKmsKeyDetailsWithOrigin (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)
 
AwsKmsKeyDetailsWithDescription (const Aws::String &value)
 
AwsKmsKeyDetailsWithDescription (Aws::String &&value)
 
AwsKmsKeyDetailsWithDescription (const char *value)
 

Detailed Description

Contains metadata about a customer master key (CMK).

See Also:

AWS API Reference

Definition at line 32 of file AwsKmsKeyDetails.h.

Constructor & Destructor Documentation

◆ AwsKmsKeyDetails() [1/2]

Aws::SecurityHub::Model::AwsKmsKeyDetails::AwsKmsKeyDetails ( )

◆ AwsKmsKeyDetails() [2/2]

Aws::SecurityHub::Model::AwsKmsKeyDetails::AwsKmsKeyDetails ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AWSAccountIdHasBeenSet()

bool Aws::SecurityHub::Model::AwsKmsKeyDetails::AWSAccountIdHasBeenSet ( ) const
inline

The twelve-digit account ID of the Amazon Web Services account that owns the CMK.

Definition at line 51 of file AwsKmsKeyDetails.h.

◆ CreationDateHasBeenSet()

bool Aws::SecurityHub::Model::AwsKmsKeyDetails::CreationDateHasBeenSet ( ) const
inline

Indicates when the CMK was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Definition at line 106 of file AwsKmsKeyDetails.h.

◆ DescriptionHasBeenSet()

bool Aws::SecurityHub::Model::AwsKmsKeyDetails::DescriptionHasBeenSet ( ) const
inline

A description of the key.

Definition at line 347 of file AwsKmsKeyDetails.h.

◆ GetAWSAccountId()

const Aws::String& Aws::SecurityHub::Model::AwsKmsKeyDetails::GetAWSAccountId ( ) const
inline

The twelve-digit account ID of the Amazon Web Services account that owns the CMK.

Definition at line 45 of file AwsKmsKeyDetails.h.

◆ GetCreationDate()

double Aws::SecurityHub::Model::AwsKmsKeyDetails::GetCreationDate ( ) const
inline

Indicates when the CMK was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Definition at line 97 of file AwsKmsKeyDetails.h.

◆ GetDescription()

const Aws::String& Aws::SecurityHub::Model::AwsKmsKeyDetails::GetDescription ( ) const
inline

A description of the key.

Definition at line 342 of file AwsKmsKeyDetails.h.

◆ GetKeyId()

const Aws::String& Aws::SecurityHub::Model::AwsKmsKeyDetails::GetKeyId ( ) const
inline

The globally unique identifier for the CMK.

Definition at line 130 of file AwsKmsKeyDetails.h.

◆ GetKeyManager()

const Aws::String& Aws::SecurityHub::Model::AwsKmsKeyDetails::GetKeyManager ( ) const
inline

The manager of the CMK. CMKs in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

Definition at line 172 of file AwsKmsKeyDetails.h.

◆ GetKeyState()

const Aws::String& Aws::SecurityHub::Model::AwsKmsKeyDetails::GetKeyState ( ) const
inline

The state of the CMK.

Definition at line 220 of file AwsKmsKeyDetails.h.

◆ GetOrigin()

const Aws::String& Aws::SecurityHub::Model::AwsKmsKeyDetails::GetOrigin ( ) const
inline

The source of the CMK's key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

Definition at line 266 of file AwsKmsKeyDetails.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SecurityHub::Model::AwsKmsKeyDetails::Jsonize ( ) const

◆ KeyIdHasBeenSet()

bool Aws::SecurityHub::Model::AwsKmsKeyDetails::KeyIdHasBeenSet ( ) const
inline

The globally unique identifier for the CMK.

Definition at line 135 of file AwsKmsKeyDetails.h.

◆ KeyManagerHasBeenSet()

bool Aws::SecurityHub::Model::AwsKmsKeyDetails::KeyManagerHasBeenSet ( ) const
inline

The manager of the CMK. CMKs in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

Definition at line 178 of file AwsKmsKeyDetails.h.

◆ KeyStateHasBeenSet()

bool Aws::SecurityHub::Model::AwsKmsKeyDetails::KeyStateHasBeenSet ( ) const
inline

The state of the CMK.

Definition at line 225 of file AwsKmsKeyDetails.h.

◆ operator=()

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OriginHasBeenSet()

bool Aws::SecurityHub::Model::AwsKmsKeyDetails::OriginHasBeenSet ( ) const
inline

The source of the CMK's key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

Definition at line 276 of file AwsKmsKeyDetails.h.

◆ SetAWSAccountId() [1/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetAWSAccountId ( Aws::String &&  value)
inline

The twelve-digit account ID of the Amazon Web Services account that owns the CMK.

Definition at line 63 of file AwsKmsKeyDetails.h.

◆ SetAWSAccountId() [2/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetAWSAccountId ( const Aws::String value)
inline

The twelve-digit account ID of the Amazon Web Services account that owns the CMK.

Definition at line 57 of file AwsKmsKeyDetails.h.

◆ SetAWSAccountId() [3/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetAWSAccountId ( const char *  value)
inline

The twelve-digit account ID of the Amazon Web Services account that owns the CMK.

Definition at line 69 of file AwsKmsKeyDetails.h.

◆ SetCreationDate()

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetCreationDate ( double  value)
inline

Indicates when the CMK was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Definition at line 115 of file AwsKmsKeyDetails.h.

◆ SetDescription() [1/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetDescription ( Aws::String &&  value)
inline

A description of the key.

Definition at line 357 of file AwsKmsKeyDetails.h.

◆ SetDescription() [2/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetDescription ( const Aws::String value)
inline

A description of the key.

Definition at line 352 of file AwsKmsKeyDetails.h.

◆ SetDescription() [3/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetDescription ( const char *  value)
inline

A description of the key.

Definition at line 362 of file AwsKmsKeyDetails.h.

◆ SetKeyId() [1/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetKeyId ( Aws::String &&  value)
inline

The globally unique identifier for the CMK.

Definition at line 145 of file AwsKmsKeyDetails.h.

◆ SetKeyId() [2/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetKeyId ( const Aws::String value)
inline

The globally unique identifier for the CMK.

Definition at line 140 of file AwsKmsKeyDetails.h.

◆ SetKeyId() [3/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetKeyId ( const char *  value)
inline

The globally unique identifier for the CMK.

Definition at line 150 of file AwsKmsKeyDetails.h.

◆ SetKeyManager() [1/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetKeyManager ( Aws::String &&  value)
inline

The manager of the CMK. CMKs in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

Definition at line 190 of file AwsKmsKeyDetails.h.

◆ SetKeyManager() [2/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetKeyManager ( const Aws::String value)
inline

The manager of the CMK. CMKs in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

Definition at line 184 of file AwsKmsKeyDetails.h.

◆ SetKeyManager() [3/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetKeyManager ( const char *  value)
inline

The manager of the CMK. CMKs in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

Definition at line 196 of file AwsKmsKeyDetails.h.

◆ SetKeyState() [1/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetKeyState ( Aws::String &&  value)
inline

The state of the CMK.

Definition at line 235 of file AwsKmsKeyDetails.h.

◆ SetKeyState() [2/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetKeyState ( const Aws::String value)
inline

The state of the CMK.

Definition at line 230 of file AwsKmsKeyDetails.h.

◆ SetKeyState() [3/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetKeyState ( const char *  value)
inline

The state of the CMK.

Definition at line 240 of file AwsKmsKeyDetails.h.

◆ SetOrigin() [1/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetOrigin ( Aws::String &&  value)
inline

The source of the CMK's key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

Definition at line 296 of file AwsKmsKeyDetails.h.

◆ SetOrigin() [2/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetOrigin ( const Aws::String value)
inline

The source of the CMK's key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

Definition at line 286 of file AwsKmsKeyDetails.h.

◆ SetOrigin() [3/3]

void Aws::SecurityHub::Model::AwsKmsKeyDetails::SetOrigin ( const char *  value)
inline

The source of the CMK's key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

Definition at line 306 of file AwsKmsKeyDetails.h.

◆ WithAWSAccountId() [1/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithAWSAccountId ( Aws::String &&  value)
inline

The twelve-digit account ID of the Amazon Web Services account that owns the CMK.

Definition at line 81 of file AwsKmsKeyDetails.h.

◆ WithAWSAccountId() [2/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithAWSAccountId ( const Aws::String value)
inline

The twelve-digit account ID of the Amazon Web Services account that owns the CMK.

Definition at line 75 of file AwsKmsKeyDetails.h.

◆ WithAWSAccountId() [3/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithAWSAccountId ( const char *  value)
inline

The twelve-digit account ID of the Amazon Web Services account that owns the CMK.

Definition at line 87 of file AwsKmsKeyDetails.h.

◆ WithCreationDate()

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithCreationDate ( double  value)
inline

Indicates when the CMK was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Definition at line 124 of file AwsKmsKeyDetails.h.

◆ WithDescription() [1/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithDescription ( Aws::String &&  value)
inline

A description of the key.

Definition at line 372 of file AwsKmsKeyDetails.h.

◆ WithDescription() [2/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithDescription ( const Aws::String value)
inline

A description of the key.

Definition at line 367 of file AwsKmsKeyDetails.h.

◆ WithDescription() [3/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithDescription ( const char *  value)
inline

A description of the key.

Definition at line 377 of file AwsKmsKeyDetails.h.

◆ WithKeyId() [1/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithKeyId ( Aws::String &&  value)
inline

The globally unique identifier for the CMK.

Definition at line 160 of file AwsKmsKeyDetails.h.

◆ WithKeyId() [2/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithKeyId ( const Aws::String value)
inline

The globally unique identifier for the CMK.

Definition at line 155 of file AwsKmsKeyDetails.h.

◆ WithKeyId() [3/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithKeyId ( const char *  value)
inline

The globally unique identifier for the CMK.

Definition at line 165 of file AwsKmsKeyDetails.h.

◆ WithKeyManager() [1/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithKeyManager ( Aws::String &&  value)
inline

The manager of the CMK. CMKs in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

Definition at line 208 of file AwsKmsKeyDetails.h.

◆ WithKeyManager() [2/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithKeyManager ( const Aws::String value)
inline

The manager of the CMK. CMKs in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

Definition at line 202 of file AwsKmsKeyDetails.h.

◆ WithKeyManager() [3/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithKeyManager ( const char *  value)
inline

The manager of the CMK. CMKs in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

Definition at line 214 of file AwsKmsKeyDetails.h.

◆ WithKeyState() [1/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithKeyState ( Aws::String &&  value)
inline

The state of the CMK.

Definition at line 250 of file AwsKmsKeyDetails.h.

◆ WithKeyState() [2/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithKeyState ( const Aws::String value)
inline

The state of the CMK.

Definition at line 245 of file AwsKmsKeyDetails.h.

◆ WithKeyState() [3/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithKeyState ( const char *  value)
inline

The state of the CMK.

Definition at line 255 of file AwsKmsKeyDetails.h.

◆ WithOrigin() [1/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithOrigin ( Aws::String &&  value)
inline

The source of the CMK's key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

Definition at line 326 of file AwsKmsKeyDetails.h.

◆ WithOrigin() [2/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithOrigin ( const Aws::String value)
inline

The source of the CMK's key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

Definition at line 316 of file AwsKmsKeyDetails.h.

◆ WithOrigin() [3/3]

AwsKmsKeyDetails& Aws::SecurityHub::Model::AwsKmsKeyDetails::WithOrigin ( const char *  value)
inline

The source of the CMK's key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

Definition at line 336 of file AwsKmsKeyDetails.h.


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