Interface CfnEndpoint.IMongoDbSettingsProperty
Provides information that defines a MongoDB endpoint.
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IMongoDbSettingsProperty
Syntax (vb)
Public Interface IMongoDbSettingsProperty
Remarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DMS;
var mongoDbSettingsProperty = new 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"
};
Synopsis
Properties
AuthMechanism | The authentication mechanism you use to access the MongoDB source endpoint. |
AuthSource | The MongoDB database name. This setting isn't used when |
AuthType | The authentication type you use to access the MongoDB source endpoint. |
DatabaseName | The database name on the MongoDB source endpoint. |
DocsToInvestigate | Indicates the number of documents to preview to determine the document organization. |
ExtractDocId | Specifies the document ID. Use this setting when |
NestingLevel | Specifies either document or table mode. |
Password | The password for the user account you use to access the MongoDB source endpoint. |
Port | The port value for the MongoDB source endpoint. |
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 |
SecretsManagerSecretId | The full ARN, partial ARN, or display name of the |
ServerName | The name of the server on the MongoDB source endpoint. |
Username | The user name you use to access the MongoDB source endpoint. |
Properties
AuthMechanism
The authentication mechanism you use to access the MongoDB source endpoint.
virtual string AuthMechanism { get; }
Property Value
System.String
Remarks
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"
.
AuthSource
The MongoDB database name. This setting isn't used when AuthType
is set to "no"
.
virtual string AuthSource { get; }
Property Value
System.String
Remarks
AuthType
The authentication type you use to access the MongoDB source endpoint.
virtual string AuthType { get; }
Property Value
System.String
Remarks
When set to "no"
, user name and password parameters are not used and can be empty.
DatabaseName
The database name on the MongoDB source endpoint.
virtual string DatabaseName { get; }
Property Value
System.String
Remarks
DocsToInvestigate
Indicates the number of documents to preview to determine the document organization.
virtual string DocsToInvestigate { get; }
Property Value
System.String
Remarks
Use this setting when NestingLevel
is set to "one"
.
Must be a positive value greater than 0
. Default value is 1000
.
ExtractDocId
Specifies the document ID. Use this setting when NestingLevel
is set to "none"
.
virtual string ExtractDocId { get; }
Property Value
System.String
Remarks
NestingLevel
Specifies either document or table mode.
virtual string NestingLevel { get; }
Property Value
System.String
Remarks
Default value is "none"
. Specify "none"
to use document mode. Specify "one"
to use table mode.
Password
The password for the user account you use to access the MongoDB source endpoint.
virtual string Password { get; }
Property Value
System.String
Remarks
Port
The port value for the MongoDB source endpoint.
virtual Nullable<double> Port { get; }
Property Value
System.Nullable<System.Double>
Remarks
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
.
virtual string SecretsManagerAccessRoleArn { get; }
Property Value
System.String
Remarks
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 .
SecretsManagerSecretId
The full ARN, partial ARN, or display name of the SecretsManagerSecret
that contains the MongoDB endpoint connection details.
virtual string SecretsManagerSecretId { get; }
Property Value
System.String
Remarks
ServerName
The name of the server on the MongoDB source endpoint.
virtual string ServerName { get; }
Property Value
System.String
Remarks
Username
The user name you use to access the MongoDB source endpoint.
virtual string Username { get; }
Property Value
System.String