ExternalCluster¶

class oci.database_management.models.ExternalCluster(**kwargs)¶

Bases: object

The details of an external cluster.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ExternalCluster.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ExternalCluster.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ExternalCluster.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ExternalCluster.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ExternalCluster.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a ExternalCluster.
`LIFECYCLE_STATE_NOT_CONNECTED`	A constant which can be used with the lifecycle_state property of a ExternalCluster.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ExternalCluster.
`additional_details`	Gets the additional_details of this ExternalCluster.
`compartment_id`	[Required] Gets the compartment_id of this ExternalCluster.
`component_name`	[Required] Gets the component_name of this ExternalCluster.
`defined_tags`	Gets the defined_tags of this ExternalCluster.
`display_name`	[Required] Gets the display_name of this ExternalCluster.
`external_connector_id`	Gets the external_connector_id of this ExternalCluster.
`external_db_system_id`	[Required] Gets the external_db_system_id of this ExternalCluster.
`freeform_tags`	Gets the freeform_tags of this ExternalCluster.
`grid_home`	Gets the grid_home of this ExternalCluster.
`id`	[Required] Gets the id of this ExternalCluster.
`is_flex_cluster`	Gets the is_flex_cluster of this ExternalCluster.
`lifecycle_details`	Gets the lifecycle_details of this ExternalCluster.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ExternalCluster.
`network_configurations`	Gets the network_configurations of this ExternalCluster.
`ocr_file_location`	Gets the ocr_file_location of this ExternalCluster.
`scan_configurations`	Gets the scan_configurations of this ExternalCluster.
`system_tags`	Gets the system_tags of this ExternalCluster.
`time_created`	[Required] Gets the time_created of this ExternalCluster.
`time_updated`	[Required] Gets the time_updated of this ExternalCluster.
`version`	Gets the version of this ExternalCluster.
`vip_configurations`	Gets the vip_configurations of this ExternalCluster.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ExternalCluster. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ExternalCluster. This constant has a value of “CREATING”

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

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

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ExternalCluster. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a ExternalCluster. 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 ExternalCluster. 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 ExternalCluster. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ExternalCluster 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 ExternalCluster.
display_name (str) – The value to assign to the display_name property of this ExternalCluster.
component_name (str) – The value to assign to the component_name property of this ExternalCluster.
compartment_id (str) – The value to assign to the compartment_id property of this ExternalCluster.
external_db_system_id (str) – The value to assign to the external_db_system_id property of this ExternalCluster.
external_connector_id (str) – The value to assign to the external_connector_id property of this ExternalCluster.
grid_home (str) – The value to assign to the grid_home property of this ExternalCluster.
is_flex_cluster (bool) – The value to assign to the is_flex_cluster property of this ExternalCluster.
additional_details (dict(str, str)) – The value to assign to the additional_details property of this ExternalCluster.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ExternalCluster. 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 ExternalCluster.
network_configurations (list[oci.database_management.models.ExternalClusterNetworkConfiguration]) – The value to assign to the network_configurations property of this ExternalCluster.
vip_configurations (list[oci.database_management.models.ExternalClusterVipConfiguration]) – The value to assign to the vip_configurations property of this ExternalCluster.
scan_configurations (list[oci.database_management.models.ExternalClusterScanListenerConfiguration]) – The value to assign to the scan_configurations property of this ExternalCluster.
ocr_file_location (str) – The value to assign to the ocr_file_location property of this ExternalCluster.
time_created (datetime) – The value to assign to the time_created property of this ExternalCluster.
time_updated (datetime) – The value to assign to the time_updated property of this ExternalCluster.
version (str) – The value to assign to the version property of this ExternalCluster.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ExternalCluster.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ExternalCluster.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ExternalCluster.

additional_details¶

Gets the additional_details of this ExternalCluster. The additional details of the external cluster defined in {“key”: “value”} format. Example: {“bar-key”: “value”}

Returns:	The additional_details of this ExternalCluster.
Return type:	dict(str, str)

compartment_id¶

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

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

component_name¶

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

Returns:	The component_name of this ExternalCluster.
Return type:	str

defined_tags¶

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

display_name¶

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

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

external_connector_id¶

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

Returns:	The external_connector_id of this ExternalCluster.
Return type:	str

external_db_system_id¶

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

Returns:	The external_db_system_id of this ExternalCluster.
Return type:	str

freeform_tags¶

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

grid_home¶

Gets the grid_home of this ExternalCluster. The directory in which Oracle Grid Infrastructure is installed.

Returns:	The grid_home of this ExternalCluster.
Return type:	str

id¶

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

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

is_flex_cluster¶

Gets the is_flex_cluster of this ExternalCluster. Indicates whether the cluster is Oracle Flex Cluster or not.

Returns:	The is_flex_cluster of this ExternalCluster.
Return type:	bool

lifecycle_details¶

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

Returns:	The lifecycle_details of this ExternalCluster.
Return type:	str

lifecycle_state¶

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

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 ExternalCluster.
Return type:	str

network_configurations¶

Gets the network_configurations of this ExternalCluster. The list of network address configurations of the external cluster.

Returns:	The network_configurations of this ExternalCluster.
Return type:	list[oci.database_management.models.ExternalClusterNetworkConfiguration]

ocr_file_location¶

Gets the ocr_file_location of this ExternalCluster. The location of the Oracle Cluster Registry (OCR).

Returns:	The ocr_file_location of this ExternalCluster.
Return type:	str

scan_configurations¶

Gets the scan_configurations of this ExternalCluster. The list of Single Client Access Name (SCAN) configurations of the external cluster.

Returns:	The scan_configurations of this ExternalCluster.
Return type:	list[oci.database_management.models.ExternalClusterScanListenerConfiguration]

system_tags¶

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

time_created¶

[Required] Gets the time_created of this ExternalCluster. The date and time the external cluster was created.

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

time_updated¶

[Required] Gets the time_updated of this ExternalCluster. The date and time the external cluster was last updated.

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

version¶

Gets the version of this ExternalCluster. The cluster version.

Returns:	The version of this ExternalCluster.
Return type:	str

vip_configurations¶

Gets the vip_configurations of this ExternalCluster. The list of Virtual IP (VIP) configurations of the external cluster.

Returns:	The vip_configurations of this ExternalCluster.
Return type:	list[oci.database_management.models.ExternalClusterVipConfiguration]