KeyVersion¶

class oci.key_management.models.KeyVersion(**kwargs)¶

Bases: object

KeyVersion model.

Attributes

`LIFECYCLE_STATE_CANCELLING_DELETION`	A constant which can be used with the lifecycle_state property of a KeyVersion.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a KeyVersion.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a KeyVersion.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a KeyVersion.
`LIFECYCLE_STATE_DISABLED`	A constant which can be used with the lifecycle_state property of a KeyVersion.
`LIFECYCLE_STATE_DISABLING`	A constant which can be used with the lifecycle_state property of a KeyVersion.
`LIFECYCLE_STATE_ENABLED`	A constant which can be used with the lifecycle_state property of a KeyVersion.
`LIFECYCLE_STATE_ENABLING`	A constant which can be used with the lifecycle_state property of a KeyVersion.
`LIFECYCLE_STATE_PENDING_DELETION`	A constant which can be used with the lifecycle_state property of a KeyVersion.
`LIFECYCLE_STATE_SCHEDULING_DELETION`	A constant which can be used with the lifecycle_state property of a KeyVersion.
`ORIGIN_EXTERNAL`	A constant which can be used with the origin property of a KeyVersion.
`ORIGIN_INTERNAL`	A constant which can be used with the origin property of a KeyVersion.
`compartment_id`	[Required] Gets the compartment_id of this KeyVersion.
`id`	[Required] Gets the id of this KeyVersion.
`key_id`	[Required] Gets the key_id of this KeyVersion.
`lifecycle_state`	Gets the lifecycle_state of this KeyVersion.
`origin`	Gets the origin of this KeyVersion.
`time_created`	[Required] Gets the time_created of this KeyVersion.
`time_of_deletion`	Gets the time_of_deletion of this KeyVersion.
`vault_id`	[Required] Gets the vault_id of this KeyVersion.

Methods

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

LIFECYCLE_STATE_CANCELLING_DELETION = 'CANCELLING_DELETION'¶: A constant which can be used with the lifecycle_state property of a KeyVersion. This constant has a value of “CANCELLING_DELETION”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a KeyVersion. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a KeyVersion. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a KeyVersion. This constant has a value of “DELETING”

LIFECYCLE_STATE_DISABLED = 'DISABLED'¶: A constant which can be used with the lifecycle_state property of a KeyVersion. This constant has a value of “DISABLED”

LIFECYCLE_STATE_DISABLING = 'DISABLING'¶: A constant which can be used with the lifecycle_state property of a KeyVersion. This constant has a value of “DISABLING”

LIFECYCLE_STATE_ENABLED = 'ENABLED'¶: A constant which can be used with the lifecycle_state property of a KeyVersion. This constant has a value of “ENABLED”

LIFECYCLE_STATE_ENABLING = 'ENABLING'¶: A constant which can be used with the lifecycle_state property of a KeyVersion. This constant has a value of “ENABLING”

LIFECYCLE_STATE_PENDING_DELETION = 'PENDING_DELETION'¶: A constant which can be used with the lifecycle_state property of a KeyVersion. This constant has a value of “PENDING_DELETION”

LIFECYCLE_STATE_SCHEDULING_DELETION = 'SCHEDULING_DELETION'¶: A constant which can be used with the lifecycle_state property of a KeyVersion. This constant has a value of “SCHEDULING_DELETION”

ORIGIN_EXTERNAL = 'EXTERNAL'¶: A constant which can be used with the origin property of a KeyVersion. This constant has a value of “EXTERNAL”

ORIGIN_INTERNAL = 'INTERNAL'¶: A constant which can be used with the origin property of a KeyVersion. This constant has a value of “INTERNAL”

__init__(**kwargs)¶

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

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this KeyVersion.
id (str) – The value to assign to the id property of this KeyVersion.
key_id (str) – The value to assign to the key_id property of this KeyVersion.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this KeyVersion. Allowed values for this property are: “CREATING”, “ENABLING”, “ENABLED”, “DISABLING”, “DISABLED”, “DELETING”, “DELETED”, “PENDING_DELETION”, “SCHEDULING_DELETION”, “CANCELLING_DELETION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
origin (str) – The value to assign to the origin property of this KeyVersion. Allowed values for this property are: “INTERNAL”, “EXTERNAL”, ‘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 KeyVersion.
time_of_deletion (datetime) – The value to assign to the time_of_deletion property of this KeyVersion.
vault_id (str) – The value to assign to the vault_id property of this KeyVersion.

compartment_id¶

[Required] Gets the compartment_id of this KeyVersion. The OCID of the compartment that contains this key version.

Returns:	The compartment_id of this KeyVersion.
Return type:	str

id¶

[Required] Gets the id of this KeyVersion. The OCID of the key version.

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

key_id¶

[Required] Gets the key_id of this KeyVersion. The OCID of the key associated with this key version.

Returns:	The key_id of this KeyVersion.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this KeyVersion. The key version’s current state.

Example: ENABLED

Allowed values for this property are: “CREATING”, “ENABLING”, “ENABLED”, “DISABLING”, “DISABLED”, “DELETING”, “DELETED”, “PENDING_DELETION”, “SCHEDULING_DELETION”, “CANCELLING_DELETION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this KeyVersion.
Return type:	str

origin¶

Gets the origin of this KeyVersion. The source of the key material. When this value is INTERNAL, OCI KMS created the key material. When this value is EXTERNAL, the key material was imported

Allowed values for this property are: “INTERNAL”, “EXTERNAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The origin of this KeyVersion.
Return type:	str

time_created¶

[Required] Gets the time_created of this KeyVersion. The date and time this key version was created, expressed in RFC 3339 timestamp format.

Example: “2018-04-03T21:10:29.600Z”

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

time_of_deletion¶

Gets the time_of_deletion of this KeyVersion. An optional property indicating when to delete the key version, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns:	The time_of_deletion of this KeyVersion.
Return type:	datetime

vault_id¶

[Required] Gets the vault_id of this KeyVersion. The OCID of the vault that contains this key version.

Returns:	The vault_id of this KeyVersion.
Return type:	str