AWSKMSKeyMetadata Class Reference
| Inherits from | AWSModel : AWSMTLModel |
|---|---|
| Declared in | AWSKMSModel.h AWSKMSModel.m |
Overview
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]
AWSAccountId
The twelve-digit account ID of the AWS account that owns the CMK.
@property (nonatomic, strong) NSString *AWSAccountIdDeclared In
AWSKMSModel.h
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.
@property (nonatomic, strong) NSString *arnDeclared In
AWSKMSModel.h
cloudHsmClusterId
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.
@property (nonatomic, strong) NSString *cloudHsmClusterIdDeclared In
AWSKMSModel.h
creationDate
The date and time when the CMK was created.
@property (nonatomic, strong) NSDate *creationDateDeclared In
AWSKMSModel.h
customKeyStoreId
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.
@property (nonatomic, strong) NSString *customKeyStoreIdDeclared In
AWSKMSModel.h
deletionDate
The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.
@property (nonatomic, strong) NSDate *deletionDateDeclared In
AWSKMSModel.h
detail
The description of the CMK.
@property (nonatomic, strong) NSString *detailDeclared In
AWSKMSModel.h
enabled
Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
@property (nonatomic, strong) NSNumber *enabledDeclared In
AWSKMSModel.h
expirationModel
Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
@property (nonatomic, assign) AWSKMSExpirationModelType expirationModelDeclared In
AWSKMSModel.h
keyId
The globally unique identifier for the CMK.
@property (nonatomic, strong) NSString *keyIdDeclared In
AWSKMSModel.h
keyManager
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.
@property (nonatomic, assign) AWSKMSKeyManagerType keyManagerDeclared In
AWSKMSModel.h
keyState
The state of the CMK.
For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
@property (nonatomic, assign) AWSKMSKeyState keyStateDeclared In
AWSKMSModel.h
keyUsage
The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.
@property (nonatomic, assign) AWSKMSKeyUsageType keyUsageDeclared In
AWSKMSModel.h
origin
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.
@property (nonatomic, assign) AWSKMSOriginType originDeclared In
AWSKMSModel.h
validTo
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.
@property (nonatomic, strong) NSDate *validToDeclared In
AWSKMSModel.h