models_v2.register_mongo_db_source_request_parameters module

class models_v2.register_mongo_db_source_request_parameters.RegisterMongoDBSourceRequestParameters(hosts=None, auth_type=None, is_ssl_required=None, use_secondary_for_backup=None, username=None, password=None, authenticating_database=None, secondary_node_tag=None)[source]

Bases: object

Implementation of the ‘Register MongoDB source request parameters.’ model.

Specifies parameters to register MongoDB source.

Attributes:
hosts (list of string): Specify the MongoS hosts for a sharded cluster

and the MongoD hosts for a non-sharded cluster. You can specify a sub-set of the hosts.

auth_type (AuthType3Enum): MongoDB authentication type. username (string): Specifies the username of the MongoDB cluster.

Should be set if ‘authType’ is ‘LDAP’ or ‘SCRAM’.

password (string): Specifies the password for the MongoDB cluster.

Should be set if ‘authType’ is ‘LDAP’ or ‘SCRAM’.

authenticating_database (string): Authenticating Database for this

cluster. Should be set if ‘authType’ is ‘LDAP’ or ‘SCRAM’.

is_ssl_required (bool): Set to true if connection to MongoDB has to be

over SSL.

use_secondary_for_backup (bool): Set this to true if you want the

system to peform backups from secondary nodes.

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.

classmethod from_dictionary(dictionary)[source]

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.