AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::KMS::Model::KeyMetadata Class Reference

#include <KeyMetadata.h>

Public Member Functions

 KeyMetadata ()
 
 KeyMetadata (Aws::Utils::Json::JsonView jsonValue)
 
KeyMetadataoperator= (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)
 
KeyMetadataWithAWSAccountId (const Aws::String &value)
 
KeyMetadataWithAWSAccountId (Aws::String &&value)
 
KeyMetadataWithAWSAccountId (const char *value)
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
KeyMetadataWithKeyId (const Aws::String &value)
 
KeyMetadataWithKeyId (Aws::String &&value)
 
KeyMetadataWithKeyId (const char *value)
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
KeyMetadataWithArn (const Aws::String &value)
 
KeyMetadataWithArn (Aws::String &&value)
 
KeyMetadataWithArn (const char *value)
 
const Aws::Utils::DateTimeGetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (const Aws::Utils::DateTime &value)
 
void SetCreationDate (Aws::Utils::DateTime &&value)
 
KeyMetadataWithCreationDate (const Aws::Utils::DateTime &value)
 
KeyMetadataWithCreationDate (Aws::Utils::DateTime &&value)
 
bool GetEnabled () const
 
bool EnabledHasBeenSet () const
 
void SetEnabled (bool value)
 
KeyMetadataWithEnabled (bool value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
KeyMetadataWithDescription (const Aws::String &value)
 
KeyMetadataWithDescription (Aws::String &&value)
 
KeyMetadataWithDescription (const char *value)
 
const KeyUsageTypeGetKeyUsage () const
 
bool KeyUsageHasBeenSet () const
 
void SetKeyUsage (const KeyUsageType &value)
 
void SetKeyUsage (KeyUsageType &&value)
 
KeyMetadataWithKeyUsage (const KeyUsageType &value)
 
KeyMetadataWithKeyUsage (KeyUsageType &&value)
 
const KeyStateGetKeyState () const
 
bool KeyStateHasBeenSet () const
 
void SetKeyState (const KeyState &value)
 
void SetKeyState (KeyState &&value)
 
KeyMetadataWithKeyState (const KeyState &value)
 
KeyMetadataWithKeyState (KeyState &&value)
 
const Aws::Utils::DateTimeGetDeletionDate () const
 
bool DeletionDateHasBeenSet () const
 
void SetDeletionDate (const Aws::Utils::DateTime &value)
 
void SetDeletionDate (Aws::Utils::DateTime &&value)
 
KeyMetadataWithDeletionDate (const Aws::Utils::DateTime &value)
 
KeyMetadataWithDeletionDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetValidTo () const
 
bool ValidToHasBeenSet () const
 
void SetValidTo (const Aws::Utils::DateTime &value)
 
void SetValidTo (Aws::Utils::DateTime &&value)
 
KeyMetadataWithValidTo (const Aws::Utils::DateTime &value)
 
KeyMetadataWithValidTo (Aws::Utils::DateTime &&value)
 
const OriginTypeGetOrigin () const
 
bool OriginHasBeenSet () const
 
void SetOrigin (const OriginType &value)
 
void SetOrigin (OriginType &&value)
 
KeyMetadataWithOrigin (const OriginType &value)
 
KeyMetadataWithOrigin (OriginType &&value)
 
const Aws::StringGetCustomKeyStoreId () const
 
bool CustomKeyStoreIdHasBeenSet () const
 
void SetCustomKeyStoreId (const Aws::String &value)
 
void SetCustomKeyStoreId (Aws::String &&value)
 
void SetCustomKeyStoreId (const char *value)
 
KeyMetadataWithCustomKeyStoreId (const Aws::String &value)
 
KeyMetadataWithCustomKeyStoreId (Aws::String &&value)
 
KeyMetadataWithCustomKeyStoreId (const char *value)
 
const Aws::StringGetCloudHsmClusterId () const
 
bool CloudHsmClusterIdHasBeenSet () const
 
void SetCloudHsmClusterId (const Aws::String &value)
 
void SetCloudHsmClusterId (Aws::String &&value)
 
void SetCloudHsmClusterId (const char *value)
 
KeyMetadataWithCloudHsmClusterId (const Aws::String &value)
 
KeyMetadataWithCloudHsmClusterId (Aws::String &&value)
 
KeyMetadataWithCloudHsmClusterId (const char *value)
 
const ExpirationModelTypeGetExpirationModel () const
 
bool ExpirationModelHasBeenSet () const
 
void SetExpirationModel (const ExpirationModelType &value)
 
void SetExpirationModel (ExpirationModelType &&value)
 
KeyMetadataWithExpirationModel (const ExpirationModelType &value)
 
KeyMetadataWithExpirationModel (ExpirationModelType &&value)
 
const KeyManagerTypeGetKeyManager () const
 
bool KeyManagerHasBeenSet () const
 
void SetKeyManager (const KeyManagerType &value)
 
void SetKeyManager (KeyManagerType &&value)
 
KeyMetadataWithKeyManager (const KeyManagerType &value)
 
KeyMetadataWithKeyManager (KeyManagerType &&value)
 
const CustomerMasterKeySpecGetCustomerMasterKeySpec () const
 
bool CustomerMasterKeySpecHasBeenSet () const
 
void SetCustomerMasterKeySpec (const CustomerMasterKeySpec &value)
 
void SetCustomerMasterKeySpec (CustomerMasterKeySpec &&value)
 
KeyMetadataWithCustomerMasterKeySpec (const CustomerMasterKeySpec &value)
 
KeyMetadataWithCustomerMasterKeySpec (CustomerMasterKeySpec &&value)
 
const Aws::Vector< EncryptionAlgorithmSpec > & GetEncryptionAlgorithms () const
 
bool EncryptionAlgorithmsHasBeenSet () const
 
void SetEncryptionAlgorithms (const Aws::Vector< EncryptionAlgorithmSpec > &value)
 
void SetEncryptionAlgorithms (Aws::Vector< EncryptionAlgorithmSpec > &&value)
 
KeyMetadataWithEncryptionAlgorithms (const Aws::Vector< EncryptionAlgorithmSpec > &value)
 
KeyMetadataWithEncryptionAlgorithms (Aws::Vector< EncryptionAlgorithmSpec > &&value)
 
KeyMetadataAddEncryptionAlgorithms (const EncryptionAlgorithmSpec &value)
 
KeyMetadataAddEncryptionAlgorithms (EncryptionAlgorithmSpec &&value)
 
const Aws::Vector< SigningAlgorithmSpec > & GetSigningAlgorithms () const
 
bool SigningAlgorithmsHasBeenSet () const
 
void SetSigningAlgorithms (const Aws::Vector< SigningAlgorithmSpec > &value)
 
void SetSigningAlgorithms (Aws::Vector< SigningAlgorithmSpec > &&value)
 
KeyMetadataWithSigningAlgorithms (const Aws::Vector< SigningAlgorithmSpec > &value)
 
KeyMetadataWithSigningAlgorithms (Aws::Vector< SigningAlgorithmSpec > &&value)
 
KeyMetadataAddSigningAlgorithms (const SigningAlgorithmSpec &value)
 
KeyMetadataAddSigningAlgorithms (SigningAlgorithmSpec &&value)
 

Detailed Description

Contains metadata about a customer master key (CMK).

This data type is used as a response element for the CreateKey and DescribeKey operations.

See Also:

AWS API Reference

Definition at line 43 of file KeyMetadata.h.

Constructor & Destructor Documentation

◆ KeyMetadata() [1/2]

Aws::KMS::Model::KeyMetadata::KeyMetadata ( )

◆ KeyMetadata() [2/2]

Aws::KMS::Model::KeyMetadata::KeyMetadata ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddEncryptionAlgorithms() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::AddEncryptionAlgorithms ( const EncryptionAlgorithmSpec value)
inline

The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Definition at line 863 of file KeyMetadata.h.

◆ AddEncryptionAlgorithms() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::AddEncryptionAlgorithms ( EncryptionAlgorithmSpec &&  value)
inline

The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Definition at line 870 of file KeyMetadata.h.

◆ AddSigningAlgorithms() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::AddSigningAlgorithms ( const SigningAlgorithmSpec value)
inline

The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Definition at line 920 of file KeyMetadata.h.

◆ AddSigningAlgorithms() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::AddSigningAlgorithms ( SigningAlgorithmSpec &&  value)
inline

The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Definition at line 927 of file KeyMetadata.h.

◆ ArnHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::ArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

Definition at line 148 of file KeyMetadata.h.

◆ AWSAccountIdHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::AWSAccountIdHasBeenSet ( ) const
inline

The twelve-digit account ID of the AWS account that owns the CMK.

Definition at line 60 of file KeyMetadata.h.

◆ CloudHsmClusterIdHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::CloudHsmClusterIdHasBeenSet ( ) const
inline

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

Definition at line 630 of file KeyMetadata.h.

◆ CreationDateHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::CreationDateHasBeenSet ( ) const
inline

The date and time when the CMK was created.

Definition at line 207 of file KeyMetadata.h.

◆ CustomerMasterKeySpecHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::CustomerMasterKeySpecHasBeenSet ( ) const
inline

Describes the type of key material in the CMK.

Definition at line 793 of file KeyMetadata.h.

◆ CustomKeyStoreIdHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::CustomKeyStoreIdHasBeenSet ( ) const
inline

A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

Definition at line 561 of file KeyMetadata.h.

◆ DeletionDateHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::DeletionDateHasBeenSet ( ) const
inline

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.

Definition at line 404 of file KeyMetadata.h.

◆ DescriptionHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::DescriptionHasBeenSet ( ) const
inline

The description of the CMK.

Definition at line 263 of file KeyMetadata.h.

◆ EnabledHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::EnabledHasBeenSet ( ) const
inline

Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.

Definition at line 240 of file KeyMetadata.h.

◆ EncryptionAlgorithmsHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::EncryptionAlgorithmsHasBeenSet ( ) const
inline

The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Definition at line 828 of file KeyMetadata.h.

◆ ExpirationModelHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::ExpirationModelHasBeenSet ( ) const
inline

Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

Definition at line 705 of file KeyMetadata.h.

◆ GetArn()

const Aws::String& Aws::KMS::Model::KeyMetadata::GetArn ( ) const
inline

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

Definition at line 140 of file KeyMetadata.h.

◆ GetAWSAccountId()

const Aws::String& Aws::KMS::Model::KeyMetadata::GetAWSAccountId ( ) const
inline

The twelve-digit account ID of the AWS account that owns the CMK.

Definition at line 55 of file KeyMetadata.h.

◆ GetCloudHsmClusterId()

const Aws::String& Aws::KMS::Model::KeyMetadata::GetCloudHsmClusterId ( ) const
inline

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

Definition at line 620 of file KeyMetadata.h.

◆ GetCreationDate()

const Aws::Utils::DateTime& Aws::KMS::Model::KeyMetadata::GetCreationDate ( ) const
inline

The date and time when the CMK was created.

Definition at line 202 of file KeyMetadata.h.

◆ GetCustomerMasterKeySpec()

const CustomerMasterKeySpec& Aws::KMS::Model::KeyMetadata::GetCustomerMasterKeySpec ( ) const
inline

Describes the type of key material in the CMK.

Definition at line 788 of file KeyMetadata.h.

◆ GetCustomKeyStoreId()

const Aws::String& Aws::KMS::Model::KeyMetadata::GetCustomKeyStoreId ( ) const
inline

A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

Definition at line 553 of file KeyMetadata.h.

◆ GetDeletionDate()

const Aws::Utils::DateTime& Aws::KMS::Model::KeyMetadata::GetDeletionDate ( ) const
inline

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.

Definition at line 398 of file KeyMetadata.h.

◆ GetDescription()

const Aws::String& Aws::KMS::Model::KeyMetadata::GetDescription ( ) const
inline

The description of the CMK.

Definition at line 258 of file KeyMetadata.h.

◆ GetEnabled()

bool Aws::KMS::Model::KeyMetadata::GetEnabled ( ) const
inline

Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.

Definition at line 234 of file KeyMetadata.h.

◆ GetEncryptionAlgorithms()

const Aws::Vector<EncryptionAlgorithmSpec>& Aws::KMS::Model::KeyMetadata::GetEncryptionAlgorithms ( ) const
inline

The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Definition at line 821 of file KeyMetadata.h.

◆ GetExpirationModel()

const ExpirationModelType& Aws::KMS::Model::KeyMetadata::GetExpirationModel ( ) const
inline

Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

Definition at line 698 of file KeyMetadata.h.

◆ GetKeyId()

const Aws::String& Aws::KMS::Model::KeyMetadata::GetKeyId ( ) const
inline

The globally unique identifier for the CMK.

Definition at line 96 of file KeyMetadata.h.

◆ GetKeyManager()

const KeyManagerType& Aws::KMS::Model::KeyMetadata::GetKeyManager ( ) const
inline

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

Definition at line 742 of file KeyMetadata.h.

◆ GetKeyState()

const KeyState& Aws::KMS::Model::KeyMetadata::GetKeyState ( ) const
inline

The current status of the CMK.

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

Definition at line 346 of file KeyMetadata.h.

◆ GetKeyUsage()

const KeyUsageType& Aws::KMS::Model::KeyMetadata::GetKeyUsage ( ) const
inline

The cryptographic operations for which you can use the CMK.

Definition at line 301 of file KeyMetadata.h.

◆ GetOrigin()

const OriginType& Aws::KMS::Model::KeyMetadata::GetOrigin ( ) const
inline

The source of the CMK's key material. When this value is AWS_KMS, AWS 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 AWS CloudHSM cluster associated with a custom key store.

Definition at line 494 of file KeyMetadata.h.

◆ GetSigningAlgorithms()

const Aws::Vector<SigningAlgorithmSpec>& Aws::KMS::Model::KeyMetadata::GetSigningAlgorithms ( ) const
inline

The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Definition at line 878 of file KeyMetadata.h.

◆ GetValidTo()

const Aws::Utils::DateTime& Aws::KMS::Model::KeyMetadata::GetValidTo ( ) const
inline

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

Definition at line 438 of file KeyMetadata.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::KMS::Model::KeyMetadata::Jsonize ( ) const

◆ KeyIdHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::KeyIdHasBeenSet ( ) const
inline

The globally unique identifier for the CMK.

Definition at line 101 of file KeyMetadata.h.

◆ KeyManagerHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::KeyManagerHasBeenSet ( ) const
inline

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

Definition at line 750 of file KeyMetadata.h.

◆ KeyStateHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::KeyStateHasBeenSet ( ) const
inline

The current status of the CMK.

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

Definition at line 355 of file KeyMetadata.h.

◆ KeyUsageHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::KeyUsageHasBeenSet ( ) const
inline

The cryptographic operations for which you can use the CMK.

Definition at line 308 of file KeyMetadata.h.

◆ operator=()

KeyMetadata& Aws::KMS::Model::KeyMetadata::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OriginHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::OriginHasBeenSet ( ) const
inline

The source of the CMK's key material. When this value is AWS_KMS, AWS 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 AWS CloudHSM cluster associated with a custom key store.

Definition at line 504 of file KeyMetadata.h.

◆ SetArn() [1/3]

void Aws::KMS::Model::KeyMetadata::SetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

Definition at line 156 of file KeyMetadata.h.

◆ SetArn() [2/3]

void Aws::KMS::Model::KeyMetadata::SetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

Definition at line 164 of file KeyMetadata.h.

◆ SetArn() [3/3]

void Aws::KMS::Model::KeyMetadata::SetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

Definition at line 172 of file KeyMetadata.h.

◆ SetAWSAccountId() [1/3]

void Aws::KMS::Model::KeyMetadata::SetAWSAccountId ( const Aws::String value)
inline

The twelve-digit account ID of the AWS account that owns the CMK.

Definition at line 65 of file KeyMetadata.h.

◆ SetAWSAccountId() [2/3]

void Aws::KMS::Model::KeyMetadata::SetAWSAccountId ( Aws::String &&  value)
inline

The twelve-digit account ID of the AWS account that owns the CMK.

Definition at line 70 of file KeyMetadata.h.

◆ SetAWSAccountId() [3/3]

void Aws::KMS::Model::KeyMetadata::SetAWSAccountId ( const char *  value)
inline

The twelve-digit account ID of the AWS account that owns the CMK.

Definition at line 75 of file KeyMetadata.h.

◆ SetCloudHsmClusterId() [1/3]

void Aws::KMS::Model::KeyMetadata::SetCloudHsmClusterId ( const Aws::String value)
inline

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

Definition at line 640 of file KeyMetadata.h.

◆ SetCloudHsmClusterId() [2/3]

void Aws::KMS::Model::KeyMetadata::SetCloudHsmClusterId ( Aws::String &&  value)
inline

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

Definition at line 650 of file KeyMetadata.h.

◆ SetCloudHsmClusterId() [3/3]

void Aws::KMS::Model::KeyMetadata::SetCloudHsmClusterId ( const char *  value)
inline

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

Definition at line 660 of file KeyMetadata.h.

◆ SetCreationDate() [1/2]

void Aws::KMS::Model::KeyMetadata::SetCreationDate ( const Aws::Utils::DateTime value)
inline

The date and time when the CMK was created.

Definition at line 212 of file KeyMetadata.h.

◆ SetCreationDate() [2/2]

void Aws::KMS::Model::KeyMetadata::SetCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date and time when the CMK was created.

Definition at line 217 of file KeyMetadata.h.

◆ SetCustomerMasterKeySpec() [1/2]

void Aws::KMS::Model::KeyMetadata::SetCustomerMasterKeySpec ( const CustomerMasterKeySpec value)
inline

Describes the type of key material in the CMK.

Definition at line 798 of file KeyMetadata.h.

◆ SetCustomerMasterKeySpec() [2/2]

void Aws::KMS::Model::KeyMetadata::SetCustomerMasterKeySpec ( CustomerMasterKeySpec &&  value)
inline

Describes the type of key material in the CMK.

Definition at line 803 of file KeyMetadata.h.

◆ SetCustomKeyStoreId() [1/3]

void Aws::KMS::Model::KeyMetadata::SetCustomKeyStoreId ( const Aws::String value)
inline

A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

Definition at line 569 of file KeyMetadata.h.

◆ SetCustomKeyStoreId() [2/3]

void Aws::KMS::Model::KeyMetadata::SetCustomKeyStoreId ( Aws::String &&  value)
inline

A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

Definition at line 577 of file KeyMetadata.h.

◆ SetCustomKeyStoreId() [3/3]

void Aws::KMS::Model::KeyMetadata::SetCustomKeyStoreId ( const char *  value)
inline

A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

Definition at line 585 of file KeyMetadata.h.

◆ SetDeletionDate() [1/2]

void Aws::KMS::Model::KeyMetadata::SetDeletionDate ( const Aws::Utils::DateTime value)
inline

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.

Definition at line 410 of file KeyMetadata.h.

◆ SetDeletionDate() [2/2]

void Aws::KMS::Model::KeyMetadata::SetDeletionDate ( Aws::Utils::DateTime &&  value)
inline

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.

Definition at line 416 of file KeyMetadata.h.

◆ SetDescription() [1/3]

void Aws::KMS::Model::KeyMetadata::SetDescription ( const Aws::String value)
inline

The description of the CMK.

Definition at line 268 of file KeyMetadata.h.

◆ SetDescription() [2/3]

void Aws::KMS::Model::KeyMetadata::SetDescription ( Aws::String &&  value)
inline

The description of the CMK.

Definition at line 273 of file KeyMetadata.h.

◆ SetDescription() [3/3]

void Aws::KMS::Model::KeyMetadata::SetDescription ( const char *  value)
inline

The description of the CMK.

Definition at line 278 of file KeyMetadata.h.

◆ SetEnabled()

void Aws::KMS::Model::KeyMetadata::SetEnabled ( bool  value)
inline

Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.

Definition at line 246 of file KeyMetadata.h.

◆ SetEncryptionAlgorithms() [1/2]

void Aws::KMS::Model::KeyMetadata::SetEncryptionAlgorithms ( const Aws::Vector< EncryptionAlgorithmSpec > &  value)
inline

The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Definition at line 835 of file KeyMetadata.h.

◆ SetEncryptionAlgorithms() [2/2]

void Aws::KMS::Model::KeyMetadata::SetEncryptionAlgorithms ( Aws::Vector< EncryptionAlgorithmSpec > &&  value)
inline

The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Definition at line 842 of file KeyMetadata.h.

◆ SetExpirationModel() [1/2]

void Aws::KMS::Model::KeyMetadata::SetExpirationModel ( const ExpirationModelType value)
inline

Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

Definition at line 712 of file KeyMetadata.h.

◆ SetExpirationModel() [2/2]

void Aws::KMS::Model::KeyMetadata::SetExpirationModel ( ExpirationModelType &&  value)
inline

Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

Definition at line 719 of file KeyMetadata.h.

◆ SetKeyId() [1/3]

void Aws::KMS::Model::KeyMetadata::SetKeyId ( const Aws::String value)
inline

The globally unique identifier for the CMK.

Definition at line 106 of file KeyMetadata.h.

◆ SetKeyId() [2/3]

void Aws::KMS::Model::KeyMetadata::SetKeyId ( Aws::String &&  value)
inline

The globally unique identifier for the CMK.

Definition at line 111 of file KeyMetadata.h.

◆ SetKeyId() [3/3]

void Aws::KMS::Model::KeyMetadata::SetKeyId ( const char *  value)
inline

The globally unique identifier for the CMK.

Definition at line 116 of file KeyMetadata.h.

◆ SetKeyManager() [1/2]

void Aws::KMS::Model::KeyMetadata::SetKeyManager ( const KeyManagerType value)
inline

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

Definition at line 758 of file KeyMetadata.h.

◆ SetKeyManager() [2/2]

void Aws::KMS::Model::KeyMetadata::SetKeyManager ( KeyManagerType &&  value)
inline

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

Definition at line 766 of file KeyMetadata.h.

◆ SetKeyState() [1/2]

void Aws::KMS::Model::KeyMetadata::SetKeyState ( const KeyState value)
inline

The current status of the CMK.

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

Definition at line 364 of file KeyMetadata.h.

◆ SetKeyState() [2/2]

void Aws::KMS::Model::KeyMetadata::SetKeyState ( KeyState &&  value)
inline

The current status of the CMK.

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

Definition at line 373 of file KeyMetadata.h.

◆ SetKeyUsage() [1/2]

void Aws::KMS::Model::KeyMetadata::SetKeyUsage ( const KeyUsageType value)
inline

The cryptographic operations for which you can use the CMK.

Definition at line 315 of file KeyMetadata.h.

◆ SetKeyUsage() [2/2]

void Aws::KMS::Model::KeyMetadata::SetKeyUsage ( KeyUsageType &&  value)
inline

The cryptographic operations for which you can use the CMK.

Definition at line 322 of file KeyMetadata.h.

◆ SetOrigin() [1/2]

void Aws::KMS::Model::KeyMetadata::SetOrigin ( const OriginType value)
inline

The source of the CMK's key material. When this value is AWS_KMS, AWS 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 AWS CloudHSM cluster associated with a custom key store.

Definition at line 514 of file KeyMetadata.h.

◆ SetOrigin() [2/2]

void Aws::KMS::Model::KeyMetadata::SetOrigin ( OriginType &&  value)
inline

The source of the CMK's key material. When this value is AWS_KMS, AWS 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 AWS CloudHSM cluster associated with a custom key store.

Definition at line 524 of file KeyMetadata.h.

◆ SetSigningAlgorithms() [1/2]

void Aws::KMS::Model::KeyMetadata::SetSigningAlgorithms ( const Aws::Vector< SigningAlgorithmSpec > &  value)
inline

The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Definition at line 892 of file KeyMetadata.h.

◆ SetSigningAlgorithms() [2/2]

void Aws::KMS::Model::KeyMetadata::SetSigningAlgorithms ( Aws::Vector< SigningAlgorithmSpec > &&  value)
inline

The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Definition at line 899 of file KeyMetadata.h.

◆ SetValidTo() [1/2]

void Aws::KMS::Model::KeyMetadata::SetValidTo ( const Aws::Utils::DateTime value)
inline

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

Definition at line 456 of file KeyMetadata.h.

◆ SetValidTo() [2/2]

void Aws::KMS::Model::KeyMetadata::SetValidTo ( Aws::Utils::DateTime &&  value)
inline

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

Definition at line 465 of file KeyMetadata.h.

◆ SigningAlgorithmsHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::SigningAlgorithmsHasBeenSet ( ) const
inline

The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Definition at line 885 of file KeyMetadata.h.

◆ ValidToHasBeenSet()

bool Aws::KMS::Model::KeyMetadata::ValidToHasBeenSet ( ) const
inline

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

Definition at line 447 of file KeyMetadata.h.

◆ WithArn() [1/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

Definition at line 180 of file KeyMetadata.h.

◆ WithArn() [2/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

Definition at line 188 of file KeyMetadata.h.

◆ WithArn() [3/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

Definition at line 196 of file KeyMetadata.h.

◆ WithAWSAccountId() [1/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithAWSAccountId ( const Aws::String value)
inline

The twelve-digit account ID of the AWS account that owns the CMK.

Definition at line 80 of file KeyMetadata.h.

◆ WithAWSAccountId() [2/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithAWSAccountId ( Aws::String &&  value)
inline

The twelve-digit account ID of the AWS account that owns the CMK.

Definition at line 85 of file KeyMetadata.h.

◆ WithAWSAccountId() [3/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithAWSAccountId ( const char *  value)
inline

The twelve-digit account ID of the AWS account that owns the CMK.

Definition at line 90 of file KeyMetadata.h.

◆ WithCloudHsmClusterId() [1/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithCloudHsmClusterId ( const Aws::String value)
inline

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

Definition at line 670 of file KeyMetadata.h.

◆ WithCloudHsmClusterId() [2/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithCloudHsmClusterId ( Aws::String &&  value)
inline

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

Definition at line 680 of file KeyMetadata.h.

◆ WithCloudHsmClusterId() [3/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithCloudHsmClusterId ( const char *  value)
inline

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

Definition at line 690 of file KeyMetadata.h.

◆ WithCreationDate() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithCreationDate ( const Aws::Utils::DateTime value)
inline

The date and time when the CMK was created.

Definition at line 222 of file KeyMetadata.h.

◆ WithCreationDate() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date and time when the CMK was created.

Definition at line 227 of file KeyMetadata.h.

◆ WithCustomerMasterKeySpec() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithCustomerMasterKeySpec ( const CustomerMasterKeySpec value)
inline

Describes the type of key material in the CMK.

Definition at line 808 of file KeyMetadata.h.

◆ WithCustomerMasterKeySpec() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithCustomerMasterKeySpec ( CustomerMasterKeySpec &&  value)
inline

Describes the type of key material in the CMK.

Definition at line 813 of file KeyMetadata.h.

◆ WithCustomKeyStoreId() [1/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithCustomKeyStoreId ( const Aws::String value)
inline

A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

Definition at line 593 of file KeyMetadata.h.

◆ WithCustomKeyStoreId() [2/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithCustomKeyStoreId ( Aws::String &&  value)
inline

A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

Definition at line 601 of file KeyMetadata.h.

◆ WithCustomKeyStoreId() [3/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithCustomKeyStoreId ( const char *  value)
inline

A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

Definition at line 609 of file KeyMetadata.h.

◆ WithDeletionDate() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithDeletionDate ( const Aws::Utils::DateTime value)
inline

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.

Definition at line 422 of file KeyMetadata.h.

◆ WithDeletionDate() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithDeletionDate ( Aws::Utils::DateTime &&  value)
inline

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.

Definition at line 428 of file KeyMetadata.h.

◆ WithDescription() [1/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithDescription ( const Aws::String value)
inline

The description of the CMK.

Definition at line 283 of file KeyMetadata.h.

◆ WithDescription() [2/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithDescription ( Aws::String &&  value)
inline

The description of the CMK.

Definition at line 288 of file KeyMetadata.h.

◆ WithDescription() [3/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithDescription ( const char *  value)
inline

The description of the CMK.

Definition at line 293 of file KeyMetadata.h.

◆ WithEnabled()

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithEnabled ( bool  value)
inline

Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.

Definition at line 252 of file KeyMetadata.h.

◆ WithEncryptionAlgorithms() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithEncryptionAlgorithms ( const Aws::Vector< EncryptionAlgorithmSpec > &  value)
inline

The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Definition at line 849 of file KeyMetadata.h.

◆ WithEncryptionAlgorithms() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithEncryptionAlgorithms ( Aws::Vector< EncryptionAlgorithmSpec > &&  value)
inline

The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

Definition at line 856 of file KeyMetadata.h.

◆ WithExpirationModel() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithExpirationModel ( const ExpirationModelType value)
inline

Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

Definition at line 726 of file KeyMetadata.h.

◆ WithExpirationModel() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithExpirationModel ( ExpirationModelType &&  value)
inline

Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

Definition at line 733 of file KeyMetadata.h.

◆ WithKeyId() [1/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithKeyId ( const Aws::String value)
inline

The globally unique identifier for the CMK.

Definition at line 121 of file KeyMetadata.h.

◆ WithKeyId() [2/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithKeyId ( Aws::String &&  value)
inline

The globally unique identifier for the CMK.

Definition at line 126 of file KeyMetadata.h.

◆ WithKeyId() [3/3]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithKeyId ( const char *  value)
inline

The globally unique identifier for the CMK.

Definition at line 131 of file KeyMetadata.h.

◆ WithKeyManager() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithKeyManager ( const KeyManagerType value)
inline

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

Definition at line 774 of file KeyMetadata.h.

◆ WithKeyManager() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithKeyManager ( KeyManagerType &&  value)
inline

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

Definition at line 782 of file KeyMetadata.h.

◆ WithKeyState() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithKeyState ( const KeyState value)
inline

The current status of the CMK.

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

Definition at line 382 of file KeyMetadata.h.

◆ WithKeyState() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithKeyState ( KeyState &&  value)
inline

The current status of the CMK.

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

Definition at line 391 of file KeyMetadata.h.

◆ WithKeyUsage() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithKeyUsage ( const KeyUsageType value)
inline

The cryptographic operations for which you can use the CMK.

Definition at line 329 of file KeyMetadata.h.

◆ WithKeyUsage() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithKeyUsage ( KeyUsageType &&  value)
inline

The cryptographic operations for which you can use the CMK.

Definition at line 336 of file KeyMetadata.h.

◆ WithOrigin() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithOrigin ( const OriginType value)
inline

The source of the CMK's key material. When this value is AWS_KMS, AWS 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 AWS CloudHSM cluster associated with a custom key store.

Definition at line 534 of file KeyMetadata.h.

◆ WithOrigin() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithOrigin ( OriginType &&  value)
inline

The source of the CMK's key material. When this value is AWS_KMS, AWS 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 AWS CloudHSM cluster associated with a custom key store.

Definition at line 544 of file KeyMetadata.h.

◆ WithSigningAlgorithms() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithSigningAlgorithms ( const Aws::Vector< SigningAlgorithmSpec > &  value)
inline

The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Definition at line 906 of file KeyMetadata.h.

◆ WithSigningAlgorithms() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithSigningAlgorithms ( Aws::Vector< SigningAlgorithmSpec > &&  value)
inline

The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

Definition at line 913 of file KeyMetadata.h.

◆ WithValidTo() [1/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithValidTo ( const Aws::Utils::DateTime value)
inline

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

Definition at line 474 of file KeyMetadata.h.

◆ WithValidTo() [2/2]

KeyMetadata& Aws::KMS::Model::KeyMetadata::WithValidTo ( Aws::Utils::DateTime &&  value)
inline

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

Definition at line 483 of file KeyMetadata.h.


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