ExternalDatabaseBase¶

class oci.database.models.ExternalDatabaseBase(**kwargs)¶

Bases: object

A resource that allows you to manage an Oracle Database located outside of Oracle Cloud using Oracle Cloud Infrastructure’s Console and APIs.

Attributes

`DATABASE_CONFIGURATION_RAC`	A constant which can be used with the database_configuration property of a ExternalDatabaseBase.
`DATABASE_CONFIGURATION_SINGLE_INSTANCE`	A constant which can be used with the database_configuration property of a ExternalDatabaseBase.
`DATABASE_EDITION_ENTERPRISE_EDITION`	A constant which can be used with the database_edition property of a ExternalDatabaseBase.
`DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE`	A constant which can be used with the database_edition property of a ExternalDatabaseBase.
`DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE`	A constant which can be used with the database_edition property of a ExternalDatabaseBase.
`DATABASE_EDITION_STANDARD_EDITION`	A constant which can be used with the database_edition property of a ExternalDatabaseBase.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase.
`LIFECYCLE_STATE_NOT_CONNECTED`	A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase.
`character_set`	Gets the character_set of this ExternalDatabaseBase.
`compartment_id`	[Required] Gets the compartment_id of this ExternalDatabaseBase.
`database_configuration`	Gets the database_configuration of this ExternalDatabaseBase.
`database_edition`	Gets the database_edition of this ExternalDatabaseBase.
`database_management_config`	Gets the database_management_config of this ExternalDatabaseBase.
`database_version`	Gets the database_version of this ExternalDatabaseBase.
`db_id`	Gets the db_id of this ExternalDatabaseBase.
`db_packs`	Gets the db_packs of this ExternalDatabaseBase.
`db_unique_name`	Gets the db_unique_name of this ExternalDatabaseBase.
`defined_tags`	Gets the defined_tags of this ExternalDatabaseBase.
`display_name`	[Required] Gets the display_name of this ExternalDatabaseBase.
`freeform_tags`	Gets the freeform_tags of this ExternalDatabaseBase.
`id`	[Required] Gets the id of this ExternalDatabaseBase.
`lifecycle_details`	Gets the lifecycle_details of this ExternalDatabaseBase.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ExternalDatabaseBase.
`ncharacter_set`	Gets the ncharacter_set of this ExternalDatabaseBase.
`stack_monitoring_config`	Gets the stack_monitoring_config of this ExternalDatabaseBase.
`time_created`	[Required] Gets the time_created of this ExternalDatabaseBase.
`time_zone`	Gets the time_zone of this ExternalDatabaseBase.

Methods

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

DATABASE_CONFIGURATION_RAC = 'RAC'¶: A constant which can be used with the database_configuration property of a ExternalDatabaseBase. This constant has a value of “RAC”

DATABASE_CONFIGURATION_SINGLE_INSTANCE = 'SINGLE_INSTANCE'¶: A constant which can be used with the database_configuration property of a ExternalDatabaseBase. This constant has a value of “SINGLE_INSTANCE”

DATABASE_EDITION_ENTERPRISE_EDITION = 'ENTERPRISE_EDITION'¶: A constant which can be used with the database_edition property of a ExternalDatabaseBase. This constant has a value of “ENTERPRISE_EDITION”

DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'¶: A constant which can be used with the database_edition property of a ExternalDatabaseBase. This constant has a value of “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”

DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = 'ENTERPRISE_EDITION_HIGH_PERFORMANCE'¶: A constant which can be used with the database_edition property of a ExternalDatabaseBase. This constant has a value of “ENTERPRISE_EDITION_HIGH_PERFORMANCE”

DATABASE_EDITION_STANDARD_EDITION = 'STANDARD_EDITION'¶: A constant which can be used with the database_edition property of a ExternalDatabaseBase. This constant has a value of “STANDARD_EDITION”

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase. This constant has a value of “AVAILABLE”

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

LIFECYCLE_STATE_NOT_CONNECTED = 'NOT_CONNECTED'¶: A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase. This constant has a value of “NOT_CONNECTED”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase. This constant has a value of “TERMINATING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ExternalDatabaseBase. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ExternalDatabaseBase object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this ExternalDatabaseBase.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ExternalDatabaseBase.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ExternalDatabaseBase.
display_name (str) – The value to assign to the display_name property of this ExternalDatabaseBase.
id (str) – The value to assign to the id property of this ExternalDatabaseBase.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ExternalDatabaseBase.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ExternalDatabaseBase. Allowed values for this property are: “PROVISIONING”, “NOT_CONNECTED”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, ‘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 ExternalDatabaseBase.
db_unique_name (str) – The value to assign to the db_unique_name property of this ExternalDatabaseBase.
db_id (str) – The value to assign to the db_id property of this ExternalDatabaseBase.
database_version (str) – The value to assign to the database_version property of this ExternalDatabaseBase.
database_edition (str) – The value to assign to the database_edition property of this ExternalDatabaseBase. Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, “ENTERPRISE_EDITION_HIGH_PERFORMANCE”, “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_zone (str) – The value to assign to the time_zone property of this ExternalDatabaseBase.
character_set (str) – The value to assign to the character_set property of this ExternalDatabaseBase.
ncharacter_set (str) – The value to assign to the ncharacter_set property of this ExternalDatabaseBase.
db_packs (str) – The value to assign to the db_packs property of this ExternalDatabaseBase.
database_configuration (str) – The value to assign to the database_configuration property of this ExternalDatabaseBase. Allowed values for this property are: “RAC”, “SINGLE_INSTANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
database_management_config (oci.database.models.DatabaseManagementConfig) – The value to assign to the database_management_config property of this ExternalDatabaseBase.
stack_monitoring_config (oci.database.models.StackMonitoringConfig) – The value to assign to the stack_monitoring_config property of this ExternalDatabaseBase.

character_set¶

Gets the character_set of this ExternalDatabaseBase. The character set of the external database.

Returns:	The character_set of this ExternalDatabaseBase.
Return type:	str

compartment_id¶

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

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

database_configuration¶

Gets the database_configuration of this ExternalDatabaseBase. The Oracle Database configuration

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

Returns:	The database_configuration of this ExternalDatabaseBase.
Return type:	str

database_edition¶

Gets the database_edition of this ExternalDatabaseBase. The Oracle Database edition.

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

Returns:	The database_edition of this ExternalDatabaseBase.
Return type:	str

database_management_config¶

Gets the database_management_config of this ExternalDatabaseBase.

Returns:	The database_management_config of this ExternalDatabaseBase.
Return type:	oci.database.models.DatabaseManagementConfig

database_version¶

Gets the database_version of this ExternalDatabaseBase. The Oracle Database version.

Returns:	The database_version of this ExternalDatabaseBase.
Return type:	str

db_id¶

Gets the db_id of this ExternalDatabaseBase. The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.

Returns:	The db_id of this ExternalDatabaseBase.
Return type:	str

db_packs¶

Gets the db_packs of this ExternalDatabaseBase. The database packs licensed for the external Oracle Database.

Returns:	The db_packs of this ExternalDatabaseBase.
Return type:	str

db_unique_name¶

Gets the db_unique_name of this ExternalDatabaseBase. The DB_UNIQUE_NAME of the external database.

Returns:	The db_unique_name of this ExternalDatabaseBase.
Return type:	str

defined_tags¶

Gets the defined_tags of this ExternalDatabaseBase. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:	The defined_tags of this ExternalDatabaseBase.
Return type:	dict(str, dict(str, object))

display_name¶

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

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

freeform_tags¶

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

id¶

[Required] Gets the id of this ExternalDatabaseBase. The OCID of the Oracle Cloud Infrastructure external database resource.

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

lifecycle_details¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this ExternalDatabaseBase. The current state of the Oracle Cloud Infrastructure external database resource.

Allowed values for this property are: “PROVISIONING”, “NOT_CONNECTED”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this ExternalDatabaseBase.
Return type:	str

ncharacter_set¶

Gets the ncharacter_set of this ExternalDatabaseBase. The national character of the external database.

Returns:	The ncharacter_set of this ExternalDatabaseBase.
Return type:	str

stack_monitoring_config¶

Gets the stack_monitoring_config of this ExternalDatabaseBase.

Returns:	The stack_monitoring_config of this ExternalDatabaseBase.
Return type:	oci.database.models.StackMonitoringConfig

time_created¶

[Required] Gets the time_created of this ExternalDatabaseBase. The date and time the database was created.

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

time_zone¶

Gets the time_zone of this ExternalDatabaseBase. The time zone of the external database. It is a time zone offset (a character type in the format ‘[+|-]TZH:TZM’) or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

Returns:	The time_zone of this ExternalDatabaseBase.
Return type:	str