CreateVaultDetails¶

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

Bases: object

The details of the vault that you want to create.

Attributes

`VAULT_TYPE_DEFAULT`	A constant which can be used with the vault_type property of a CreateVaultDetails.
`VAULT_TYPE_EXTERNAL`	A constant which can be used with the vault_type property of a CreateVaultDetails.
`VAULT_TYPE_VIRTUAL_PRIVATE`	A constant which can be used with the vault_type property of a CreateVaultDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateVaultDetails.
`defined_tags`	Gets the defined_tags of this CreateVaultDetails.
`display_name`	[Required] Gets the display_name of this CreateVaultDetails.
`external_key_manager_metadata`	Gets the external_key_manager_metadata of this CreateVaultDetails.
`freeform_tags`	Gets the freeform_tags of this CreateVaultDetails.
`vault_type`	[Required] Gets the vault_type of this CreateVaultDetails.

Methods

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

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

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

__init__(**kwargs)¶

Initializes a new CreateVaultDetails 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 CreateVaultDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateVaultDetails.
display_name (str) – The value to assign to the display_name property of this CreateVaultDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateVaultDetails.
external_key_manager_metadata (oci.key_management.models.ExternalKeyManagerMetadata) – The value to assign to the external_key_manager_metadata property of this CreateVaultDetails.
vault_type (str) – The value to assign to the vault_type property of this CreateVaultDetails. Allowed values for this property are: “VIRTUAL_PRIVATE”, “DEFAULT”, “EXTERNAL”

compartment_id¶

[Required] Gets the compartment_id of this CreateVaultDetails. The OCID of the compartment where you want to create this vault.

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

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this CreateVaultDetails. 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 CreateVaultDetails.
Return type:	str

external_key_manager_metadata¶

Gets the external_key_manager_metadata of this CreateVaultDetails.

Returns:	The external_key_manager_metadata of this CreateVaultDetails.
Return type:	oci.key_management.models.ExternalKeyManagerMetadata

freeform_tags¶

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

vault_type¶

[Required] Gets the vault_type of this CreateVaultDetails. The type of vault to create. 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”

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