/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace KMS { namespace Model { /** *

Contains metadata about a KMS key.

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

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

*/ inline const Aws::Utils::DateTime& GetValidTo() const{ return m_validTo; } /** *

*/ inline bool ValidToHasBeenSet() const { return m_validToHasBeenSet; } /** *

*/ inline void SetValidTo(const Aws::Utils::DateTime& value) { m_validToHasBeenSet = true; m_validTo = value; } /** *

*/ inline void SetValidTo(Aws::Utils::DateTime&& value) { m_validToHasBeenSet = true; m_validTo = std::move(value); } /** *

*/ inline KeyMetadata& WithValidTo(const Aws::Utils::DateTime& value) { SetValidTo(value); return *this;} /** *

*/ inline KeyMetadata& WithValidTo(Aws::Utils::DateTime&& value) { SetValidTo(std::move(value)); return *this;} /** *

The source of the key material for the KMS key. When this value is * AWS_KMS, KMS created the key material. When this value is * EXTERNAL, the key material was imported or the KMS key doesn't have * any key material. When this value is AWS_CLOUDHSM, the key material * was created in the CloudHSM cluster associated with a custom key store.

*/ inline const OriginType& GetOrigin() const{ return m_origin; } /** *

*/ inline bool OriginHasBeenSet() const { return m_originHasBeenSet; } /** *

*/ inline void SetOrigin(const OriginType& value) { m_originHasBeenSet = true; m_origin = value; } /** *

*/ inline void SetOrigin(OriginType&& value) { m_originHasBeenSet = true; m_origin = std::move(value); } /** *

*/ inline KeyMetadata& WithOrigin(const OriginType& value) { SetOrigin(value); return *this;} /** *

*/ inline KeyMetadata& WithOrigin(OriginType&& value) { SetOrigin(std::move(value)); return *this;} /** *

A unique identifier for the custom * key store that contains the KMS key. This field is present only when the KMS * key is created in a custom key store.

*/ inline const Aws::String& GetCustomKeyStoreId() const{ return m_customKeyStoreId; } /** *

A unique identifier for the custom * key store that contains the KMS key. This field is present only when the KMS * key is created in a custom key store.

*/ inline bool CustomKeyStoreIdHasBeenSet() const { return m_customKeyStoreIdHasBeenSet; } /** *

A unique identifier for the custom * key store that contains the KMS key. This field is present only when the KMS * key is created in a custom key store.

*/ inline void SetCustomKeyStoreId(const Aws::String& value) { m_customKeyStoreIdHasBeenSet = true; m_customKeyStoreId = value; } /** *

A unique identifier for the custom * key store that contains the KMS key. This field is present only when the KMS * key is created in a custom key store.

*/ inline void SetCustomKeyStoreId(Aws::String&& value) { m_customKeyStoreIdHasBeenSet = true; m_customKeyStoreId = std::move(value); } /** *

A unique identifier for the custom * key store that contains the KMS key. This field is present only when the KMS * key is created in a custom key store.

*/ inline void SetCustomKeyStoreId(const char* value) { m_customKeyStoreIdHasBeenSet = true; m_customKeyStoreId.assign(value); } /** *

A unique identifier for the custom * key store that contains the KMS key. This field is present only when the KMS * key is created in a custom key store.

*/ inline KeyMetadata& WithCustomKeyStoreId(const Aws::String& value) { SetCustomKeyStoreId(value); return *this;} /** *

A unique identifier for the custom * key store that contains the KMS key. This field is present only when the KMS * key is created in a custom key store.

*/ inline KeyMetadata& WithCustomKeyStoreId(Aws::String&& value) { SetCustomKeyStoreId(std::move(value)); return *this;} /** *

A unique identifier for the custom * key store that contains the KMS key. This field is present only when the KMS * key is created in a custom key store.

*/ inline KeyMetadata& WithCustomKeyStoreId(const char* value) { SetCustomKeyStoreId(value); return *this;} /** *

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

*/ inline const Aws::String& GetCloudHsmClusterId() const{ return m_cloudHsmClusterId; } /** *

*/ inline bool CloudHsmClusterIdHasBeenSet() const { return m_cloudHsmClusterIdHasBeenSet; } /** *

*/ inline void SetCloudHsmClusterId(const Aws::String& value) { m_cloudHsmClusterIdHasBeenSet = true; m_cloudHsmClusterId = value; } /** *

*/ inline void SetCloudHsmClusterId(Aws::String&& value) { m_cloudHsmClusterIdHasBeenSet = true; m_cloudHsmClusterId = std::move(value); } /** *

*/ inline void SetCloudHsmClusterId(const char* value) { m_cloudHsmClusterIdHasBeenSet = true; m_cloudHsmClusterId.assign(value); } /** *

*/ inline KeyMetadata& WithCloudHsmClusterId(const Aws::String& value) { SetCloudHsmClusterId(value); return *this;} /** *

*/ inline KeyMetadata& WithCloudHsmClusterId(Aws::String&& value) { SetCloudHsmClusterId(std::move(value)); return *this;} /** *

*/ inline KeyMetadata& WithCloudHsmClusterId(const char* value) { SetCloudHsmClusterId(value); return *this;} /** *

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

*/ inline const ExpirationModelType& GetExpirationModel() const{ return m_expirationModel; } /** *

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

*/ inline bool ExpirationModelHasBeenSet() const { return m_expirationModelHasBeenSet; } /** *

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

*/ inline void SetExpirationModel(const ExpirationModelType& value) { m_expirationModelHasBeenSet = true; m_expirationModel = value; } /** *

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

*/ inline void SetExpirationModel(ExpirationModelType&& value) { m_expirationModelHasBeenSet = true; m_expirationModel = std::move(value); } /** *

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

*/ inline KeyMetadata& WithExpirationModel(const ExpirationModelType& value) { SetExpirationModel(value); return *this;} /** *

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

*/ inline KeyMetadata& WithExpirationModel(ExpirationModelType&& value) { SetExpirationModel(std::move(value)); return *this;} /** *

The manager of the KMS key. KMS keys in your Amazon Web Services account are * either customer managed or Amazon Web Services managed. For more information * about the difference, see KMS * keys in the Key Management Service Developer Guide.

*/ inline const KeyManagerType& GetKeyManager() const{ return m_keyManager; } /** *

*/ inline bool KeyManagerHasBeenSet() const { return m_keyManagerHasBeenSet; } /** *

*/ inline void SetKeyManager(const KeyManagerType& value) { m_keyManagerHasBeenSet = true; m_keyManager = value; } /** *

*/ inline void SetKeyManager(KeyManagerType&& value) { m_keyManagerHasBeenSet = true; m_keyManager = std::move(value); } /** *

*/ inline KeyMetadata& WithKeyManager(const KeyManagerType& value) { SetKeyManager(value); return *this;} /** *

*/ inline KeyMetadata& WithKeyManager(KeyManagerType&& value) { SetKeyManager(std::move(value)); return *this;} /** *

Describes the type of key material in the KMS key.

*/ inline const KeySpec& GetKeySpec() const{ return m_keySpec; } /** *

Describes the type of key material in the KMS key.

*/ inline bool KeySpecHasBeenSet() const { return m_keySpecHasBeenSet; } /** *

Describes the type of key material in the KMS key.

*/ inline void SetKeySpec(const KeySpec& value) { m_keySpecHasBeenSet = true; m_keySpec = value; } /** *

Describes the type of key material in the KMS key.

*/ inline void SetKeySpec(KeySpec&& value) { m_keySpecHasBeenSet = true; m_keySpec = std::move(value); } /** *

Describes the type of key material in the KMS key.

*/ inline KeyMetadata& WithKeySpec(const KeySpec& value) { SetKeySpec(value); return *this;} /** *

Describes the type of key material in the KMS key.

*/ inline KeyMetadata& WithKeySpec(KeySpec&& value) { SetKeySpec(std::move(value)); return *this;} /** *

The encryption algorithms that the KMS key supports. You cannot use the KMS * key with other encryption algorithms within KMS.