VaultSummary¶

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

Bases: object

The details of the Vault.

Attributes

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

Methods

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

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

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

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

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

VAULT_TYPE_EXTERNAL = 'EXTERNAL'¶: A constant which can be used with the vault_type property of a VaultSummary. 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 VaultSummary. This constant has a value of “VIRTUAL_PRIVATE”

__init__(**kwargs)¶

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

compartment_id¶

[Required] Gets the compartment_id of this VaultSummary. The OCID of the compartment that contains a particular vault.

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

crypto_endpoint¶

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

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

defined_tags¶

Gets the defined_tags of this VaultSummary. 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 VaultSummary.
Return type:	dict(str, dict(str, object))

display_name¶

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

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

external_key_manager_metadata_summary¶

Gets the external_key_manager_metadata_summary of this VaultSummary.

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

freeform_tags¶

Gets the freeform_tags of this VaultSummary. 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 VaultSummary.
Return type:	dict(str, str)

id¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this VaultSummary. A vault’s current lifecycle state.

Example: ACTIVE

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

management_endpoint¶

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

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

time_created¶

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

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

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

vault_type¶

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

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

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