CreateSecretDetails¶

class oci.vault.models.CreateSecretDetails(**kwargs)¶

Bases: object

The details of the secret that you want to create.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this CreateSecretDetails.
`defined_tags`	Gets the defined_tags of this CreateSecretDetails.
`description`	Gets the description of this CreateSecretDetails.
`enable_auto_generation`	Gets the enable_auto_generation of this CreateSecretDetails.
`freeform_tags`	Gets the freeform_tags of this CreateSecretDetails.
`key_id`	[Required] Gets the key_id of this CreateSecretDetails.
`metadata`	Gets the metadata of this CreateSecretDetails.
`rotation_config`	Gets the rotation_config of this CreateSecretDetails.
`secret_content`	Gets the secret_content of this CreateSecretDetails.
`secret_generation_context`	Gets the secret_generation_context of this CreateSecretDetails.
`secret_name`	[Required] Gets the secret_name of this CreateSecretDetails.
`secret_rules`	Gets the secret_rules of this CreateSecretDetails.
`vault_id`	[Required] Gets the vault_id of this CreateSecretDetails.

__init__(**kwargs)¶

Initializes a new CreateSecretDetails 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 CreateSecretDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateSecretDetails.
description (str) – The value to assign to the description property of this CreateSecretDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateSecretDetails.
key_id (str) – The value to assign to the key_id property of this CreateSecretDetails.
metadata (dict(str, object)) – The value to assign to the metadata property of this CreateSecretDetails.
secret_content (oci.vault.models.SecretContentDetails) – The value to assign to the secret_content property of this CreateSecretDetails.
rotation_config (oci.vault.models.RotationConfig) – The value to assign to the rotation_config property of this CreateSecretDetails.
secret_name (str) – The value to assign to the secret_name property of this CreateSecretDetails.
secret_rules (list[oci.vault.models.SecretRule]) – The value to assign to the secret_rules property of this CreateSecretDetails.
vault_id (str) – The value to assign to the vault_id property of this CreateSecretDetails.
secret_generation_context (oci.vault.models.SecretGenerationContext) – The value to assign to the secret_generation_context property of this CreateSecretDetails.
enable_auto_generation (bool) – The value to assign to the enable_auto_generation property of this CreateSecretDetails.

compartment_id¶

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

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

defined_tags¶

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

description¶

Gets the description of this CreateSecretDetails. A brief description of the secret. Avoid entering confidential information.

Returns:	The description of this CreateSecretDetails.
Return type:	str

enable_auto_generation¶

Gets the enable_auto_generation of this CreateSecretDetails. The value of this flag determines whether or not secret content will be generated automatically. If not set, it defaults to false.

Returns:	The enable_auto_generation of this CreateSecretDetails.
Return type:	bool

freeform_tags¶

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

key_id¶

[Required] Gets the key_id of this CreateSecretDetails. The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify.

Returns:	The key_id of this CreateSecretDetails.
Return type:	str

metadata¶

Gets the metadata of this CreateSecretDetails. Additional metadata that you can use to provide context about how to use the secret during rotation or other administrative tasks. For example, for a secret that you use to connect to a database, the additional metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.

Returns:	The metadata of this CreateSecretDetails.
Return type:	dict(str, object)

rotation_config¶

Gets the rotation_config of this CreateSecretDetails.

Returns:	The rotation_config of this CreateSecretDetails.
Return type:	oci.vault.models.RotationConfig

secret_content¶

Gets the secret_content of this CreateSecretDetails.

Returns:	The secret_content of this CreateSecretDetails.
Return type:	oci.vault.models.SecretContentDetails

secret_generation_context¶

Gets the secret_generation_context of this CreateSecretDetails.

Returns:	The secret_generation_context of this CreateSecretDetails.
Return type:	oci.vault.models.SecretGenerationContext

secret_name¶

[Required] Gets the secret_name of this CreateSecretDetails. A user-friendly name for the secret. Secret names should be unique within a vault. Avoid entering confidential information. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.

Returns:	The secret_name of this CreateSecretDetails.
Return type:	str

secret_rules¶

Gets the secret_rules of this CreateSecretDetails. A list of rules to control how the secret is used and managed.

Returns:	The secret_rules of this CreateSecretDetails.
Return type:	list[oci.vault.models.SecretRule]

vault_id¶

[Required] Gets the vault_id of this CreateSecretDetails. The OCID of the vault where you want to create the secret.

Returns:	The vault_id of this CreateSecretDetails.
Return type:	str