Connection

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

Bases: object

Database Connection resource used for migrations.

Attributes

DATABASE_TYPE_AUTONOMOUS A constant which can be used with the database_type property of a Connection.
DATABASE_TYPE_MANUAL A constant which can be used with the database_type property of a Connection.
DATABASE_TYPE_USER_MANAGED_OCI A constant which can be used with the database_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.
admin_credentials Gets the admin_credentials of this Connection.
certificate_tdn Gets the certificate_tdn of this Connection.
compartment_id [Required] Gets the compartment_id of this Connection.
connect_descriptor Gets the connect_descriptor of this Connection.
credentials_secret_id Gets the credentials_secret_id of this Connection.
database_id Gets the database_id of this Connection.
database_type [Required] Gets the database_type of this Connection.
defined_tags Gets the defined_tags 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.
lifecycle_details Gets the lifecycle_details of this Connection.
lifecycle_state [Required] Gets the lifecycle_state of this Connection.
private_endpoint Gets the private_endpoint of this Connection.
ssh_details Gets the ssh_details of this Connection.
system_tags Gets the system_tags of this Connection.
time_created [Required] Gets the time_created of this Connection.
time_updated Gets the time_updated of this Connection.
vault_details Gets the vault_details of this Connection.

Methods

__init__(**kwargs) Initializes a new Connection object with values from keyword arguments.
DATABASE_TYPE_AUTONOMOUS = 'AUTONOMOUS'

A constant which can be used with the database_type property of a Connection. This constant has a value of “AUTONOMOUS”

DATABASE_TYPE_MANUAL = 'MANUAL'

A constant which can be used with the database_type property of a Connection. This constant has a value of “MANUAL”

DATABASE_TYPE_USER_MANAGED_OCI = 'USER_MANAGED_OCI'

A constant which can be used with the database_type property of a Connection. This constant has a value of “USER_MANAGED_OCI”

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. 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 Connection.
  • compartment_id (str) – The value to assign to the compartment_id property of this Connection.
  • database_type (str) – The value to assign to the database_type property of this Connection. Allowed values for this property are: “MANUAL”, “AUTONOMOUS”, “USER_MANAGED_OCI”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • display_name (str) – The value to assign to the display_name property of this Connection.
  • database_id (str) – The value to assign to the database_id property of this Connection.
  • connect_descriptor (oci.database_migration.models.ConnectDescriptor) – The value to assign to the connect_descriptor property of this Connection.
  • credentials_secret_id (str) – The value to assign to the credentials_secret_id property of this Connection.
  • certificate_tdn (str) – The value to assign to the certificate_tdn property of this Connection.
  • ssh_details (oci.database_migration.models.SshDetails) – The value to assign to the ssh_details property of this Connection.
  • admin_credentials (oci.database_migration.models.AdminCredentials) – The value to assign to the admin_credentials property of this Connection.
  • private_endpoint (oci.database_migration.models.PrivateEndpointDetails) – The value to assign to the private_endpoint property of this Connection.
  • vault_details (oci.database_migration.models.VaultDetails) – The value to assign to the vault_details 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.
  • 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.
admin_credentials

Gets the admin_credentials of this Connection.

Returns:The admin_credentials of this Connection.
Return type:oci.database_migration.models.AdminCredentials
certificate_tdn

Gets the certificate_tdn of this Connection. This name is the distinguished name used while creating the certificate on target database.

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

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

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

Gets the connect_descriptor of this Connection.

Returns:The connect_descriptor of this Connection.
Return type:oci.database_migration.models.ConnectDescriptor
credentials_secret_id

Gets the credentials_secret_id of this Connection. OCID of the Secret in the OCI vault containing the Database Connection credentials.

Returns:The credentials_secret_id of this Connection.
Return type:str
database_id

Gets the database_id of this Connection. The OCID of the cloud database.

Returns:The database_id of this Connection.
Return type:str
database_type

[Required] Gets the database_type of this Connection. Database connection type.

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

Returns:The database_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))
display_name

[Required] Gets the display_name of this Connection. Database Connection display name identifier.

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

Gets the freeform_tags of this Connection. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:The freeform_tags of this Connection.
Return type:dict(str, str)
id

[Required] Gets the id of this Connection. The OCID of the resource

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

Gets the lifecycle_details of this Connection. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

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

[Required] Gets the lifecycle_state of this Connection. The current state of the Connection resource.

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
private_endpoint

Gets the private_endpoint of this Connection.

Returns:The private_endpoint of this Connection.
Return type:oci.database_migration.models.PrivateEndpointDetails
ssh_details

Gets the ssh_details of this Connection.

Returns:The ssh_details of this Connection.
Return type:oci.database_migration.models.SshDetails
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 the Connection resource was created. An RFC3339 formatted datetime string.

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

Gets the time_updated of this Connection. The time of the last Connection resource details update. An RFC3339 formatted datetime string.

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

Gets the vault_details of this Connection.

Returns:The vault_details of this Connection.
Return type:oci.database_migration.models.VaultDetails