AWS::DMS::DataProvider MongoDbSettings - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::DMS::DataProvider MongoDbSettings

Provides information that defines a MongoDB endpoint.

Syntax

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

JSON

{
  "AuthMechanism" : String,
  "AuthSource" : String,
  "AuthType" : String,
  "CertificateArn" : String,
  "DatabaseName" : String,
  "Port" : Integer,
  "ServerName" : String,
  "SslMode" : String
}

YAML

  AuthMechanism: String
  AuthSource: String
  AuthType: String
  CertificateArn: String
  DatabaseName: String
  Port: Integer
  ServerName: String
  SslMode: String

Properties

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

Required: No

Type: String

Allowed values: default | mongodb_cr | scram_sha_1

Update requires: No interruption

AuthSource

The MongoDB database name. This setting isn't used when AuthType is set to "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.

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

Required: No

Type: String

Allowed values: no | password

Update requires: No interruption

CertificateArn

Property description not available.

Required: No

Type: String

Update requires: No interruption

DatabaseName

The database name on the MongoDB source endpoint.

Required: No

Type: String

Update requires: No interruption

Port

The port value for the MongoDB source endpoint.

Required: Yes

Type: Integer

Update requires: No interruption

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.

Required: Yes

Type: String

Update requires: No interruption

SslMode

Property description not available.

Required: No

Type: String

Allowed values: none | require | verify-full

Update requires: No interruption