Package software.amazon.awscdk.services.dms

Interface CfnEndpoint.MongoDbSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.MongoDbSettingsProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

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

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 .

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()
         .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")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEndpoint.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	getDatabaseName()	The database name on the MongoDB source endpoint.
default String	getDocsToInvestigate()	Indicates the number of documents to preview to determine the document organization.
default String	getExtractDocId()	Specifies the document ID.
default String	getNestingLevel()	Specifies either document or table mode.
default String	getPassword()	The password for the user account you use to access the MongoDB source endpoint.
default Number	getPort()	The port value for the MongoDB source endpoint.
default String	getSecretsManagerAccessRoleArn()	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 .
default String	getSecretsManagerSecretId()	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
default String	getServerName()	The name of the server on the MongoDB source endpoint.
default String	getUsername()	The user name you use to access the MongoDB source endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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-endpoint-mongodbsettings.html#cfn-dms-endpoint-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-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authsource

getAuthType

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

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.

See Also:

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

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-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-databasename

getDocsToInvestigate

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

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 .

See Also:

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

getExtractDocId

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

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

Default value is "false" .

See Also:

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

getNestingLevel

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

Specifies either document or table mode.

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

See Also:

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

getPassword

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

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

See Also:

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

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The port value for the MongoDB source endpoint.

See Also:

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

getSecretsManagerAccessRoleArn

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

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.

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 .

See Also:

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

getSecretsManagerSecretId

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

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

See Also:

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

getServerName

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

The name of the server on the MongoDB source endpoint.

See Also:

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

getUsername

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

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

See Also:

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

builder

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

Returns:

a CfnEndpoint.MongoDbSettingsProperty.Builder of CfnEndpoint.MongoDbSettingsProperty