HsmCluster¶

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

Bases: object

Dedicated KMS-HSM Cluster Management

Attributes

`LIFECYCLE_STATE_ACTIVATING`	A constant which can be used with the lifecycle_state property of a HsmCluster.
`LIFECYCLE_STATE_ACTIVATION_REQUIRED`	A constant which can be used with the lifecycle_state property of a HsmCluster.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a HsmCluster.
`LIFECYCLE_STATE_CANCELLING_DELETION`	A constant which can be used with the lifecycle_state property of a HsmCluster.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a HsmCluster.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a HsmCluster.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a HsmCluster.
`LIFECYCLE_STATE_INITIALIZATION_REQUIRED`	A constant which can be used with the lifecycle_state property of a HsmCluster.
`LIFECYCLE_STATE_INITIALIZING`	A constant which can be used with the lifecycle_state property of a HsmCluster.
`LIFECYCLE_STATE_PENDING_DELETION`	A constant which can be used with the lifecycle_state property of a HsmCluster.
`LIFECYCLE_STATE_SCHEDULING_DELETION`	A constant which can be used with the lifecycle_state property of a HsmCluster.
`compartment_id`	[Required] Gets the compartment_id of this HsmCluster.
`defined_tags`	Gets the defined_tags of this HsmCluster.
`display_name`	[Required] Gets the display_name of this HsmCluster.
`dns_name`	[Required] Gets the dns_name of this HsmCluster.
`freeform_tags`	Gets the freeform_tags of this HsmCluster.
`id`	[Required] Gets the id of this HsmCluster.
`lifecycle_state`	[Required] Gets the lifecycle_state of this HsmCluster.
`time_created`	[Required] Gets the time_created of this HsmCluster.
`time_of_deletion`	Gets the time_of_deletion of this HsmCluster.
`time_updated`	[Required] Gets the time_updated of this HsmCluster.

Methods

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

LIFECYCLE_STATE_ACTIVATING = 'ACTIVATING'¶: A constant which can be used with the lifecycle_state property of a HsmCluster. This constant has a value of “ACTIVATING”

LIFECYCLE_STATE_ACTIVATION_REQUIRED = 'ACTIVATION_REQUIRED'¶: A constant which can be used with the lifecycle_state property of a HsmCluster. This constant has a value of “ACTIVATION_REQUIRED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a HsmCluster. 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 HsmCluster. 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 HsmCluster. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a HsmCluster. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a HsmCluster. This constant has a value of “DELETING”

LIFECYCLE_STATE_INITIALIZATION_REQUIRED = 'INITIALIZATION_REQUIRED'¶: A constant which can be used with the lifecycle_state property of a HsmCluster. This constant has a value of “INITIALIZATION_REQUIRED”

LIFECYCLE_STATE_INITIALIZING = 'INITIALIZING'¶: A constant which can be used with the lifecycle_state property of a HsmCluster. This constant has a value of “INITIALIZING”

LIFECYCLE_STATE_PENDING_DELETION = 'PENDING_DELETION'¶: A constant which can be used with the lifecycle_state property of a HsmCluster. 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 HsmCluster. This constant has a value of “SCHEDULING_DELETION”

__init__(**kwargs)¶

Initializes a new HsmCluster object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this HsmCluster.
compartment_id (str) – The value to assign to the compartment_id property of this HsmCluster.
display_name (str) – The value to assign to the display_name property of this HsmCluster.
time_created (datetime) – The value to assign to the time_created property of this HsmCluster.
time_updated (datetime) – The value to assign to the time_updated property of this HsmCluster.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this HsmCluster. Allowed values for this property are: “CREATING”, “INITIALIZATION_REQUIRED”, “INITIALIZING”, “ACTIVATION_REQUIRED”, “ACTIVATING”, “ACTIVE”, “DELETING”, “DELETED”, “PENDING_DELETION”, “SCHEDULING_DELETION”, “CANCELLING_DELETION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
dns_name (str) – The value to assign to the dns_name property of this HsmCluster.
time_of_deletion (datetime) – The value to assign to the time_of_deletion property of this HsmCluster.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this HsmCluster.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this HsmCluster.

compartment_id¶

[Required] Gets the compartment_id of this HsmCluster. The OCID of the compartment that contains this HSMCluster resource.

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

defined_tags¶

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

display_name¶

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

Returns:	The display_name of this HsmCluster.
Return type:	str

dns_name¶

[Required] Gets the dns_name of this HsmCluster. DNS name for the HSM Cluster – this will contain information about the region as well.

Returns:	The dns_name of this HsmCluster.
Return type:	str

freeform_tags¶

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

id¶

[Required] Gets the id of this HsmCluster. The OCID of the HSMCluster resource.

Returns:	The id of this HsmCluster.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this HsmCluster. The HSMCluster’s current state.

Example: ACTIVE

Allowed values for this property are: “CREATING”, “INITIALIZATION_REQUIRED”, “INITIALIZING”, “ACTIVATION_REQUIRED”, “ACTIVATING”, “ACTIVE”, “DELETING”, “DELETED”, “PENDING_DELETION”, “SCHEDULING_DELETION”, “CANCELLING_DELETION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this HsmCluster.
Return type:	str

time_created¶

[Required] Gets the time_created of this HsmCluster. The date and time this HSM resource was created, expressed in RFC 3339 timestamp format.

Example: 2023-04-03T21:10:29.600Z

Returns:	The time_created of this HsmCluster.
Return type:	datetime

time_of_deletion¶

Gets the time_of_deletion of this HsmCluster. An optional property indicating when to delete the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns:	The time_of_deletion of this HsmCluster.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this HsmCluster. The date and time this HSM resource was updated, expressed in RFC 3339 timestamp format.

Example: 2023-04-03T21:10:29.600Z

Returns:	The time_updated of this HsmCluster.
Return type:	datetime