HsmClusterSummary¶
- class oci.key_management.models.HsmClusterSummary(**kwargs)¶
Bases:
objectAn object which encapsulates the details of a given HSM Cluster.
Methods:
__init__(**kwargs)Initializes a new HsmClusterSummary object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this HsmClusterSummary.
Gets the defined_tags of this HsmClusterSummary.
[Required] Gets the display_name of this HsmClusterSummary.
[Required] Gets the dns_name of this HsmClusterSummary.
Gets the freeform_tags of this HsmClusterSummary.
[Required] Gets the id of this HsmClusterSummary.
[Required] Gets the lifecycle_state of this HsmClusterSummary.
[Required] Gets the time_created of this HsmClusterSummary.
Gets the time_of_deletion of this HsmClusterSummary.
[Required] Gets the time_updated of this HsmClusterSummary.
- __init__(**kwargs)¶
Initializes a new HsmClusterSummary 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 HsmClusterSummary.
display_name (str) – The value to assign to the display_name property of this HsmClusterSummary.
compartment_id (str) – The value to assign to the compartment_id property of this HsmClusterSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this HsmClusterSummary.
dns_name (str) – The value to assign to the dns_name property of this HsmClusterSummary.
time_created (datetime) – The value to assign to the time_created property of this HsmClusterSummary.
time_updated (datetime) – The value to assign to the time_updated property of this HsmClusterSummary.
time_of_deletion (datetime) – The value to assign to the time_of_deletion property of this HsmClusterSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this HsmClusterSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this HsmClusterSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this HsmClusterSummary. The OCID of the compartment that contains a particular HSMCluster resource.
- Returns
The compartment_id of this HsmClusterSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this HsmClusterSummary. 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 HsmClusterSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this HsmClusterSummary. A user-friendly name for a HSMCluster resource. It does not have to be unique, and it is changeable. Avoid entering confidential information.
- Returns
The display_name of this HsmClusterSummary.
- Return type
str
- property dns_name¶
[Required] Gets the dns_name of this HsmClusterSummary. DNS name for the HSMCluster – this will contain information about the region as well.
- Returns
The dns_name of this HsmClusterSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this HsmClusterSummary. 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 HsmClusterSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this HsmClusterSummary. The OCID of a HSMCluster resource.
- Returns
The id of this HsmClusterSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this HsmClusterSummary. A HSMCluster resource’s current lifecycle state.
Example: ACTIVE
- Returns
The lifecycle_state of this HsmClusterSummary.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this HsmClusterSummary. The date and time a dedicated KMS resource was created, expressed in RFC 3339 timestamp format.
Example: 2023-04-03T21:10:29.600Z
- Returns
The time_created of this HsmClusterSummary.
- Return type
datetime