KeyMetadata

public struct KeyMetadata : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • 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

    Swift

    public let arn: String?

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

    Declaration

    Swift

    public let aWSAccountId: String?

  • 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

    Swift

    public let cloudHsmClusterId: String?

  • The date and time when the CMK was created.

    Declaration

    Swift

    public let creationDate: TimeStamp?

  • Describes the type of key material in the CMK.

    Declaration

    Swift

    public let customerMasterKeySpec: CustomerMasterKeySpec?

  • 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

    Swift

    public let customKeyStoreId: String?

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

    Declaration

    Swift

    public let deletionDate: TimeStamp?

  • The description of the CMK.

    Declaration

    Swift

    public let description: String?

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

    Declaration

    Swift

    public let enabled: Bool?

  • 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.

    Declaration

    Swift

    public let encryptionAlgorithms: [EncryptionAlgorithmSpec]?

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

    Declaration

    Swift

    public let expirationModel: ExpirationModelType?

  • The globally unique identifier for the CMK.

    Declaration

    Swift

    public let keyId: String

  • 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

    Swift

    public let keyManager: KeyManagerType?

  • 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

    Swift

    public let keyState: KeyState?

  • The cryptographic operations for which you can use the CMK.

    Declaration

    Swift

    public let keyUsage: KeyUsageType?

  • 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

    Swift

    public let origin: OriginType?

  • 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

    Swift

    public let signingAlgorithms: [SigningAlgorithmSpec]?

  • 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

    Swift

    public let validTo: TimeStamp?

  • Undocumented

    Declaration

    Swift

    public init(arn: String? = nil, aWSAccountId: String? = nil, cloudHsmClusterId: String? = nil, creationDate: TimeStamp? = nil, customerMasterKeySpec: CustomerMasterKeySpec? = nil, customKeyStoreId: String? = nil, deletionDate: TimeStamp? = nil, description: String? = nil, enabled: Bool? = nil, encryptionAlgorithms: [EncryptionAlgorithmSpec]? = nil, expirationModel: ExpirationModelType? = nil, keyId: String, keyManager: KeyManagerType? = nil, keyState: KeyState? = nil, keyUsage: KeyUsageType? = nil, origin: OriginType? = nil, signingAlgorithms: [SigningAlgorithmSpec]? = nil, validTo: TimeStamp? = nil)