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 *AWSAccountId

Declared 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 *arn

Declared 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 *cloudHsmClusterId

Declared In

AWSKMSModel.h

  creationDate

The date and time when the CMK was created.

@property (nonatomic, strong) NSDate *creationDate

Declared 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 *customKeyStoreId

Declared 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 *deletionDate

Declared In

AWSKMSModel.h

  detail

The description of the CMK.

@property (nonatomic, strong) NSString *detail

Declared 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 *enabled

Declared 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 expirationModel

Declared In

AWSKMSModel.h

  keyId

The globally unique identifier for the CMK.

@property (nonatomic, strong) NSString *keyId

Declared In

AWSKMSModel.h

  keyManager

The CMK's manager. CMKs 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 keyManager

Declared 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 keyState

Declared In

AWSKMSModel.h

  keyUsage

The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.

@property (nonatomic, assign) AWSKMSKeyUsageType keyUsage

Declared 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 origin

Declared 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 *validTo

Declared In

AWSKMSModel.h