Package software.amazon.awscdk.services.dms

Class CfnEndpoint.MongoDbSettingsProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.dms.CfnEndpoint.MongoDbSettingsProperty.Jsii$Proxy

All Implemented Interfaces:

CfnEndpoint.MongoDbSettingsProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnEndpoint.MongoDbSettingsProperty

@Stability(Stable)
@Internal
public static final class CfnEndpoint.MongoDbSettingsProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnEndpoint.MongoDbSettingsProperty

An implementation for CfnEndpoint.MongoDbSettingsProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.dms.CfnEndpoint.MongoDbSettingsProperty

CfnEndpoint.MongoDbSettingsProperty.Builder, CfnEndpoint.MongoDbSettingsProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnEndpoint.MongoDbSettingsProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnEndpoint.MongoDbSettingsProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAuthMechanism()	The authentication mechanism you use to access the MongoDB source endpoint.
final String	getAuthSource()	The MongoDB database name.
final String	getAuthType()	The authentication type you use to access the MongoDB source endpoint.
final String	getDatabaseName()	The database name on the MongoDB source endpoint.
final String	getDocsToInvestigate()	Indicates the number of documents to preview to determine the document organization.
final String	getExtractDocId()	Specifies the document ID.
final String	getNestingLevel()	Specifies either document or table mode.
final String	getPassword()	The password for the user account you use to access the MongoDB source endpoint.
final Number	getPort()	The port value for the MongoDB source endpoint.
final 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 .
final String	getSecretsManagerSecretId()	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
final String	getServerName()	The name of the server on the MongoDB source endpoint.
final String	getUsername()	The user name you use to access the MongoDB source endpoint.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnEndpoint.MongoDbSettingsProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnEndpoint.MongoDbSettingsProperty.Builder.

Method Details

getAuthMechanism

public final String getAuthMechanism()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

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

Specified by:

getAuthMechanism in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

getAuthSource

public final String getAuthSource()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

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

The default is "admin" .

Specified by:

getAuthSource in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

getAuthType

public final String getAuthType()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

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.

Specified by:

getAuthType in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

getDatabaseName

public final String getDatabaseName()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

The database name on the MongoDB source endpoint.

Specified by:

getDatabaseName in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

getDocsToInvestigate

public final String getDocsToInvestigate()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

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 .

Specified by:

getDocsToInvestigate in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

getExtractDocId

public final String getExtractDocId()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

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

Default value is "false" .

Specified by:

getExtractDocId in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

getNestingLevel

public final String getNestingLevel()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

Specifies either document or table mode.

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

Specified by:

getNestingLevel in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

getPassword

public final String getPassword()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

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

Specified by:

getPassword in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

getPort

public final Number getPort()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

The port value for the MongoDB source endpoint.

Specified by:

getPort in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

getSecretsManagerAccessRoleArn

public final String getSecretsManagerAccessRoleArn()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

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 .

Specified by:

getSecretsManagerAccessRoleArn in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

getSecretsManagerSecretId

public final String getSecretsManagerSecretId()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

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

Specified by:

getSecretsManagerSecretId in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

getServerName

public final String getServerName()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

The name of the server on the MongoDB source endpoint.

Specified by:

getServerName in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

getUsername

public final String getUsername()

Description copied from interface: CfnEndpoint.MongoDbSettingsProperty

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

Specified by:

getUsername in interface CfnEndpoint.MongoDbSettingsProperty

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object