MongoDbSettings

Gets and sets the property AuthMechanism.

The authentication mechanism you use to access the MongoDB source endpoint.

For the default value, in MongoDB version 2.x, "default" is "mongodb_cr". For MongoDB version 3.x or later, "default" is "scram_sha_1". This setting isn't used when AuthType is set to "no".

Gets and sets the property AuthSource.

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

The default is "admin".

Gets and sets the property AuthType.

The authentication type you use to access the MongoDB source endpoint.

When when set to "no", user name and password parameters are not used and can be empty.

Gets and sets the property DatabaseName.

The database name on the MongoDB source endpoint.

Gets and sets the property DocsToInvestigate.

Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".

Must be a positive value greater than 0. Default value is 1000.

Gets and sets the property ExtractDocId.

Specifies the document ID. Use this setting when NestingLevel is set to "none".

Default value is "false".

Gets and sets the property KmsKeyId.

The KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

Gets and sets the property NestingLevel.

Specifies either document or table mode.

Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode.

Gets and sets the property Password.

The password for the user account you use to access the MongoDB source endpoint.

Gets and sets the property Port.

The port value for the MongoDB source endpoint.

Gets and sets the property ReplicateShardCollections.

If true, DMS replicates data to shard collections. DMS only uses this setting if the target endpoint is a DocumentDB elastic cluster.

When this setting is true, note the following:

• You must set TargetTablePrepMode to nothing.

• DMS automatically sets useUpdateLookup to false.

Gets and sets the property SecretsManagerAccessRoleArn.

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MongoDB endpoint.

Gets and sets the property SecretsManagerSecretId.

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.

Gets and sets the property ServerName.

The name of the server on the MongoDB source endpoint. For MongoDB Atlas, provide the server name for any of the servers in the replication set.

Gets and sets the property Username.

The user name you use to access the MongoDB source endpoint.

Gets and sets the property UseUpdateLookUp.

If true, DMS retrieves the entire document from the MongoDB source during migration. This may cause a migration failure if the server response exceeds bandwidth limits. To fetch only updates and deletes during migration, set this parameter to false.