AWSKMSKeyMetadata

Objective-C

@interface AWSKMSKeyMetadata

Swift

class AWSKMSKeyMetadata

Contains metadata about a customer master key (CMK).

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

Required parameters: [KeyId]

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable AWSAccountId;

    Swift

    var awsAccountId: String? { get set }
  • arn

    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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable arn;

    Swift

    var arn: String? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable cloudHsmClusterId;

    Swift

    var cloudHsmClusterId: String? { get set }
  • The date and time when the CMK was created.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable creationDate;

    Swift

    var creationDate: Date? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable customKeyStoreId;

    Swift

    var customKeyStoreId: String? { get set }
  • Describes the type of key material in the CMK.

    Declaration

    Objective-C

    @property (nonatomic) AWSKMSCustomerMasterKeySpec customerMasterKeySpec;

    Swift

    var customerMasterKeySpec: AWSKMSCustomerMasterKeySpec { get set }
  • The date and time after which AWS KMS deletes this CMK. This value is present only when the CMK is scheduled for deletion, that is, when its KeyState is PendingDeletion.

    When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable deletionDate;

    Swift

    var deletionDate: Date? { get set }
  • The description of the CMK.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable detail;

    Swift

    var detail: String? { get set }
  • Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable enabled;

    Swift

    var enabled: NSNumber? { get set }
  • The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

    This value is present only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable encryptionAlgorithms;

    Swift

    var encryptionAlgorithms: [String]? { get set }
  • Specifies whether the CMK’s key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

    Declaration

    Objective-C

    @property (nonatomic) AWSKMSExpirationModelType expirationModel;

    Swift

    var expirationModel: AWSKMSExpirationModelType { get set }
  • The globally unique identifier for the CMK.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable keyId;

    Swift

    var keyId: String? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSKMSKeyManagerType keyManager;

    Swift

    var keyManager: AWSKMSKeyManagerType { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSKMSKeyState keyState;

    Swift

    var keyState: AWSKMSKeyState { get set }
  • The cryptographic operations for which you can use the CMK.

    Declaration

    Objective-C

    @property (nonatomic) AWSKMSKeyUsageType keyUsage;

    Swift

    var keyUsage: AWSKMSKeyUsageType { get set }
  • Indicates whether the CMK is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica CMKs and False for regional CMKs.

    For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable multiRegion;

    Swift

    var multiRegion: NSNumber? { get set }
  • Lists the primary and replica CMKs in same multi-Region CMK. This field is present only when the value of the MultiRegion field is True.

    For more information about any listed CMK, use the DescribeKey operation.

    • MultiRegionKeyType indicates whether the CMK is a PRIMARY or REPLICA key.

    • PrimaryKey displays the key ARN and Region of the primary key. This field displays the current CMK if it is the primary key.

    • ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current CMK if it is a replica key.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSKMSMultiRegionConfiguration *_Nullable multiRegionConfiguration;

    Swift

    var multiRegionConfiguration: AWSKMSMultiRegionConfiguration? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSKMSOriginType origin;

    Swift

    var origin: AWSKMSOriginType { get set }
  • The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the CMK is PendingReplicaDeletion. That indicates that the CMK is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

    When a regional CMK or a replica key in a multi-Region key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn’t begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable pendingDeletionWindowInDays;

    Swift

    var pendingDeletionWindowInDays: NSNumber? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable signingAlgorithms;

    Swift

    var signingAlgorithms: [String]? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable validTo;

    Swift

    var validTo: Date? { get set }