TargetDatabase¶

class oci.data_safe.models.TargetDatabase(**kwargs)¶

Bases: object

The details of the Data Safe target database.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a TargetDatabase.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a TargetDatabase.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a TargetDatabase.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a TargetDatabase.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a TargetDatabase.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a TargetDatabase.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a TargetDatabase.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a TargetDatabase.
`associated_resource_ids`	Gets the associated_resource_ids of this TargetDatabase.
`compartment_id`	[Required] Gets the compartment_id of this TargetDatabase.
`connection_option`	Gets the connection_option of this TargetDatabase.
`credentials`	Gets the credentials of this TargetDatabase.
`database_details`	[Required] Gets the database_details of this TargetDatabase.
`defined_tags`	Gets the defined_tags of this TargetDatabase.
`description`	Gets the description of this TargetDatabase.
`display_name`	[Required] Gets the display_name of this TargetDatabase.
`freeform_tags`	Gets the freeform_tags of this TargetDatabase.
`id`	[Required] Gets the id of this TargetDatabase.
`lifecycle_details`	Gets the lifecycle_details of this TargetDatabase.
`lifecycle_state`	[Required] Gets the lifecycle_state of this TargetDatabase.
`peer_target_databases`	Gets the peer_target_databases of this TargetDatabase.
`system_tags`	Gets the system_tags of this TargetDatabase.
`time_created`	[Required] Gets the time_created of this TargetDatabase.
`time_updated`	Gets the time_updated of this TargetDatabase.
`tls_config`	Gets the tls_config of this TargetDatabase.

Methods

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

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

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

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

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a TargetDatabase. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a TargetDatabase. This constant has a value of “NEEDS_ATTENTION”

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

__init__(**kwargs)¶

Initializes a new TargetDatabase 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 TargetDatabase.
id (str) – The value to assign to the id property of this TargetDatabase.
display_name (str) – The value to assign to the display_name property of this TargetDatabase.
description (str) – The value to assign to the description property of this TargetDatabase.
database_details (oci.data_safe.models.DatabaseDetails) – The value to assign to the database_details property of this TargetDatabase.
credentials (oci.data_safe.models.Credentials) – The value to assign to the credentials property of this TargetDatabase.
tls_config (oci.data_safe.models.TlsConfig) – The value to assign to the tls_config property of this TargetDatabase.
connection_option (oci.data_safe.models.ConnectionOption) – The value to assign to the connection_option property of this TargetDatabase.
associated_resource_ids (list[str]) – The value to assign to the associated_resource_ids property of this TargetDatabase.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this TargetDatabase. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”, “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 TargetDatabase.
time_created (datetime) – The value to assign to the time_created property of this TargetDatabase.
time_updated (datetime) – The value to assign to the time_updated property of this TargetDatabase.
peer_target_databases (list[oci.data_safe.models.PeerTargetDatabase]) – The value to assign to the peer_target_databases property of this TargetDatabase.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this TargetDatabase.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this TargetDatabase.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this TargetDatabase.

associated_resource_ids¶

Gets the associated_resource_ids of this TargetDatabase. The OCIDs of associated resources like database, Data Safe private endpoint etc.

Returns:	The associated_resource_ids of this TargetDatabase.
Return type:	list[str]

compartment_id¶

[Required] Gets the compartment_id of this TargetDatabase. The OCID of the compartment which contains the Data Safe target database.

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

connection_option¶

Gets the connection_option of this TargetDatabase.

Returns:	The connection_option of this TargetDatabase.
Return type:	oci.data_safe.models.ConnectionOption

credentials¶

Gets the credentials of this TargetDatabase.

Returns:	The credentials of this TargetDatabase.
Return type:	oci.data_safe.models.Credentials

database_details¶

[Required] Gets the database_details of this TargetDatabase.

Returns:	The database_details of this TargetDatabase.
Return type:	oci.data_safe.models.DatabaseDetails

defined_tags¶

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

description¶

Gets the description of this TargetDatabase. The description of the target database in Data Safe.

Returns:	The description of this TargetDatabase.
Return type:	str

display_name¶

[Required] Gets the display_name of this TargetDatabase. The display name of the target database in Data Safe.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this TargetDatabase. The OCID of the Data Safe target database.

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

lifecycle_details¶

Gets the lifecycle_details of this TargetDatabase. Details about the current state of the target database in Data Safe.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this TargetDatabase. The current state of the target database in Data Safe.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

peer_target_databases¶

Gets the peer_target_databases of this TargetDatabase. The OCIDs of associated resources like database, Data Safe private endpoint, etc.

Returns:	The peer_target_databases of this TargetDatabase.
Return type:	list[oci.data_safe.models.PeerTargetDatabase]

system_tags¶

Gets the system_tags of this TargetDatabase. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this TargetDatabase.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this TargetDatabase. The date and time of the target database registration and creation in Data Safe.

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

time_updated¶

Gets the time_updated of this TargetDatabase. The date and time of the target database update in Data Safe.

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

tls_config¶

Gets the tls_config of this TargetDatabase.

Returns:	The tls_config of this TargetDatabase.
Return type:	oci.data_safe.models.TlsConfig