ExternalClusterInstance

class oci.database_management.models.ExternalClusterInstance(**kwargs)

Bases: object

The details of an external cluster instance.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance.

LIFECYCLE_STATE_NOT_CONNECTED

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance.

NODE_ROLE_HUB

A constant which can be used with the node_role property of a ExternalClusterInstance.

NODE_ROLE_LEAF

A constant which can be used with the node_role property of a ExternalClusterInstance.

adr_home_directory

Gets the adr_home_directory of this ExternalClusterInstance.

compartment_id

[Required] Gets the compartment_id of this ExternalClusterInstance.

component_name

[Required] Gets the component_name of this ExternalClusterInstance.

crs_base_directory

Gets the crs_base_directory of this ExternalClusterInstance.

defined_tags

Gets the defined_tags of this ExternalClusterInstance.

display_name

[Required] Gets the display_name of this ExternalClusterInstance.

external_cluster_id

[Required] Gets the external_cluster_id of this ExternalClusterInstance.

external_connector_id

Gets the external_connector_id of this ExternalClusterInstance.

external_db_node_id

Gets the external_db_node_id of this ExternalClusterInstance.

external_db_system_id

[Required] Gets the external_db_system_id of this ExternalClusterInstance.

freeform_tags

Gets the freeform_tags of this ExternalClusterInstance.

host_name

Gets the host_name of this ExternalClusterInstance.

id

[Required] Gets the id of this ExternalClusterInstance.

lifecycle_details

Gets the lifecycle_details of this ExternalClusterInstance.

lifecycle_state

[Required] Gets the lifecycle_state of this ExternalClusterInstance.

node_role

Gets the node_role of this ExternalClusterInstance.

system_tags

Gets the system_tags of this ExternalClusterInstance.

time_created

Gets the time_created of this ExternalClusterInstance.

time_updated

Gets the time_updated of this ExternalClusterInstance.

Methods:

__init__(**kwargs)

Initializes a new ExternalClusterInstance object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_NOT_CONNECTED = 'NOT_CONNECTED'

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance. This constant has a value of “NOT_CONNECTED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a ExternalClusterInstance. This constant has a value of “UPDATING”

NODE_ROLE_HUB = 'HUB'

A constant which can be used with the node_role property of a ExternalClusterInstance. This constant has a value of “HUB”

NODE_ROLE_LEAF = 'LEAF'

A constant which can be used with the node_role property of a ExternalClusterInstance. This constant has a value of “LEAF”

__init__(**kwargs)

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

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

  • component_name (str) – The value to assign to the component_name property of this ExternalClusterInstance.

  • compartment_id (str) – The value to assign to the compartment_id property of this ExternalClusterInstance.

  • external_cluster_id (str) – The value to assign to the external_cluster_id property of this ExternalClusterInstance.

  • external_db_system_id (str) – The value to assign to the external_db_system_id property of this ExternalClusterInstance.

  • external_db_node_id (str) – The value to assign to the external_db_node_id property of this ExternalClusterInstance.

  • external_connector_id (str) – The value to assign to the external_connector_id property of this ExternalClusterInstance.

  • host_name (str) – The value to assign to the host_name property of this ExternalClusterInstance.

  • node_role (str) – The value to assign to the node_role property of this ExternalClusterInstance. Allowed values for this property are: “HUB”, “LEAF”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • crs_base_directory (str) – The value to assign to the crs_base_directory property of this ExternalClusterInstance.

  • adr_home_directory (str) – The value to assign to the adr_home_directory property of this ExternalClusterInstance.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ExternalClusterInstance. Allowed values for this property are: “CREATING”, “NOT_CONNECTED”, “ACTIVE”, “INACTIVE”, “UPDATING”, “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 ExternalClusterInstance.

  • time_created (datetime) – The value to assign to the time_created property of this ExternalClusterInstance.

  • time_updated (datetime) – The value to assign to the time_updated property of this ExternalClusterInstance.

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

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

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

property adr_home_directory

Gets the adr_home_directory of this ExternalClusterInstance. The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.

Returns

The adr_home_directory of this ExternalClusterInstance.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this ExternalClusterInstance. The OCID of the compartment.

Returns

The compartment_id of this ExternalClusterInstance.

Return type

str

property component_name

[Required] Gets the component_name of this ExternalClusterInstance. The name of the external cluster instance.

Returns

The component_name of this ExternalClusterInstance.

Return type

str

property crs_base_directory

Gets the crs_base_directory of this ExternalClusterInstance. The Oracle base location of Cluster Ready Services (CRS).

Returns

The crs_base_directory of this ExternalClusterInstance.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this ExternalClusterInstance. The user-friendly name for the cluster instance. The name does not have to be unique.

Returns

The display_name of this ExternalClusterInstance.

Return type

str

property external_cluster_id

[Required] Gets the external_cluster_id of this ExternalClusterInstance. The OCID of the external cluster that the cluster instance belongs to.

Returns

The external_cluster_id of this ExternalClusterInstance.

Return type

str

property external_connector_id

Gets the external_connector_id of this ExternalClusterInstance. The OCID of the external connector.

Returns

The external_connector_id of this ExternalClusterInstance.

Return type

str

property external_db_node_id

Gets the external_db_node_id of this ExternalClusterInstance. The OCID of the external DB node.

Returns

The external_db_node_id of this ExternalClusterInstance.

Return type

str

property external_db_system_id

[Required] Gets the external_db_system_id of this ExternalClusterInstance. The OCID of the external DB system that the cluster instance is a part of.

Returns

The external_db_system_id of this ExternalClusterInstance.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property host_name

Gets the host_name of this ExternalClusterInstance. The name of the host on which the cluster instance is running.

Returns

The host_name of this ExternalClusterInstance.

Return type

str

property id

[Required] Gets the id of this ExternalClusterInstance. The OCID of the external cluster instance.

Returns

The id of this ExternalClusterInstance.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this ExternalClusterInstance. Additional information about the current lifecycle state.

Returns

The lifecycle_details of this ExternalClusterInstance.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this ExternalClusterInstance. The current lifecycle state of the external cluster instance.

Allowed values for this property are: “CREATING”, “NOT_CONNECTED”, “ACTIVE”, “INACTIVE”, “UPDATING”, “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 ExternalClusterInstance.

Return type

str

property node_role

Gets the node_role of this ExternalClusterInstance. The role of the cluster node.

Allowed values for this property are: “HUB”, “LEAF”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The node_role of this ExternalClusterInstance.

Return type

str

property system_tags

Gets the system_tags of this ExternalClusterInstance. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this ExternalClusterInstance.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this ExternalClusterInstance. The date and time the external cluster instance was created.

Returns

The time_created of this ExternalClusterInstance.

Return type

datetime

property time_updated

Gets the time_updated of this ExternalClusterInstance. The date and time the external cluster instance was last updated.

Returns

The time_updated of this ExternalClusterInstance.

Return type

datetime