KeyVersionSummary¶

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

Bases: object

The details of the KeyVersion.

Attributes

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

Methods

__init__(**kwargs) Initializes a new KeyVersionSummary 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 KeyVersionSummary. 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 KeyVersionSummary. This constant has a value of “CREATING”

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

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

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

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

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

LIFECYCLE_STATE_ENABLING = 'ENABLING'¶: A constant which can be used with the lifecycle_state property of a KeyVersionSummary. 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 KeyVersionSummary. 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 KeyVersionSummary. This constant has a value of “SCHEDULING_DELETION”

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

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

__init__(**kwargs)¶

Initializes a new KeyVersionSummary 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 KeyVersionSummary.
id (str) – The value to assign to the id property of this KeyVersionSummary.
key_id (str) – The value to assign to the key_id property of this KeyVersionSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this KeyVersionSummary. 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 KeyVersionSummary. 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 KeyVersionSummary.
time_of_deletion (datetime) – The value to assign to the time_of_deletion property of this KeyVersionSummary.
vault_id (str) – The value to assign to the vault_id property of this KeyVersionSummary.
external_key_reference_details (oci.key_management.models.ExternalKeyReferenceDetails) – The value to assign to the external_key_reference_details property of this KeyVersionSummary.
is_auto_rotated (bool) – The value to assign to the is_auto_rotated property of this KeyVersionSummary.

compartment_id¶

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

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

external_key_reference_details¶

Gets the external_key_reference_details of this KeyVersionSummary.

Returns:	The external_key_reference_details of this KeyVersionSummary.
Return type:	oci.key_management.models.ExternalKeyReferenceDetails

id¶

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

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

is_auto_rotated¶

Gets the is_auto_rotated of this KeyVersionSummary. An optional property indicating whether this keyversion is generated from auto rotatation.

Returns:	The is_auto_rotated of this KeyVersionSummary.
Return type:	bool

key_id¶

[Required] Gets the key_id of this KeyVersionSummary. The OCID of the master encryption key associated with this key version.

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

lifecycle_state¶

Gets the lifecycle_state of this KeyVersionSummary. The key version’s current lifecycle 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 KeyVersionSummary.
Return type:	str

origin¶

[Required] Gets the origin of this KeyVersionSummary. The source of the key material. When this value is INTERNAL, Key Management created the key material. When this value is EXTERNAL, the key material was imported from an external source.

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 KeyVersionSummary.
Return type:	str

time_created¶

[Required] Gets the time_created of this KeyVersionSummary. 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 KeyVersionSummary.
Return type:	datetime

time_of_deletion¶

Gets the time_of_deletion of this KeyVersionSummary. An optional property to indicate 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 KeyVersionSummary.
Return type:	datetime

vault_id¶

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

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