Interface CfnDataProvider.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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html

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 {
    Port = 123,
    ServerName = "serverName",

    // the properties below are optional
    AuthMechanism = "authMechanism",
    AuthSource = "authSource",
    AuthType = "authType",
    CertificateArn = "certificateArn",
    DatabaseName = "databaseName",
    SslMode = "sslMode"
};

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 is set to "no" .
AuthType

The authentication type you use to access the MongoDB source endpoint.
CertificateArn
DatabaseName

The database name on the MongoDB source endpoint.
Port

The port value for the MongoDB source endpoint.
ServerName

The name of the server on the MongoDB source endpoint.
SslMode

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-authmechanism

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

The default is "admin" .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-authsource

AuthType

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

virtual string AuthType { get; }
Property Value

System.String

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-authtype

CertificateArn

virtual string CertificateArn { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-certificatearn

DatabaseName

The database name on the MongoDB source endpoint.

virtual string DatabaseName { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-databasename

Port

The port value for the MongoDB source endpoint.

double Port { get; }
Property Value

System.Double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-port

ServerName

The name of the server on the MongoDB source endpoint.

string ServerName { get; }
Property Value

System.String

Remarks

For MongoDB Atlas, provide the server name for any of the servers in the replication set.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-servername

SslMode

virtual string SslMode { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mongodbsettings.html#cfn-dms-dataprovider-mongodbsettings-sslmode