Package software.amazon.awscdk.services.dms

Class CfnEndpoint.MongoDbSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.dms.CfnEndpoint.MongoDbSettingsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpoint.MongoDbSettingsProperty>

Enclosing interface:

CfnEndpoint.MongoDbSettingsProperty

@Stability(Stable)
public static final class CfnEndpoint.MongoDbSettingsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEndpoint.MongoDbSettingsProperty>

A builder for CfnEndpoint.MongoDbSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEndpoint.MongoDbSettingsProperty.Builder	authMechanism(String authMechanism)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getAuthMechanism()
CfnEndpoint.MongoDbSettingsProperty.Builder	authSource(String authSource)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getAuthSource()
CfnEndpoint.MongoDbSettingsProperty.Builder	authType(String authType)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getAuthType()
CfnEndpoint.MongoDbSettingsProperty	build()	Builds the configured instance.
CfnEndpoint.MongoDbSettingsProperty.Builder	databaseName(String databaseName)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getDatabaseName()
CfnEndpoint.MongoDbSettingsProperty.Builder	docsToInvestigate(String docsToInvestigate)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getDocsToInvestigate()
CfnEndpoint.MongoDbSettingsProperty.Builder	extractDocId(String extractDocId)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getExtractDocId()
CfnEndpoint.MongoDbSettingsProperty.Builder	nestingLevel(String nestingLevel)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getNestingLevel()
CfnEndpoint.MongoDbSettingsProperty.Builder	password(String password)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getPassword()
CfnEndpoint.MongoDbSettingsProperty.Builder	port(Number port)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getPort()
CfnEndpoint.MongoDbSettingsProperty.Builder	secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getSecretsManagerAccessRoleArn()
CfnEndpoint.MongoDbSettingsProperty.Builder	secretsManagerSecretId(String secretsManagerSecretId)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getSecretsManagerSecretId()
CfnEndpoint.MongoDbSettingsProperty.Builder	serverName(String serverName)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getServerName()
CfnEndpoint.MongoDbSettingsProperty.Builder	username(String username)	Sets the value of CfnEndpoint.MongoDbSettingsProperty.getUsername()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

authMechanism

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder authMechanism(String authMechanism)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getAuthMechanism()

Parameters:

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

Returns:

this

authSource

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder authSource(String authSource)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getAuthSource()

Parameters:

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

Returns:

this

authType

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder authType(String authType)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getAuthType()

Parameters:

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

Returns:

this

databaseName

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder databaseName(String databaseName)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getDatabaseName()

Parameters:

databaseName - The database name on the MongoDB source endpoint.

Returns:

this

docsToInvestigate

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder docsToInvestigate(String docsToInvestigate)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getDocsToInvestigate()

Parameters:

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

Returns:

this

extractDocId

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder extractDocId(String extractDocId)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getExtractDocId()

Parameters:

extractDocId - Specifies the document ID. Use this setting when NestingLevel is set to "none" . Default value is "false" .

Returns:

this

nestingLevel

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder nestingLevel(String nestingLevel)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getNestingLevel()

Parameters:

nestingLevel - Specifies either document or table mode. Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.

Returns:

this

password

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder password(String password)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getPassword()

Parameters:

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

Returns:

this

port

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder port(Number port)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getPort()

Parameters:

port - The port value for the MongoDB source endpoint.

Returns:

this

secretsManagerAccessRoleArn

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getSecretsManagerAccessRoleArn()

Parameters:

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

Returns:

this

secretsManagerSecretId

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder secretsManagerSecretId(String secretsManagerSecretId)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getSecretsManagerSecretId()

Parameters:

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

Returns:

this

serverName

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder serverName(String serverName)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getServerName()

Parameters:

serverName - The name of the server on the MongoDB source endpoint.

Returns:

this

username

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty.Builder username(String username)

Sets the value of CfnEndpoint.MongoDbSettingsProperty.getUsername()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnEndpoint.MongoDbSettingsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnEndpoint.MongoDbSettingsProperty>

Returns:

a new instance of CfnEndpoint.MongoDbSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided