Vault¶

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

Bases: object

The logical entity where the Vault service creates and durably stores keys.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Vault.
`LIFECYCLE_STATE_BACKUP_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a Vault.
`LIFECYCLE_STATE_CANCELLING_DELETION`	A constant which can be used with the lifecycle_state property of a Vault.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Vault.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Vault.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Vault.
`LIFECYCLE_STATE_PENDING_DELETION`	A constant which can be used with the lifecycle_state property of a Vault.
`LIFECYCLE_STATE_RESTORING`	A constant which can be used with the lifecycle_state property of a Vault.
`LIFECYCLE_STATE_SCHEDULING_DELETION`	A constant which can be used with the lifecycle_state property of a Vault.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Vault.
`VAULT_TYPE_DEFAULT`	A constant which can be used with the vault_type property of a Vault.
`VAULT_TYPE_EXTERNAL`	A constant which can be used with the vault_type property of a Vault.
`VAULT_TYPE_VIRTUAL_PRIVATE`	A constant which can be used with the vault_type property of a Vault.
`compartment_id`	[Required] Gets the compartment_id of this Vault.
`crypto_endpoint`	[Required] Gets the crypto_endpoint of this Vault.
`defined_tags`	Gets the defined_tags of this Vault.
`display_name`	[Required] Gets the display_name of this Vault.
`external_key_manager_metadata_summary`	Gets the external_key_manager_metadata_summary of this Vault.
`freeform_tags`	Gets the freeform_tags of this Vault.
`id`	[Required] Gets the id of this Vault.
`is_primary`	Gets the is_primary of this Vault.
`is_vault_replicable`	Gets the is_vault_replicable of this Vault.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Vault.
`management_endpoint`	[Required] Gets the management_endpoint of this Vault.
`replica_details`	Gets the replica_details of this Vault.
`restored_from_vault_id`	Gets the restored_from_vault_id of this Vault.
`time_created`	[Required] Gets the time_created of this Vault.
`time_of_deletion`	Gets the time_of_deletion of this Vault.
`vault_type`	[Required] Gets the vault_type of this Vault.
`wrappingkey_id`	[Required] Gets the wrappingkey_id of this Vault.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Vault. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_BACKUP_IN_PROGRESS = 'BACKUP_IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a Vault. 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 Vault. 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 Vault. This constant has a value of “CREATING”

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

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

LIFECYCLE_STATE_PENDING_DELETION = 'PENDING_DELETION'¶: A constant which can be used with the lifecycle_state property of a Vault. 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 Vault. 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 Vault. 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 Vault. This constant has a value of “UPDATING”

VAULT_TYPE_DEFAULT = 'DEFAULT'¶: A constant which can be used with the vault_type property of a Vault. This constant has a value of “DEFAULT”

VAULT_TYPE_EXTERNAL = 'EXTERNAL'¶: A constant which can be used with the vault_type property of a Vault. This constant has a value of “EXTERNAL”

VAULT_TYPE_VIRTUAL_PRIVATE = 'VIRTUAL_PRIVATE'¶: A constant which can be used with the vault_type property of a Vault. This constant has a value of “VIRTUAL_PRIVATE”

__init__(**kwargs)¶

Initializes a new Vault 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 Vault.
crypto_endpoint (str) – The value to assign to the crypto_endpoint property of this Vault.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Vault.
display_name (str) – The value to assign to the display_name property of this Vault.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Vault.
id (str) – The value to assign to the id property of this Vault.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Vault. Allowed values for this property are: “CREATING”, “ACTIVE”, “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’.
management_endpoint (str) – The value to assign to the management_endpoint property of this Vault.
time_created (datetime) – The value to assign to the time_created property of this Vault.
time_of_deletion (datetime) – The value to assign to the time_of_deletion property of this Vault.
vault_type (str) – The value to assign to the vault_type property of this Vault. Allowed values for this property are: “VIRTUAL_PRIVATE”, “DEFAULT”, “EXTERNAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
restored_from_vault_id (str) – The value to assign to the restored_from_vault_id property of this Vault.
wrappingkey_id (str) – The value to assign to the wrappingkey_id property of this Vault.
replica_details (oci.key_management.models.VaultReplicaDetails) – The value to assign to the replica_details property of this Vault.
is_primary (bool) – The value to assign to the is_primary property of this Vault.
is_vault_replicable (bool) – The value to assign to the is_vault_replicable property of this Vault.
external_key_manager_metadata_summary (oci.key_management.models.ExternalKeyManagerMetadataSummary) – The value to assign to the external_key_manager_metadata_summary property of this Vault.

compartment_id¶

[Required] Gets the compartment_id of this Vault. The OCID of the compartment that contains this vault.

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

crypto_endpoint¶

[Required] Gets the crypto_endpoint of this Vault. The service endpoint to perform cryptographic operations against. Cryptographic operations include Encrypt, Decrypt, and GenerateDataEncryptionKey operations.

Returns:	The crypto_endpoint of this Vault.
Return type:	str

defined_tags¶

Gets the defined_tags of this Vault. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this Vault.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this Vault. A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Returns:	The display_name of this Vault.
Return type:	str

external_key_manager_metadata_summary¶

Gets the external_key_manager_metadata_summary of this Vault.

Returns:	The external_key_manager_metadata_summary of this Vault.
Return type:	oci.key_management.models.ExternalKeyManagerMetadataSummary

freeform_tags¶

Gets the freeform_tags of this Vault. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this Vault.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Vault. The OCID of the vault.

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

is_primary¶

Gets the is_primary of this Vault. A Boolean value that indicates whether the Vault is primary Vault or replica Vault.

Returns:	The is_primary of this Vault.
Return type:	bool

is_vault_replicable¶

Gets the is_vault_replicable of this Vault. A Boolean value that indicates whether the Vault has cross region replication capability. Always true for Virtual Private Vaults.

Returns:	The is_vault_replicable of this Vault.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this Vault. The vault’s current lifecycle state.

Example: DELETED

Allowed values for this property are: “CREATING”, “ACTIVE”, “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 Vault.
Return type:	str

management_endpoint¶

[Required] Gets the management_endpoint of this Vault. The service endpoint to perform management operations against. Management operations include “Create,” “Update,” “List,” “Get,” and “Delete” operations.

Returns:	The management_endpoint of this Vault.
Return type:	str

replica_details¶

Gets the replica_details of this Vault.

Returns:	The replica_details of this Vault.
Return type:	oci.key_management.models.VaultReplicaDetails

restored_from_vault_id¶

Gets the restored_from_vault_id of this Vault. The OCID of the vault from which this vault was restored, if it was restored from a backup file. If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault.

Returns:	The restored_from_vault_id of this Vault.
Return type:	str

time_created¶

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

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

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

time_of_deletion¶

Gets the time_of_deletion of this Vault. An optional property to indicate when to delete the vault, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

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

vault_type¶

[Required] Gets the vault_type of this Vault. The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing.

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

Returns:	The vault_type of this Vault.
Return type:	str

wrappingkey_id¶

[Required] Gets the wrappingkey_id of this Vault. The OCID of the vault’s wrapping key.

Returns:	The wrappingkey_id of this Vault.
Return type:	str