WrappingKey¶
- class oci.key_management.models.WrappingKey(**kwargs)¶
Bases:
objectThe public RSA wrapping key associated with the vault
Attributes:
A constant which can be used with the lifecycle_state property of a WrappingKey.
A constant which can be used with the lifecycle_state property of a WrappingKey.
A constant which can be used with the lifecycle_state property of a WrappingKey.
A constant which can be used with the lifecycle_state property of a WrappingKey.
A constant which can be used with the lifecycle_state property of a WrappingKey.
A constant which can be used with the lifecycle_state property of a WrappingKey.
A constant which can be used with the lifecycle_state property of a WrappingKey.
A constant which can be used with the lifecycle_state property of a WrappingKey.
A constant which can be used with the lifecycle_state property of a WrappingKey.
A constant which can be used with the lifecycle_state property of a WrappingKey.
A constant which can be used with the lifecycle_state property of a WrappingKey.
A constant which can be used with the lifecycle_state property of a WrappingKey.
A constant which can be used with the lifecycle_state property of a WrappingKey.
[Required] Gets the compartment_id of this WrappingKey.
[Required] Gets the id of this WrappingKey.
[Required] Gets the lifecycle_state of this WrappingKey.
[Required] Gets the public_key of this WrappingKey.
[Required] Gets the time_created of this WrappingKey.
[Required] Gets the vault_id of this WrappingKey.
Methods:
__init__(**kwargs)Initializes a new WrappingKey object with values from keyword arguments.
- LIFECYCLE_STATE_BACKUP_IN_PROGRESS = 'BACKUP_IN_PROGRESS'¶
A constant which can be used with the lifecycle_state property of a WrappingKey. This constant has a value of “BACKUP_IN_PROGRESS”
- LIFECYCLE_STATE_CANCELLING_DELETION = 'CANCELLING_DELETION'¶
A constant which can be used with the lifecycle_state property of a WrappingKey. 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 WrappingKey. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a WrappingKey. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a WrappingKey. This constant has a value of “DELETING”
- LIFECYCLE_STATE_DISABLED = 'DISABLED'¶
A constant which can be used with the lifecycle_state property of a WrappingKey. This constant has a value of “DISABLED”
- LIFECYCLE_STATE_DISABLING = 'DISABLING'¶
A constant which can be used with the lifecycle_state property of a WrappingKey. This constant has a value of “DISABLING”
- LIFECYCLE_STATE_ENABLED = 'ENABLED'¶
A constant which can be used with the lifecycle_state property of a WrappingKey. This constant has a value of “ENABLED”
- LIFECYCLE_STATE_ENABLING = 'ENABLING'¶
A constant which can be used with the lifecycle_state property of a WrappingKey. 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 WrappingKey. This constant has a value of “PENDING_DELETION”
- LIFECYCLE_STATE_RESTORING = 'RESTORING'¶
A constant which can be used with the lifecycle_state property of a WrappingKey. This constant has a value of “RESTORING”
- LIFECYCLE_STATE_SCHEDULING_DELETION = 'SCHEDULING_DELETION'¶
A constant which can be used with the lifecycle_state property of a WrappingKey. This constant has a value of “SCHEDULING_DELETION”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a WrappingKey. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new WrappingKey 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 WrappingKey.
id (str) – The value to assign to the id property of this WrappingKey.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this WrappingKey. Allowed values for this property are: “CREATING”, “ENABLING”, “ENABLED”, “DISABLING”, “DISABLED”, “DELETING”, “DELETED”, “PENDING_DELETION”, “SCHEDULING_DELETION”, “CANCELLING_DELETION”, “UPDATING”, “BACKUP_IN_PROGRESS”, “RESTORING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
public_key (str) – The value to assign to the public_key property of this WrappingKey.
time_created (datetime) – The value to assign to the time_created property of this WrappingKey.
vault_id (str) – The value to assign to the vault_id property of this WrappingKey.
- property compartment_id¶
[Required] Gets the compartment_id of this WrappingKey. The OCID of the compartment that contains this key.
- Returns
The compartment_id of this WrappingKey.
- Return type
str
- property id¶
[Required] Gets the id of this WrappingKey. The OCID of the key.
- Returns
The id of this WrappingKey.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this WrappingKey. The key’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”, “UPDATING”, “BACKUP_IN_PROGRESS”, “RESTORING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this WrappingKey.
- Return type
str
- property public_key¶
[Required] Gets the public_key of this WrappingKey. The public key, in PEM format, to use to wrap the key material before importing it.
- Returns
The public_key of this WrappingKey.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this WrappingKey. The date and time the key was created, expressed in RFC 3339 timestamp format.
Example: 2018-04-03T21:10:29.600Z
- Returns
The time_created of this WrappingKey.
- Return type
datetime
- property vault_id¶
[Required] Gets the vault_id of this WrappingKey. The OCID of the vault that contains this key.
- Returns
The vault_id of this WrappingKey.
- Return type
str