KmsKey¶

class oci.nosql.models.KmsKey(**kwargs)¶

Bases: object

Information about the state of the service’s encryption key management. The following properties are read-only and ignored when this object is used in UpdateConfiguration: kmsKeyState, timeCreated, timeUpdated.

Attributes

`KMS_KEY_STATE_ACTIVE`	A constant which can be used with the kms_key_state property of a KmsKey.
`KMS_KEY_STATE_DELETED`	A constant which can be used with the kms_key_state property of a KmsKey.
`KMS_KEY_STATE_DISABLED`	A constant which can be used with the kms_key_state property of a KmsKey.
`KMS_KEY_STATE_FAILED`	A constant which can be used with the kms_key_state property of a KmsKey.
`KMS_KEY_STATE_REVERTING`	A constant which can be used with the kms_key_state property of a KmsKey.
`KMS_KEY_STATE_UPDATING`	A constant which can be used with the kms_key_state property of a KmsKey.
`id`	Gets the id of this KmsKey.
`kms_key_state`	Gets the kms_key_state of this KmsKey.
`kms_vault_id`	Gets the kms_vault_id of this KmsKey.
`time_created`	Gets the time_created of this KmsKey.
`time_updated`	Gets the time_updated of this KmsKey.

Methods

__init__(**kwargs) Initializes a new KmsKey object with values from keyword arguments.

KMS_KEY_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the kms_key_state property of a KmsKey. This constant has a value of “ACTIVE”

KMS_KEY_STATE_DELETED = 'DELETED'¶: A constant which can be used with the kms_key_state property of a KmsKey. This constant has a value of “DELETED”

KMS_KEY_STATE_DISABLED = 'DISABLED'¶: A constant which can be used with the kms_key_state property of a KmsKey. This constant has a value of “DISABLED”

KMS_KEY_STATE_FAILED = 'FAILED'¶: A constant which can be used with the kms_key_state property of a KmsKey. This constant has a value of “FAILED”

KMS_KEY_STATE_REVERTING = 'REVERTING'¶: A constant which can be used with the kms_key_state property of a KmsKey. This constant has a value of “REVERTING”

KMS_KEY_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the kms_key_state property of a KmsKey. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new KmsKey object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this KmsKey.
kms_vault_id (str) – The value to assign to the kms_vault_id property of this KmsKey.
kms_key_state (str) – The value to assign to the kms_key_state property of this KmsKey. Allowed values for this property are: “UPDATING”, “ACTIVE”, “DELETED”, “FAILED”, “REVERTING”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this KmsKey.
time_updated (datetime) – The value to assign to the time_updated property of this KmsKey.

id¶

Gets the id of this KmsKey. The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key, then the id will be a null string..

Returns:	The id of this KmsKey.
Return type:	str

kms_key_state¶

Gets the kms_key_state of this KmsKey. The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state.

Allowed values for this property are: “UPDATING”, “ACTIVE”, “DELETED”, “FAILED”, “REVERTING”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The kms_key_state of this KmsKey.
Return type:	str

kms_vault_id¶

Gets the kms_vault_id of this KmsKey. The OCID of the vault containing the encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key, then the kmsVaultId will be a null string.

Returns:	The kms_vault_id of this KmsKey.
Return type:	str

time_created¶

Gets the time_created of this KmsKey. The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted.

Returns:	The time_created of this KmsKey.
Return type:	datetime

time_updated¶

Gets the time_updated of this KmsKey. The timestamp of the last update to the encryption key status. RFC3339 formatted.

Returns:	The time_updated of this KmsKey.
Return type:	datetime