CreateKeyDetails

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

Bases: object

The details of the key that you want to create.

Attributes:

PROTECTION_MODE_EXTERNAL

A constant which can be used with the protection_mode property of a CreateKeyDetails.

PROTECTION_MODE_HSM

A constant which can be used with the protection_mode property of a CreateKeyDetails.

PROTECTION_MODE_SOFTWARE

A constant which can be used with the protection_mode property of a CreateKeyDetails.

auto_key_rotation_details

Gets the auto_key_rotation_details of this CreateKeyDetails.

compartment_id

[Required] Gets the compartment_id of this CreateKeyDetails.

defined_tags

Gets the defined_tags of this CreateKeyDetails.

display_name

[Required] Gets the display_name of this CreateKeyDetails.

external_key_reference

Gets the external_key_reference of this CreateKeyDetails.

freeform_tags

Gets the freeform_tags of this CreateKeyDetails.

is_auto_rotation_enabled

Gets the is_auto_rotation_enabled of this CreateKeyDetails.

key_shape

[Required] Gets the key_shape of this CreateKeyDetails.

protection_mode

Gets the protection_mode of this CreateKeyDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateKeyDetails object with values from keyword arguments.

PROTECTION_MODE_EXTERNAL = 'EXTERNAL'

A constant which can be used with the protection_mode property of a CreateKeyDetails. This constant has a value of “EXTERNAL”

PROTECTION_MODE_HSM = 'HSM'

A constant which can be used with the protection_mode property of a CreateKeyDetails. This constant has a value of “HSM”

PROTECTION_MODE_SOFTWARE = 'SOFTWARE'

A constant which can be used with the protection_mode property of a CreateKeyDetails. This constant has a value of “SOFTWARE”

__init__(**kwargs)

Initializes a new CreateKeyDetails 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 CreateKeyDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateKeyDetails.

  • display_name (str) – The value to assign to the display_name property of this CreateKeyDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateKeyDetails.

  • key_shape (oci.key_management.models.KeyShape) – The value to assign to the key_shape property of this CreateKeyDetails.

  • is_auto_rotation_enabled (bool) – The value to assign to the is_auto_rotation_enabled property of this CreateKeyDetails.

  • auto_key_rotation_details (oci.key_management.models.AutoKeyRotationDetails) – The value to assign to the auto_key_rotation_details property of this CreateKeyDetails.

  • protection_mode (str) – The value to assign to the protection_mode property of this CreateKeyDetails. Allowed values for this property are: “HSM”, “SOFTWARE”, “EXTERNAL”

  • external_key_reference (oci.key_management.models.ExternalKeyReference) – The value to assign to the external_key_reference property of this CreateKeyDetails.

property auto_key_rotation_details

Gets the auto_key_rotation_details of this CreateKeyDetails.

Returns

The auto_key_rotation_details of this CreateKeyDetails.

Return type

oci.key_management.models.AutoKeyRotationDetails

property compartment_id

[Required] Gets the compartment_id of this CreateKeyDetails. The OCID of the compartment where you want to create the master encryption key.

Returns

The compartment_id of this CreateKeyDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateKeyDetails. 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 CreateKeyDetails.

Return type

dict(str, dict(str, object))

property display_name

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

Returns

The display_name of this CreateKeyDetails.

Return type

str

property external_key_reference

Gets the external_key_reference of this CreateKeyDetails.

Returns

The external_key_reference of this CreateKeyDetails.

Return type

oci.key_management.models.ExternalKeyReference

property freeform_tags

Gets the freeform_tags of this CreateKeyDetails. 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 CreateKeyDetails.

Return type

dict(str, str)

property is_auto_rotation_enabled

Gets the is_auto_rotation_enabled of this CreateKeyDetails. A parameter specifying whether the auto key rotation is enabled or not.

Returns

The is_auto_rotation_enabled of this CreateKeyDetails.

Return type

bool

property key_shape

[Required] Gets the key_shape of this CreateKeyDetails.

Returns

The key_shape of this CreateKeyDetails.

Return type

oci.key_management.models.KeyShape

property protection_mode

Gets the protection_mode of this CreateKeyDetails. The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault’s RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default, a key’s protection mode is set to HSM. You can’t change a key’s protection mode after the key is created or imported. A protection mode of EXTERNAL mean that the key persists on the customer’s external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.

Allowed values for this property are: “HSM”, “SOFTWARE”, “EXTERNAL”

Returns

The protection_mode of this CreateKeyDetails.

Return type

str