Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS Database Migration Service Resource Types Reference » AWS::DMS::Endpoint » AWS DMS Endpoint MongoDbSettings

AWS DMS Endpoint MongoDbSettings

Use the MongoDbSettings property to specify settings for a MongoDB endpoint for a AWS::DMS::Endpoint resource.

Syntax

JSON

{
  "AuthMechanism" : String,
  "AuthSource" : String,
  "DatabaseName" : String,
  "DocsToInvestigate" : String,
  "ExtractDocId" : String,
  "KmsKeyId" : String,
  "NestingLevel" : String,
  "Password" : String,
  "Port" : Integer,
  "ServerName" : String,
  "Username" : String
}

YAML


AuthMechanism: String
AuthSource: String
DatabaseName: String
DocsToInvestigate: String
ExtractDocId: String
KmsKeyId: String
NestingLevel: String
Password: String
Port: String
ServerName: String
Username: String

Properties

For more information about option settings, see Using a MongoDB Database as a Source for AWS Database Migration Service in the AWS Database Migration Service User Guide

AuthMechanism

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

Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.

Required: No

Type: String

AuthSource

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

Valid values: NO, PASSWORD

When NO is selected, user name and password parameters are not used and can be empty.

Required: No

Type: String

DatabaseName

The database name on the MongoDB source endpoint.

Required: No

Type: String

DocsToInvestigate

Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.

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

Required: No

Type: String

ExtractDocId

Specifies the document ID. Use this attribute when NestingLevel is set to NONE. Default value is false.

Required: No

Type: String

KmsKeyId

The ID of the KMS key to be used.

Required: No

Type: String

NestingLevel

Specifies either document or table mode.

Valid values: NONE, ONE

Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.

Required: No

Type: String

Password

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

Required: No

Type: String

Port

The port value for the MongoDB source endpoint.

Required: No

Type: Integer

ServerName

The name of the server on the MongoDB source endpoint.

Required: No

Type: String

Username

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

Required: No

Type: String

On this page: