MongoDbConnection¶

class oci.golden_gate.models.MongoDbConnection(**kwargs)¶

Bases: oci.golden_gate.models.connection.Connection

Represents the metadata of a MongoDB Connection.

Attributes

`CONNECTION_TYPE_AMAZON_KINESIS`	str(object=’’) -> str
`CONNECTION_TYPE_AMAZON_REDSHIFT`	str(object=’’) -> str
`CONNECTION_TYPE_AMAZON_S3`	str(object=’’) -> str
`CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS`	str(object=’’) -> str
`CONNECTION_TYPE_DB2`	str(object=’’) -> str
`CONNECTION_TYPE_ELASTICSEARCH`	str(object=’’) -> str
`CONNECTION_TYPE_GENERIC`	str(object=’’) -> str
`CONNECTION_TYPE_GOLDENGATE`	str(object=’’) -> str
`CONNECTION_TYPE_GOOGLE_BIGQUERY`	str(object=’’) -> str
`CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_HDFS`	str(object=’’) -> str
`CONNECTION_TYPE_JAVA_MESSAGE_SERVICE`	str(object=’’) -> str
`CONNECTION_TYPE_KAFKA`	str(object=’’) -> str
`CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY`	str(object=’’) -> str
`CONNECTION_TYPE_MICROSOFT_SQLSERVER`	str(object=’’) -> str
`CONNECTION_TYPE_MONGODB`	str(object=’’) -> str
`CONNECTION_TYPE_MYSQL`	str(object=’’) -> str
`CONNECTION_TYPE_OCI_OBJECT_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_ORACLE`	str(object=’’) -> str
`CONNECTION_TYPE_ORACLE_NOSQL`	str(object=’’) -> str
`CONNECTION_TYPE_POSTGRESQL`	str(object=’’) -> str
`CONNECTION_TYPE_REDIS`	str(object=’’) -> str
`CONNECTION_TYPE_SNOWFLAKE`	str(object=’’) -> str
`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_CREATING`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETING`	str(object=’’) -> str
`LIFECYCLE_STATE_FAILED`	str(object=’’) -> str
`LIFECYCLE_STATE_UPDATING`	str(object=’’) -> str
`ROUTING_METHOD_DEDICATED_ENDPOINT`	str(object=’’) -> str
`ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT`	str(object=’’) -> str
`ROUTING_METHOD_SHARED_SERVICE_ENDPOINT`	str(object=’’) -> str
`TECHNOLOGY_TYPE_AZURE_COSMOS_DB_FOR_MONGODB`	A constant which can be used with the technology_type property of a MongoDbConnection.
`TECHNOLOGY_TYPE_MONGODB`	A constant which can be used with the technology_type property of a MongoDbConnection.
`TECHNOLOGY_TYPE_OCI_AUTONOMOUS_JSON_DATABASE`	A constant which can be used with the technology_type property of a MongoDbConnection.
`compartment_id`	[Required] Gets the compartment_id of this Connection.
`connection_string`	Gets the connection_string of this MongoDbConnection.
`connection_type`	[Required] Gets the connection_type of this Connection.
`database_id`	Gets the database_id of this MongoDbConnection.
`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.
`does_use_secret_ids`	Gets the does_use_secret_ids 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.
`locks`	Gets the locks of this Connection.
`nsg_ids`	Gets the nsg_ids of this Connection.
`password_secret_id`	Gets the password_secret_id of this MongoDbConnection.
`routing_method`	Gets the routing_method of this Connection.
`subnet_id`	Gets the subnet_id of this Connection.
`system_tags`	Gets the system_tags of this Connection.
`technology_type`	[Required] Gets the technology_type of this MongoDbConnection.
`time_created`	[Required] Gets the time_created of this Connection.
`time_updated`	[Required] Gets the time_updated of this Connection.
`username`	Gets the username of this MongoDbConnection.
`vault_id`	Gets the vault_id of this Connection.

Methods

`__init__`(**kwargs)	Initializes a new MongoDbConnection 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_AMAZON_KINESIS = 'AMAZON_KINESIS'¶

CONNECTION_TYPE_AMAZON_REDSHIFT = 'AMAZON_REDSHIFT'¶

CONNECTION_TYPE_AMAZON_S3 = 'AMAZON_S3'¶

CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'¶

CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS = 'AZURE_SYNAPSE_ANALYTICS'¶

CONNECTION_TYPE_DB2 = 'DB2'¶

CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'¶

CONNECTION_TYPE_GENERIC = 'GENERIC'¶

CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'¶

CONNECTION_TYPE_GOOGLE_BIGQUERY = 'GOOGLE_BIGQUERY'¶

CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'¶

CONNECTION_TYPE_HDFS = 'HDFS'¶

CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'¶

CONNECTION_TYPE_KAFKA = 'KAFKA'¶

CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'¶

CONNECTION_TYPE_MICROSOFT_SQLSERVER = 'MICROSOFT_SQLSERVER'¶

CONNECTION_TYPE_MONGODB = 'MONGODB'¶

CONNECTION_TYPE_MYSQL = 'MYSQL'¶

CONNECTION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'¶

CONNECTION_TYPE_ORACLE = 'ORACLE'¶

CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'¶

CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'¶

CONNECTION_TYPE_REDIS = 'REDIS'¶

CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'¶

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_CREATING = 'CREATING'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_DELETING = 'DELETING'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶

ROUTING_METHOD_DEDICATED_ENDPOINT = 'DEDICATED_ENDPOINT'¶

ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT = 'SHARED_DEPLOYMENT_ENDPOINT'¶

ROUTING_METHOD_SHARED_SERVICE_ENDPOINT = 'SHARED_SERVICE_ENDPOINT'¶

TECHNOLOGY_TYPE_AZURE_COSMOS_DB_FOR_MONGODB = 'AZURE_COSMOS_DB_FOR_MONGODB'¶: A constant which can be used with the technology_type property of a MongoDbConnection. This constant has a value of “AZURE_COSMOS_DB_FOR_MONGODB”

TECHNOLOGY_TYPE_MONGODB = 'MONGODB'¶: A constant which can be used with the technology_type property of a MongoDbConnection. This constant has a value of “MONGODB”

TECHNOLOGY_TYPE_OCI_AUTONOMOUS_JSON_DATABASE = 'OCI_AUTONOMOUS_JSON_DATABASE'¶: A constant which can be used with the technology_type property of a MongoDbConnection. This constant has a value of “OCI_AUTONOMOUS_JSON_DATABASE”

__init__(**kwargs)¶

Initializes a new MongoDbConnection object with values from keyword arguments. The default value of the connection_type attribute of this class is MONGODB and it should not be changed. 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 MongoDbConnection. Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, ‘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 MongoDbConnection.
display_name (str) – The value to assign to the display_name property of this MongoDbConnection.
description (str) – The value to assign to the description property of this MongoDbConnection.
compartment_id (str) – The value to assign to the compartment_id property of this MongoDbConnection.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MongoDbConnection.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MongoDbConnection.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this MongoDbConnection.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MongoDbConnection. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 MongoDbConnection.
time_created (datetime) – The value to assign to the time_created property of this MongoDbConnection.
time_updated (datetime) – The value to assign to the time_updated property of this MongoDbConnection.
locks (list[oci.golden_gate.models.ResourceLock]) – The value to assign to the locks property of this MongoDbConnection.
vault_id (str) – The value to assign to the vault_id property of this MongoDbConnection.
key_id (str) – The value to assign to the key_id property of this MongoDbConnection.
ingress_ips (list[oci.golden_gate.models.IngressIpDetails]) – The value to assign to the ingress_ips property of this MongoDbConnection.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this MongoDbConnection.
subnet_id (str) – The value to assign to the subnet_id property of this MongoDbConnection.
routing_method (str) – The value to assign to the routing_method property of this MongoDbConnection. Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
does_use_secret_ids (bool) – The value to assign to the does_use_secret_ids property of this MongoDbConnection.
technology_type (str) – The value to assign to the technology_type property of this MongoDbConnection. Allowed values for this property are: “MONGODB”, “OCI_AUTONOMOUS_JSON_DATABASE”, “AZURE_COSMOS_DB_FOR_MONGODB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
connection_string (str) – The value to assign to the connection_string property of this MongoDbConnection.
username (str) – The value to assign to the username property of this MongoDbConnection.
database_id (str) – The value to assign to the database_id property of this MongoDbConnection.
password_secret_id (str) – The value to assign to the password_secret_id property of this MongoDbConnection.

compartment_id¶

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

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

connection_string¶

Gets the connection_string of this MongoDbConnection. MongoDB connection string. e.g.: ‘mongodb://mongodb0.example.com:27017/recordsrecords’

Returns:	The connection_string of this MongoDbConnection.
Return type:	str

connection_type¶

[Required] Gets the connection_type of this Connection. The connection type.

Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, ‘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

database_id¶

Gets the database_id of this MongoDbConnection. The OCID of the Oracle Autonomous Json Database.

Returns:	The database_id of this MongoDbConnection.
Return type:	str

defined_tags¶

Gets the defined_tags of this Connection. Tags defined 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. Metadata about this specific object.

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

display_name¶

[Required] Gets the display_name of this Connection. An object’s Display Name.

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

does_use_secret_ids¶

Gets the does_use_secret_ids of this Connection. Indicates that sensitive attributes are provided via Secrets.

Returns:	The does_use_secret_ids of this Connection.
Return type:	bool

freeform_tags¶

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

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 the GoldenGate deployment connects to this connection’s privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.

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

key_id¶

Gets the key_id of this Connection. Refers to the customer’s master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

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

lifecycle_details¶

Gets the lifecycle_details of this Connection. Describes the object’s current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this Connection. Possible lifecycle states for connection.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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

locks¶

Gets the locks of this Connection. Locks associated with this resource.

Returns:	The locks of this Connection.
Return type:	list[oci.golden_gate.models.ResourceLock]

nsg_ids¶

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

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

password_secret_id¶

Gets the password_secret_id of this MongoDbConnection. The OCID of the Secret that stores the password Oracle GoldenGate uses to connect the associated database. Note: When provided, ‘password’ field must not be provided.

Returns:	The password_secret_id of this MongoDbConnection.
Return type:	str

routing_method¶

Gets the routing_method of this Connection. Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service’s network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment’s private endpoint through the deployment’s subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

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

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

subnet_id¶

Gets the subnet_id of this Connection. The OCID of the target subnet of the dedicated connection.

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

system_tags¶

Gets the system_tags of this Connection. The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.

Example: {orcl-cloud: {free-tier-retain: true}}

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

technology_type¶

[Required] Gets the technology_type of this MongoDbConnection. The MongoDB technology type.

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

Returns:	The technology_type of this MongoDbConnection.
Return type:	str

time_created¶

[Required] Gets the time_created of this Connection. The time the resource was created. The format is defined by RFC3339, 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 the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

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

username¶

Gets the username of this MongoDbConnection. The username Oracle GoldenGate uses to connect to the database. This username must already exist and be available by the database to be connected to.

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

vault_id¶

Gets the vault_id of this Connection. Refers to the customer’s vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

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