Package software.amazon.awscdk.services.dms

Interface CfnDataProvider.MongoDbSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataProvider.MongoDbSettingsProperty.Jsii$Proxy

Enclosing class:

CfnDataProvider

@Stability(Stable)
public static interface CfnDataProvider.MongoDbSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Provides information that defines a MongoDB endpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 MongoDbSettingsProperty mongoDbSettingsProperty = MongoDbSettingsProperty.builder()
         .port(123)
         .serverName("serverName")
         // the properties below are optional
         .authMechanism("authMechanism")
         .authSource("authSource")
         .authType("authType")
         .certificateArn("certificateArn")
         .databaseName("databaseName")
         .sslMode("sslMode")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataProvider.MongoDbSettingsProperty.Builder	A builder for CfnDataProvider.MongoDbSettingsProperty
static final class	CfnDataProvider.MongoDbSettingsProperty.Jsii$Proxy	An implementation for CfnDataProvider.MongoDbSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataProvider.MongoDbSettingsProperty.Builder	builder()
default String	getAuthMechanism()	The authentication mechanism you use to access the MongoDB source endpoint.
default String	getAuthSource()	The MongoDB database name.
default String	getAuthType()	The authentication type you use to access the MongoDB source endpoint.
default String	getCertificateArn()
default String	getDatabaseName()	The database name on the MongoDB source endpoint.
Number	getPort()	The port value for the MongoDB source endpoint.
String	getServerName()	The name of the server on the MongoDB source endpoint.
default String	getSslMode()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPort

@Stability(Stable)
@NotNull
Number getPort()

The port value for the MongoDB source endpoint.

See Also:

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

getServerName

@Stability(Stable)
@NotNull
String getServerName()

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.

See Also:

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

getAuthMechanism

@Stability(Stable)
@Nullable
default String getAuthMechanism()

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

See Also:

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

getAuthSource

@Stability(Stable)
@Nullable
default String getAuthSource()

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

The default is "admin" .

See Also:

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

getAuthType

@Stability(Stable)
@Nullable
default String getAuthType()

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.

See Also:

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

getCertificateArn

@Stability(Stable)
@Nullable
default String getCertificateArn()

See Also:

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

getDatabaseName

@Stability(Stable)
@Nullable
default String getDatabaseName()

The database name on the MongoDB source endpoint.

See Also:

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

getSslMode

@Stability(Stable)
@Nullable
default String getSslMode()

See Also:

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

builder

@Stability(Stable)
static CfnDataProvider.MongoDbSettingsProperty.Builder builder()

Returns:

a CfnDataProvider.MongoDbSettingsProperty.Builder of CfnDataProvider.MongoDbSettingsProperty