ClusterPlacementGroup¶
- class oci.cluster_placement_groups.models.ClusterPlacementGroup(**kwargs)¶
Bases:
objectA cluster placement group, which is a logical grouping of resources that offer low latency within an availability domain by being placed in close physical proximity.
Attributes:
A constant which can be used with the cluster_placement_group_type property of a ClusterPlacementGroup.
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup.
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup.
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup.
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup.
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup.
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup.
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup.
[Required] Gets the availability_domain of this ClusterPlacementGroup.
Gets the capabilities of this ClusterPlacementGroup.
[Required] Gets the cluster_placement_group_type of this ClusterPlacementGroup.
[Required] Gets the compartment_id of this ClusterPlacementGroup.
[Required] Gets the defined_tags of this ClusterPlacementGroup.
[Required] Gets the description of this ClusterPlacementGroup.
[Required] Gets the freeform_tags of this ClusterPlacementGroup.
[Required] Gets the id of this ClusterPlacementGroup.
Gets the lifecycle_details of this ClusterPlacementGroup.
[Required] Gets the lifecycle_state of this ClusterPlacementGroup.
[Required] Gets the name of this ClusterPlacementGroup.
Gets the placement_instruction of this ClusterPlacementGroup.
Gets the system_tags of this ClusterPlacementGroup.
[Required] Gets the time_created of this ClusterPlacementGroup.
Gets the time_updated of this ClusterPlacementGroup.
Methods:
__init__(**kwargs)Initializes a new ClusterPlacementGroup object with values from keyword arguments.
- CLUSTER_PLACEMENT_GROUP_TYPE_STANDARD = 'STANDARD'¶
A constant which can be used with the cluster_placement_group_type property of a ClusterPlacementGroup. This constant has a value of “STANDARD”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a ClusterPlacementGroup. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new ClusterPlacementGroup 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 ClusterPlacementGroup.
name (str) – The value to assign to the name property of this ClusterPlacementGroup.
description (str) – The value to assign to the description property of this ClusterPlacementGroup.
compartment_id (str) – The value to assign to the compartment_id property of this ClusterPlacementGroup.
availability_domain (str) – The value to assign to the availability_domain property of this ClusterPlacementGroup.
cluster_placement_group_type (str) – The value to assign to the cluster_placement_group_type property of this ClusterPlacementGroup. Allowed values for this property are: “STANDARD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this ClusterPlacementGroup.
time_updated (datetime) – The value to assign to the time_updated property of this ClusterPlacementGroup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ClusterPlacementGroup. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ClusterPlacementGroup.
placement_instruction (oci.cluster_placement_groups.models.PlacementInstructionDetails) – The value to assign to the placement_instruction property of this ClusterPlacementGroup.
capabilities (oci.cluster_placement_groups.models.CapabilitiesCollection) – The value to assign to the capabilities property of this ClusterPlacementGroup.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ClusterPlacementGroup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ClusterPlacementGroup.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ClusterPlacementGroup.
- property availability_domain¶
[Required] Gets the availability_domain of this ClusterPlacementGroup. The availability domain of the cluster placement group.
- Returns
The availability_domain of this ClusterPlacementGroup.
- Return type
str
- property capabilities¶
Gets the capabilities of this ClusterPlacementGroup.
- Returns
The capabilities of this ClusterPlacementGroup.
- Return type
- property cluster_placement_group_type¶
[Required] Gets the cluster_placement_group_type of this ClusterPlacementGroup. The type of cluster placement group.
Allowed values for this property are: “STANDARD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The cluster_placement_group_type of this ClusterPlacementGroup.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this ClusterPlacementGroup. The OCID of the compartment that contains the cluster placement group.
- Returns
The compartment_id of this ClusterPlacementGroup.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this ClusterPlacementGroup. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this ClusterPlacementGroup.
- Return type
dict(str, dict(str, object))
- property description¶
[Required] Gets the description of this ClusterPlacementGroup. A description of the cluster placement group.
- Returns
The description of this ClusterPlacementGroup.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this ClusterPlacementGroup. 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 ClusterPlacementGroup.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this ClusterPlacementGroup. The OCID of the cluster placement group.
- Returns
The id of this ClusterPlacementGroup.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this ClusterPlacementGroup. A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.
- Returns
The lifecycle_details of this ClusterPlacementGroup.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ClusterPlacementGroup. The current state of the ClusterPlacementGroup.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this ClusterPlacementGroup.
- Return type
str
- property name¶
[Required] Gets the name of this ClusterPlacementGroup. The user-friendly name of the cluster placement group. The display name for a cluster placement must be unique and you cannot change it. Avoid entering confidential information.
- Returns
The name of this ClusterPlacementGroup.
- Return type
str
- property placement_instruction¶
Gets the placement_instruction of this ClusterPlacementGroup.
- Returns
The placement_instruction of this ClusterPlacementGroup.
- Return type
oci.cluster_placement_groups.models.PlacementInstructionDetails
- property system_tags¶
Gets the system_tags of this ClusterPlacementGroup. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this ClusterPlacementGroup.
- Return type
dict(str, dict(str, object))