models.mongo_db_connect_params module

class models.mongo_db_connect_params.MongoDBConnectParams(auth_type=None, authenticating_database_name=None, requires_ssl=None, secondary_node_tag=None, seeds=None, use_secondary_for_backup=None)

Bases: object

Implementation of the ‘MongoDBConnectParams’ model.

Specifies an Object containing information about a registered mongodb source.

Attributes:

auth_type (AuthTypeMongoDBConnectParamsEnum): Specifies whether

authentication is configured on this MongoDB cluster. Specifies the type of an MongoDB source entity. ‘SCRAM’ ‘LDAP’ ‘NONE’ ‘KERBEROS’

authenticating_database_name (string): Specifies the Authenticating

Database for this MongoDB cluster.

requires_ssl (bool): Specifies whether connection is allowed through

SSL only in this cluster.

secondary_node_tag (string): MongoDB Secondary node tag. Required only

if ‘useSecondaryForBackup’ is true. The system will use this to identify the secondary nodes for reading backup data.

seeds (list of string): Specifies the seeds of this MongoDB Cluster. use_secondary_for_backup (bool): Set this to true if you want the

system to peform backups from secondary nodes.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.