ExternalDatabaseConnector

class oci.database.models.ExternalDatabaseConnector(**kwargs)

Bases: object

An Oracle Cloud Infrastructure resource used to connect to an external Oracle Database. This resource stores the database connection string, user credentials, and related details that allow you to manage your external database using the Oracle Cloud Infrastructure Console and API interfaces.

Attributes:

CONNECTOR_TYPE_MACS	A constant which can be used with the connector_type property of a ExternalDatabaseConnector.
LIFECYCLE_STATE_AVAILABLE	A constant which can be used with the lifecycle_state property of a ExternalDatabaseConnector.
LIFECYCLE_STATE_FAILED	A constant which can be used with the lifecycle_state property of a ExternalDatabaseConnector.
LIFECYCLE_STATE_PROVISIONING	A constant which can be used with the lifecycle_state property of a ExternalDatabaseConnector.
LIFECYCLE_STATE_TERMINATED	A constant which can be used with the lifecycle_state property of a ExternalDatabaseConnector.
LIFECYCLE_STATE_TERMINATING	A constant which can be used with the lifecycle_state property of a ExternalDatabaseConnector.
LIFECYCLE_STATE_UPDATING	A constant which can be used with the lifecycle_state property of a ExternalDatabaseConnector.
compartment_id	[Required] Gets the compartment_id of this ExternalDatabaseConnector.
connection_status	[Required] Gets the connection_status of this ExternalDatabaseConnector.
connector_type	[Required] Gets the connector_type of this ExternalDatabaseConnector.
defined_tags	Gets the defined_tags of this ExternalDatabaseConnector.
display_name	[Required] Gets the display_name of this ExternalDatabaseConnector.
external_database_id	[Required] Gets the external_database_id of this ExternalDatabaseConnector.
freeform_tags	Gets the freeform_tags of this ExternalDatabaseConnector.
id	[Required] Gets the id of this ExternalDatabaseConnector.
lifecycle_details	Gets the lifecycle_details of this ExternalDatabaseConnector.
lifecycle_state	[Required] Gets the lifecycle_state of this ExternalDatabaseConnector.
system_tags	Gets the system_tags of this ExternalDatabaseConnector.
time_connection_status_last_updated	[Required] Gets the time_connection_status_last_updated of this ExternalDatabaseConnector.
time_created	[Required] Gets the time_created of this ExternalDatabaseConnector.

Methods:

__init__(**kwargs)	Initializes a new ExternalDatabaseConnector object with values from keyword arguments.
get_subtype(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

CONNECTOR_TYPE_MACS = 'MACS'

A constant which can be used with the connector_type property of a ExternalDatabaseConnector. This constant has a value of “MACS”

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'

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

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

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

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new ExternalDatabaseConnector object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

• ExternalMacsConnector

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 ExternalDatabaseConnector.

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

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

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

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

• id (str) – The value to assign to the id property of this ExternalDatabaseConnector.

• lifecycle_state (str) – The value to assign to the lifecycle_state property of this ExternalDatabaseConnector. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “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 ExternalDatabaseConnector.

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

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

• external_database_id (str) – The value to assign to the external_database_id property of this ExternalDatabaseConnector.

• connection_status (str) – The value to assign to the connection_status property of this ExternalDatabaseConnector.

• time_connection_status_last_updated (datetime) – The value to assign to the time_connection_status_last_updated property of this ExternalDatabaseConnector.

property compartment_id

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

Returns

The compartment_id of this ExternalDatabaseConnector.

Return type

str

property connection_status

[Required] Gets the connection_status of this ExternalDatabaseConnector. The status of connectivity to the external database.

Returns

The connection_status of this ExternalDatabaseConnector.

Return type

str

property connector_type

[Required] Gets the connector_type of this ExternalDatabaseConnector. The type of connector used by the external database resource.

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

Returns

The connector_type of this ExternalDatabaseConnector.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this ExternalDatabaseConnector. The user-friendly name for the create_external_database_connector_details(). The name does not have to be unique.

Returns

The display_name of this ExternalDatabaseConnector.

Return type

str

property external_database_id

[Required] Gets the external_database_id of this ExternalDatabaseConnector. The OCID of the external database resource.

Returns

The external_database_id of this ExternalDatabaseConnector.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property id

[Required] Gets the id of this ExternalDatabaseConnector. The OCID of the create_external_database_connector_details().

Returns

The id of this ExternalDatabaseConnector.

Return type

str

property lifecycle_details

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

Returns

The lifecycle_details of this ExternalDatabaseConnector.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this ExternalDatabaseConnector. The current lifecycle state of the external database connector resource.

Allowed values for this property are: “PROVISIONING”, “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 ExternalDatabaseConnector.

Return type

str

property system_tags

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

Returns

The system_tags of this ExternalDatabaseConnector.

Return type

dict(str, dict(str, object))

property time_connection_status_last_updated

[Required] Gets the time_connection_status_last_updated of this ExternalDatabaseConnector. The date and time the connectionStatus of this external connector was last updated.

Returns

The time_connection_status_last_updated of this ExternalDatabaseConnector.

Return type

datetime

property time_created

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

Returns

The time_created of this ExternalDatabaseConnector.

Return type

datetime