aws-cdk-lib.aws_dms.CfnEndpoint.MongoDbSettingsProperty

MongoDbSettingsProperty Struct

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 .

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const mongoDbSettingsProperty: dms.CfnEndpoint.MongoDbSettingsProperty = {
  authMechanism: 'authMechanism',
  authSource: 'authSource',
  authType: 'authType',
  databaseName: 'databaseName',
  docsToInvestigate: 'docsToInvestigate',
  extractDocId: 'extractDocId',
  nestingLevel: 'nestingLevel',
  password: 'password',
  port: 123,
  secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
  secretsManagerSecretId: 'secretsManagerSecretId',
  serverName: 'serverName',
  username: 'username',
};

Properties

authMechanismstringauth_mechanismstrauthMechanismStringAuthMechanismstringAuthMechanism*string#

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

authSourcestringauth_sourcestrauthSourceStringAuthSourcestringAuthSource*string#

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

The default is "admin" .

authTypestringauth_typestrauthTypeStringAuthTypestringAuthType*string#

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.

databaseNamestringdatabase_namestrdatabaseNameStringDatabaseNamestringDatabaseName*string#

The database name on the MongoDB source endpoint.

docsToInvestigatestringdocs_to_investigatestrdocsToInvestigateStringDocsToInvestigatestringDocsToInvestigate*string#

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 .

extractDocIdstringextract_doc_idstrextractDocIdStringExtractDocIdstringExtractDocId*string#

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

Default value is "false" .

nestingLevelstringnesting_levelstrnestingLevelStringNestingLevelstringNestingLevel*string#

Specifies either document or table mode.

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

passwordstringpasswordstrpasswordStringPasswordstringPassword*string#

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

portnumberportint | floatportNumberPortdoublePort*float64#

The port value for the MongoDB source endpoint.

secretsManagerAccessRoleArnstringsecrets_manager_access_role_arnstrsecretsManagerAccessRoleArnStringSecretsManagerAccessRoleArnstringSecretsManagerAccessRoleArn*string#

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

notes

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.

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 .

secretsManagerSecretIdstringsecrets_manager_secret_idstrsecretsManagerSecretIdStringSecretsManagerSecretIdstringSecretsManagerSecretId*string#

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

serverNamestringserver_namestrserverNameStringServerNamestringServerName*string#

The name of the server on the MongoDB source endpoint.

usernamestringusernamestrusernameStringUsernamestringUsername*string#

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