KeyState Property

The CMK's state.

Object Oriented Interface

public function getKeyState($keyindex);

Procedural Interface

cloudkeys_amazonkms_get($res, 44 , $keyindex);

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 and not available at design time.

Data Type

Integer