ExternalDbSystem¶
- class oci.database_management.models.ExternalDbSystem(**kwargs)¶
Bases:
objectThe details of an external DB system.
Attributes:
A constant which can be used with the lifecycle_state property of a ExternalDbSystem.
A constant which can be used with the lifecycle_state property of a ExternalDbSystem.
A constant which can be used with the lifecycle_state property of a ExternalDbSystem.
A constant which can be used with the lifecycle_state property of a ExternalDbSystem.
A constant which can be used with the lifecycle_state property of a ExternalDbSystem.
A constant which can be used with the lifecycle_state property of a ExternalDbSystem.
[Required] Gets the compartment_id of this ExternalDbSystem.
Gets the database_management_config of this ExternalDbSystem.
Gets the db_system_discovery_id of this ExternalDbSystem.
Gets the defined_tags of this ExternalDbSystem.
Gets the discovery_agent_id of this ExternalDbSystem.
[Required] Gets the display_name of this ExternalDbSystem.
Gets the freeform_tags of this ExternalDbSystem.
Gets the home_directory of this ExternalDbSystem.
[Required] Gets the id of this ExternalDbSystem.
Gets the is_cluster of this ExternalDbSystem.
Gets the lifecycle_details of this ExternalDbSystem.
[Required] Gets the lifecycle_state of this ExternalDbSystem.
Gets the stack_monitoring_config of this ExternalDbSystem.
Gets the system_tags of this ExternalDbSystem.
[Required] Gets the time_created of this ExternalDbSystem.
[Required] Gets the time_updated of this ExternalDbSystem.
Methods:
__init__(**kwargs)Initializes a new ExternalDbSystem object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a ExternalDbSystem. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a ExternalDbSystem. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a ExternalDbSystem. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a ExternalDbSystem. This constant has a value of “DELETING”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a ExternalDbSystem. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a ExternalDbSystem. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new ExternalDbSystem 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 ExternalDbSystem.
display_name (str) – The value to assign to the display_name property of this ExternalDbSystem.
compartment_id (str) – The value to assign to the compartment_id property of this ExternalDbSystem.
db_system_discovery_id (str) – The value to assign to the db_system_discovery_id property of this ExternalDbSystem.
discovery_agent_id (str) – The value to assign to the discovery_agent_id property of this ExternalDbSystem.
is_cluster (bool) – The value to assign to the is_cluster property of this ExternalDbSystem.
home_directory (str) – The value to assign to the home_directory property of this ExternalDbSystem.
database_management_config (oci.database_management.models.ExternalDbSystemDatabaseManagementConfigDetails) – The value to assign to the database_management_config property of this ExternalDbSystem.
stack_monitoring_config (oci.database_management.models.ExternalDbSystemStackMonitoringConfigDetails) – The value to assign to the stack_monitoring_config property of this ExternalDbSystem.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ExternalDbSystem. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “INACTIVE”, ‘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 ExternalDbSystem.
time_created (datetime) – The value to assign to the time_created property of this ExternalDbSystem.
time_updated (datetime) – The value to assign to the time_updated property of this ExternalDbSystem.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ExternalDbSystem.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ExternalDbSystem.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ExternalDbSystem.
- property compartment_id¶
[Required] Gets the compartment_id of this ExternalDbSystem. The OCID of the compartment.
- Returns
The compartment_id of this ExternalDbSystem.
- Return type
str
- property database_management_config¶
Gets the database_management_config of this ExternalDbSystem.
- Returns
The database_management_config of this ExternalDbSystem.
- Return type
oci.database_management.models.ExternalDbSystemDatabaseManagementConfigDetails
- property db_system_discovery_id¶
Gets the db_system_discovery_id of this ExternalDbSystem. The OCID of the DB system discovery.
- Returns
The db_system_discovery_id of this ExternalDbSystem.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this ExternalDbSystem. 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 ExternalDbSystem.
- Return type
dict(str, dict(str, object))
- property discovery_agent_id¶
Gets the discovery_agent_id of this ExternalDbSystem. The OCID of the management agent used during the discovery of the DB system.
- Returns
The discovery_agent_id of this ExternalDbSystem.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this ExternalDbSystem. The user-friendly name for the DB system. The name does not have to be unique.
- Returns
The display_name of this ExternalDbSystem.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this ExternalDbSystem. 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 ExternalDbSystem.
- Return type
dict(str, str)
- property home_directory¶
Gets the home_directory of this ExternalDbSystem. The Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
- Returns
The home_directory of this ExternalDbSystem.
- Return type
str
- property id¶
[Required] Gets the id of this ExternalDbSystem. The OCID of the external DB system.
- Returns
The id of this ExternalDbSystem.
- Return type
str
- property is_cluster¶
Gets the is_cluster of this ExternalDbSystem. Indicates whether the DB system is a cluster DB system or not.
- Returns
The is_cluster of this ExternalDbSystem.
- Return type
bool
- property lifecycle_details¶
Gets the lifecycle_details of this ExternalDbSystem. Additional information about the current lifecycle state.
- Returns
The lifecycle_details of this ExternalDbSystem.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ExternalDbSystem. The current lifecycle state of the external DB system resource.
Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this ExternalDbSystem.
- Return type
str
- property stack_monitoring_config¶
Gets the stack_monitoring_config of this ExternalDbSystem.
- Returns
The stack_monitoring_config of this ExternalDbSystem.
- Return type
oci.database_management.models.ExternalDbSystemStackMonitoringConfigDetails
- property system_tags¶
Gets the system_tags of this ExternalDbSystem. 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 ExternalDbSystem.
- Return type
dict(str, dict(str, object))
- property time_created¶
[Required] Gets the time_created of this ExternalDbSystem. The date and time the external DB system was created.
- Returns
The time_created of this ExternalDbSystem.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this ExternalDbSystem. The date and time the external DB system was last updated.
- Returns
The time_updated of this ExternalDbSystem.
- Return type
datetime