keyState (property)

The CMK's state.

Syntax

- (int)keyState:(int)keyIndex;

/* Possible Values */
AKS_ENABLED(0),
AKS_DISABLED(1),
AKS_PENDING_DELETION(2),
AKS_PENDING_IMPORT(3),
AKS_UNAVAILABLE(4)
public func keyState(keyIndex: Int32) throws -> AmazonkmsKeyStates
public enum AmazonkmsKeyStates : Int32 { case aksEnabled = 0 case aksDisabled = 1 case aksPendingDeletion = 2 case aksPendingImport = 3 case aksUnavailable = 4 }

Default Value

0

Remarks

The CMK's state.

This property reflects the CMK's state. Possible values are:

  • aksEnabled (0): The CMK is enabled and ready for use. (Also the default value used when ListKeys is called.)
  • aksDisabled (1): The CMK is disabled and cannot be used until it is enabled again.
  • aksPendingDeletion (2): The CMK is pending deletion and cannot be used unless the deletion is canceled.
  • aksPendingImport (3): The CMK has been created, but external key material has not yet been imported into it, so it cannot be used.
  • aksUnavailable (4): The CMK is currently unavailable because the CloudHSM cluster that contains its key material has been disconnected from Amazon KMS.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 iOS Edition - Version 20.0 [Build 8157]