AWS::DMS::Endpoint MongoDbSettings - AWS CloudFormation
SyntaxProperties

AWS::DMS::Endpoint MongoDbSettings

Provides information that defines a MongoDB endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see Endpoint configuration settings when using MongoDB as a source for AWS DMS in the AWS Database Migration Service User Guide.

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,
  "SecretsManagerAccessRoleArn" : String,
  "SecretsManagerSecretId" : String,
  "ServerName" : String,
  "Username" : String
}

YAML

  AuthMechanism: String
  AuthSource: String
  AuthType: String
  DatabaseName: String
  DocsToInvestigate: String
  ExtractDocId: String
  NestingLevel: String
  Password: String
  Port: Integer
  SecretsManagerAccessRoleArn: String
  SecretsManagerSecretId: String
  ServerName: String
  Username: 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 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

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

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

SecretsManagerAccessRoleArn

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the MongoDB endpoint.

Note

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both.

For more information on creating this SecretsManagerSecret, the corresponding SecretsManagerAccessRoleArn, and the SecretsManagerSecretId that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

Required: No

Type: String

Update requires: No interruption

SecretsManagerSecretId

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

Required: No

Type: String

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