Vault

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

Bases: object

Vault model.

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_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_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_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", '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", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
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. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "foo-value"}}

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
freeform_tags

Gets the freeform_tags of this Vault. Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

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
lifecycle_state

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

Example: DELETED

Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "PENDING_DELETION", "SCHEDULING_DELETION", "CANCELLING_DELETION", "UPDATING", '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
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 for the deletion time of 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", '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