Skip to content

MongoDbDataProviderSettings

Source code in docs_src/capo_database_migration_service/types/mongo_db_data_provider_settings.py
class MongoDbDataProviderSettings(TypedDict, closed=True):
    server_name: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The name of the MongoDB server.</p>"""
    port: NotRequired[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ]
    """<p>The port value for the MongoDB data provider.</p>"""
    database_name: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The database name on the MongoDB data provider.</p>"""
    ssl_mode: NotRequired[
        "capo_database_migration_service.types.dms_ssl_mode_value.DmsSslModeValue"
    ]
    """<p>The SSL mode used to connect to the MongoDB data provider. The default value is <code>none</code>.</p>"""
    certificate_arn: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the certificate used for SSL connection.</p>"""
    auth_type: NotRequired[
        "capo_database_migration_service.types.auth_type_value.AuthTypeValue"
    ]
    """<p>The authentication type for the database connection. Valid values are PASSWORD or NO.</p>"""
    auth_source: NotRequired["capo_database_migration_service.types.string.String"]
    """<p> The MongoDB database name. This setting isn't used when <code>AuthType</code> is set to <code>"no"</code>. </p> <p>The default is <code>"admin"</code>.</p>"""
    auth_mechanism: NotRequired[
        "capo_database_migration_service.types.auth_mechanism_value.AuthMechanismValue"
    ]
    """<p>The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.</p>"""

auth_mechanism instance-attribute

auth_mechanism: NotRequired[AuthMechanismValue]

The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.

auth_source instance-attribute

auth_source: NotRequired[String]

The MongoDB database name. This setting isn't used when AuthType is set to "no".

The default is "admin".

auth_type instance-attribute

auth_type: NotRequired[AuthTypeValue]

The authentication type for the database connection. Valid values are PASSWORD or NO.

certificate_arn instance-attribute

certificate_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

database_name instance-attribute

database_name: NotRequired[String]

The database name on the MongoDB data provider.

port instance-attribute

port: NotRequired[IntegerOptional]

The port value for the MongoDB data provider.

server_name instance-attribute

server_name: NotRequired[String]

The name of the MongoDB server.

ssl_mode instance-attribute

ssl_mode: NotRequired[DmsSslModeValue]

The SSL mode used to connect to the MongoDB data provider. The default value is none.