ImportKeyDetails¶
- class oci.key_management.models.ImportKeyDetails(**kwargs)¶
Bases:
objectThe details of the Key that you wish to import.
Attributes:
A constant which can be used with the protection_mode property of a ImportKeyDetails.
A constant which can be used with the protection_mode property of a ImportKeyDetails.
Gets the auto_key_rotation_details of this ImportKeyDetails.
[Required] Gets the compartment_id of this ImportKeyDetails.
Gets the defined_tags of this ImportKeyDetails.
[Required] Gets the display_name of this ImportKeyDetails.
Gets the freeform_tags of this ImportKeyDetails.
Gets the is_auto_rotation_enabled of this ImportKeyDetails.
[Required] Gets the key_shape of this ImportKeyDetails.
Gets the protection_mode of this ImportKeyDetails.
[Required] Gets the wrapped_import_key of this ImportKeyDetails.
Methods:
__init__(**kwargs)Initializes a new ImportKeyDetails object with values from keyword arguments.
- PROTECTION_MODE_HSM = 'HSM'¶
A constant which can be used with the protection_mode property of a ImportKeyDetails. This constant has a value of “HSM”
- PROTECTION_MODE_SOFTWARE = 'SOFTWARE'¶
A constant which can be used with the protection_mode property of a ImportKeyDetails. This constant has a value of “SOFTWARE”
- __init__(**kwargs)¶
Initializes a new ImportKeyDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
is_auto_rotation_enabled (bool) – The value to assign to the is_auto_rotation_enabled property of this ImportKeyDetails.
auto_key_rotation_details (oci.key_management.models.AutoKeyRotationDetails) – The value to assign to the auto_key_rotation_details property of this ImportKeyDetails.
compartment_id (str) – The value to assign to the compartment_id property of this ImportKeyDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ImportKeyDetails.
display_name (str) – The value to assign to the display_name property of this ImportKeyDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ImportKeyDetails.
key_shape (oci.key_management.models.KeyShape) – The value to assign to the key_shape property of this ImportKeyDetails.
wrapped_import_key (oci.key_management.models.WrappedImportKey) – The value to assign to the wrapped_import_key property of this ImportKeyDetails.
protection_mode (str) – The value to assign to the protection_mode property of this ImportKeyDetails. Allowed values for this property are: “HSM”, “SOFTWARE”
- property auto_key_rotation_details¶
Gets the auto_key_rotation_details of this ImportKeyDetails.
- Returns
The auto_key_rotation_details of this ImportKeyDetails.
- Return type
- property compartment_id¶
[Required] Gets the compartment_id of this ImportKeyDetails. The OCID of the compartment that contains this key.
- Returns
The compartment_id of this ImportKeyDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this ImportKeyDetails. 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 ImportKeyDetails.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this ImportKeyDetails. 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 ImportKeyDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this ImportKeyDetails. 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 ImportKeyDetails.
- Return type
dict(str, str)
- property is_auto_rotation_enabled¶
Gets the is_auto_rotation_enabled of this ImportKeyDetails. A parameter specifying whether the auto key rotation is enabled or not.
- Returns
The is_auto_rotation_enabled of this ImportKeyDetails.
- Return type
bool
- property key_shape¶
[Required] Gets the key_shape of this ImportKeyDetails.
- Returns
The key_shape of this ImportKeyDetails.
- Return type
- property protection_mode¶
Gets the protection_mode of this ImportKeyDetails. 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.
Allowed values for this property are: “HSM”, “SOFTWARE”
- Returns
The protection_mode of this ImportKeyDetails.
- Return type
str
- property wrapped_import_key¶
[Required] Gets the wrapped_import_key of this ImportKeyDetails.
- Returns
The wrapped_import_key of this ImportKeyDetails.
- Return type