MongoDbSettings - AWS Database Migration Service

MongoDbSettings

Provides information that defines a MongoDB endpoint.

Contents

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".

Type: String

Valid Values: default | mongodb_cr | scram_sha_1

Required: No

AuthSource

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

The default is "admin".

Type: String

Required: No

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.

Type: String

Valid Values: no | password

Required: No

DatabaseName

The database name on the MongoDB source endpoint.

Type: String

Required: No

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.

Type: String

Required: No

ExtractDocId

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

Default value is "false".

Type: String

Required: No

KmsKeyId

The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Type: String

Required: No

NestingLevel

Specifies either document or table mode.

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

Type: String

Valid Values: none | one

Required: No

Password

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

Type: String

Required: No

Port

The port value for the MongoDB source endpoint.

Type: Integer

Required: No

ServerName

The name of the server on the MongoDB source endpoint.

Type: String

Required: No

Username

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: