CloudCluster

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

Bases: object

The details of a cloud cluster.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_NOT_CONNECTED

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

LIFECYCLE_STATE_UPDATING

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

additional_details

Gets the additional_details of this CloudCluster.

cloud_connector_id

Gets the cloud_connector_id of this CloudCluster.

cloud_db_system_id

[Required] Gets the cloud_db_system_id of this CloudCluster.

compartment_id

[Required] Gets the compartment_id of this CloudCluster.

component_name

[Required] Gets the component_name of this CloudCluster.

dbaas_id

Gets the dbaas_id of this CloudCluster.

defined_tags

Gets the defined_tags of this CloudCluster.

display_name

[Required] Gets the display_name of this CloudCluster.

freeform_tags

Gets the freeform_tags of this CloudCluster.

grid_home

Gets the grid_home of this CloudCluster.

id

[Required] Gets the id of this CloudCluster.

is_flex_cluster

Gets the is_flex_cluster of this CloudCluster.

lifecycle_details

Gets the lifecycle_details of this CloudCluster.

lifecycle_state

[Required] Gets the lifecycle_state of this CloudCluster.

network_configurations

Gets the network_configurations of this CloudCluster.

ocr_file_location

Gets the ocr_file_location of this CloudCluster.

scan_configurations

Gets the scan_configurations of this CloudCluster.

system_tags

Gets the system_tags of this CloudCluster.

time_created

[Required] Gets the time_created of this CloudCluster.

time_updated

[Required] Gets the time_updated of this CloudCluster.

version

Gets the version of this CloudCluster.

vip_configurations

Gets the vip_configurations of this CloudCluster.

Methods:

__init__(**kwargs)

Initializes a new CloudCluster object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a CloudCluster. 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 CloudCluster. 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 CloudCluster. This constant has a value of “UPDATING”

__init__(**kwargs)

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

  • dbaas_id (str) – The value to assign to the dbaas_id property of this CloudCluster.

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

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

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

  • cloud_db_system_id (str) – The value to assign to the cloud_db_system_id property of this CloudCluster.

  • cloud_connector_id (str) – The value to assign to the cloud_connector_id property of this CloudCluster.

  • grid_home (str) – The value to assign to the grid_home property of this CloudCluster.

  • is_flex_cluster (bool) – The value to assign to the is_flex_cluster property of this CloudCluster.

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this CloudCluster. 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 CloudCluster.

  • network_configurations (list[oci.database_management.models.CloudClusterNetworkConfiguration]) – The value to assign to the network_configurations property of this CloudCluster.

  • vip_configurations (list[oci.database_management.models.CloudClusterVipConfiguration]) – The value to assign to the vip_configurations property of this CloudCluster.

  • scan_configurations (list[oci.database_management.models.CloudClusterScanListenerConfiguration]) – The value to assign to the scan_configurations property of this CloudCluster.

  • ocr_file_location (str) – The value to assign to the ocr_file_location property of this CloudCluster.

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

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

  • version (str) – The value to assign to the version property of this CloudCluster.

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

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

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

property additional_details

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

Returns

The additional_details of this CloudCluster.

Return type

dict(str, str)

property cloud_connector_id

Gets the cloud_connector_id of this CloudCluster. The OCID of the cloud connector.

Returns

The cloud_connector_id of this CloudCluster.

Return type

str

property cloud_db_system_id

[Required] Gets the cloud_db_system_id of this CloudCluster. The OCID of the cloud DB system that the cluster is a part of.

Returns

The cloud_db_system_id of this CloudCluster.

Return type

str

property compartment_id

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

Returns

The compartment_id of this CloudCluster.

Return type

str

property component_name

[Required] Gets the component_name of this CloudCluster. The name of the cloud cluster.

Returns

The component_name of this CloudCluster.

Return type

str

property dbaas_id

Gets the dbaas_id of this CloudCluster. The OCID in DBaas service.

Returns

The dbaas_id of this CloudCluster.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property display_name

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

Returns

The display_name of this CloudCluster.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property grid_home

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

Returns

The grid_home of this CloudCluster.

Return type

str

property id

[Required] Gets the id of this CloudCluster. The OCID of the cloud cluster.

Returns

The id of this CloudCluster.

Return type

str

property is_flex_cluster

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

Returns

The is_flex_cluster of this CloudCluster.

Return type

bool

property lifecycle_details

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

Returns

The lifecycle_details of this CloudCluster.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this CloudCluster. The current lifecycle state of the cloud 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 CloudCluster.

Return type

str

property network_configurations

Gets the network_configurations of this CloudCluster. The list of network address configurations of the cloud cluster.

Returns

The network_configurations of this CloudCluster.

Return type

list[oci.database_management.models.CloudClusterNetworkConfiguration]

property ocr_file_location

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

Returns

The ocr_file_location of this CloudCluster.

Return type

str

property scan_configurations

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

Returns

The scan_configurations of this CloudCluster.

Return type

list[oci.database_management.models.CloudClusterScanListenerConfiguration]

property system_tags

Gets the system_tags of this CloudCluster. 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 CloudCluster.

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this CloudCluster.

Return type

datetime

property time_updated

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

Returns

The time_updated of this CloudCluster.

Return type

datetime

property version

Gets the version of this CloudCluster. The cluster version.

Returns

The version of this CloudCluster.

Return type

str

property vip_configurations

Gets the vip_configurations of this CloudCluster. The list of Virtual IP (VIP) configurations of the cloud cluster.

Returns

The vip_configurations of this CloudCluster.

Return type

list[oci.database_management.models.CloudClusterVipConfiguration]