Connection¶

class oci.database_migration.models.Connection(**kwargs)¶

Bases: object

Represents the common details required for creating a new connection.

Attributes

`CONNECTION_TYPE_MYSQL`	A constant which can be used with the connection_type property of a Connection.
`CONNECTION_TYPE_ORACLE`	A constant which can be used with the connection_type property of a Connection.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Connection.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Connection.
`compartment_id`	[Required] Gets the compartment_id of this Connection.
`connection_type`	[Required] Gets the connection_type of this Connection.
`defined_tags`	Gets the defined_tags of this Connection.
`description`	Gets the description of this Connection.
`display_name`	[Required] Gets the display_name of this Connection.
`freeform_tags`	Gets the freeform_tags of this Connection.
`id`	[Required] Gets the id of this Connection.
`ingress_ips`	Gets the ingress_ips of this Connection.
`key_id`	Gets the key_id of this Connection.
`lifecycle_details`	Gets the lifecycle_details of this Connection.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Connection.
`nsg_ids`	Gets the nsg_ids of this Connection.
`password`	Gets the password of this Connection.
`private_endpoint_id`	Gets the private_endpoint_id of this Connection.
`replication_password`	Gets the replication_password of this Connection.
`replication_username`	Gets the replication_username of this Connection.
`secret_id`	Gets the secret_id of this Connection.
`subnet_id`	Gets the subnet_id of this Connection.
`system_tags`	Gets the system_tags of this Connection.
`time_created`	[Required] Gets the time_created of this Connection.
`time_updated`	[Required] Gets the time_updated of this Connection.
`username`	[Required] Gets the username of this Connection.
`vault_id`	Gets the vault_id of this Connection.

Methods

`__init__`(**kwargs)	Initializes a new Connection 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.

CONNECTION_TYPE_MYSQL = 'MYSQL'¶: A constant which can be used with the connection_type property of a Connection. This constant has a value of “MYSQL”

CONNECTION_TYPE_ORACLE = 'ORACLE'¶: A constant which can be used with the connection_type property of a Connection. This constant has a value of “ORACLE”

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new Connection 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:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

connection_type (str) – The value to assign to the connection_type property of this Connection. Allowed values for this property are: “MYSQL”, “ORACLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
id (str) – The value to assign to the id property of this Connection.
display_name (str) – The value to assign to the display_name property of this Connection.
description (str) – The value to assign to the description property of this Connection.
compartment_id (str) – The value to assign to the compartment_id property of this Connection.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Connection.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Connection.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Connection.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Connection. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 Connection.
time_created (datetime) – The value to assign to the time_created property of this Connection.
time_updated (datetime) – The value to assign to the time_updated property of this Connection.
vault_id (str) – The value to assign to the vault_id property of this Connection.
key_id (str) – The value to assign to the key_id property of this Connection.
subnet_id (str) – The value to assign to the subnet_id property of this Connection.
ingress_ips (list[oci.database_migration.models.IngressIpDetails]) – The value to assign to the ingress_ips property of this Connection.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this Connection.
username (str) – The value to assign to the username property of this Connection.
password (str) – The value to assign to the password property of this Connection.
replication_username (str) – The value to assign to the replication_username property of this Connection.
replication_password (str) – The value to assign to the replication_password property of this Connection.
secret_id (str) – The value to assign to the secret_id property of this Connection.
private_endpoint_id (str) – The value to assign to the private_endpoint_id property of this Connection.

compartment_id¶

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

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

connection_type¶

[Required] Gets the connection_type of this Connection. Defines the type of connection. For example, ORACLE.

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

Returns:	The connection_type of this Connection.
Return type:	str

defined_tags¶

Gets the defined_tags of this Connection. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

description¶

Gets the description of this Connection. A user-friendly description. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

display_name¶

[Required] Gets the display_name of this Connection. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this Connection. The OCID of the connection being referenced.

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

ingress_ips¶

Gets the ingress_ips of this Connection. List of ingress IP addresses from where to connect to this connection’s privateIp.

Returns:	The ingress_ips of this Connection.
Return type:	list[oci.database_migration.models.IngressIpDetails]

key_id¶

Gets the key_id of this Connection. The OCID of the key used in cryptographic operations.

Returns:	The key_id of this Connection.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this Connection. The message describing the current state of the connection’s lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this Connection. The Connection’s current lifecycle state.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 Connection.
Return type:	str

nsg_ids¶

Gets the nsg_ids of this Connection. An array of Network Security Group OCIDs used to define network access for Connections.

Returns:	The nsg_ids of this Connection.
Return type:	list[str]

password¶

Gets the password of this Connection. The password (credential) used when creating or updating this resource.

Returns:	The password of this Connection.
Return type:	str

private_endpoint_id¶

Gets the private_endpoint_id of this Connection. The OCID of the resource being referenced.

Returns:	The private_endpoint_id of this Connection.
Return type:	str

replication_password¶

Gets the replication_password of this Connection. The password (credential) used when creating or updating this resource.

Returns:	The replication_password of this Connection.
Return type:	str

replication_username¶

Gets the replication_username of this Connection. The username (credential) used when creating or updating this resource.

Returns:	The replication_username of this Connection.
Return type:	str

secret_id¶

Gets the secret_id of this Connection. The OCID of the resource being referenced.

Returns:	The secret_id of this Connection.
Return type:	str

subnet_id¶

Gets the subnet_id of this Connection. OCI resource ID.

Returns:	The subnet_id of this Connection.
Return type:	str

system_tags¶

Gets the system_tags of this Connection. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

time_created¶

[Required] Gets the time_created of this Connection. The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

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

time_updated¶

[Required] Gets the time_updated of this Connection. The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

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

username¶

[Required] Gets the username of this Connection. The username (credential) used when creating or updating this resource.

Returns:	The username of this Connection.
Return type:	str

vault_id¶

Gets the vault_id of this Connection. OCI resource ID.

Returns:	The vault_id of this Connection.
Return type:	str