Sign In to the Console
AWS CloudFormation
User Guide (Version )

AWS Documentation » AWS CloudFormation » User Guide » DMS Resource Type Reference » AWS::DMS::Endpoint » AWS::DMS::Endpoint MongoDbSettings

AWS::DMS::Endpoint MongoDbSettings

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

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

YAML

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

Properties

AuthMechanism

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

Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

DEFAULT – 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

Allowed Values: default | mongodb_cr | scram_sha_1

Update requires: No interruption

AuthSource

The MongoDB database name. This attribute is not used when authType=NO.

The default is admin.

Required: No

Type: String

Update requires: No interruption

AuthType

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

Allowed Values: no | password

Update requires: No interruption

DatabaseName

The database name on the MongoDB source endpoint.

Required: No

Type: String

Update requires: No interruption

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

Update requires: No interruption

ExtractDocId

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

Default value is false.

Required: No

Type: String

Update requires: No interruption

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

Allowed Values: none | one

Update requires: No interruption

Password

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

Required: No

Type: String

Update requires: No interruption

Port

The port value for the MongoDB source endpoint.

Required: No

Type: Integer

Update requires: No interruption

ServerName

The name of the server on the MongoDB source endpoint.

Required: No

Type: String

Update requires: No interruption

Username

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

Required: No

Type: String

Update requires: No interruption

On this page: