software.amazon.awssdk.services.databasemigration.model

Interface MongoDbSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<MongoDbSettings.Builder,MongoDbSettings>, SdkBuilder<MongoDbSettings.Builder,MongoDbSettings>, SdkPojo

Enclosing class:

MongoDbSettings

public static interface MongoDbSettings.Builder
extends SdkPojo, CopyableBuilder<MongoDbSettings.Builder,MongoDbSettings>

Method Summary

Modifier and Type	Method and Description
MongoDbSettings.Builder	authMechanism(AuthMechanismValue authMechanism) The authentication mechanism you use to access the MongoDB source endpoint.
MongoDbSettings.Builder	authMechanism(String authMechanism) The authentication mechanism you use to access the MongoDB source endpoint.
MongoDbSettings.Builder	authSource(String authSource) The MongoDB database name.
MongoDbSettings.Builder	authType(AuthTypeValue authType) The authentication type you use to access the MongoDB source endpoint.
MongoDbSettings.Builder	authType(String authType) The authentication type you use to access the MongoDB source endpoint.
MongoDbSettings.Builder	databaseName(String databaseName) The database name on the MongoDB source endpoint.
MongoDbSettings.Builder	docsToInvestigate(String docsToInvestigate) Indicates the number of documents to preview to determine the document organization.
MongoDbSettings.Builder	extractDocId(String extractDocId) Specifies the document ID.
MongoDbSettings.Builder	kmsKeyId(String kmsKeyId) The KMS key identifier that is used to encrypt the content on the replication instance.
MongoDbSettings.Builder	nestingLevel(NestingLevelValue nestingLevel) Specifies either document or table mode.
MongoDbSettings.Builder	nestingLevel(String nestingLevel) Specifies either document or table mode.
MongoDbSettings.Builder	password(String password) The password for the user account you use to access the MongoDB source endpoint.
MongoDbSettings.Builder	port(Integer port) The port value for the MongoDB source endpoint.
MongoDbSettings.Builder	replicateShardCollections(Boolean replicateShardCollections) If true, DMS replicates data to shard collections.
MongoDbSettings.Builder	secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn) The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
MongoDbSettings.Builder	secretsManagerSecretId(String secretsManagerSecretId) The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
MongoDbSettings.Builder	serverName(String serverName) The name of the server on the MongoDB source endpoint.
MongoDbSettings.Builder	username(String username) The user name you use to access the MongoDB source endpoint.
MongoDbSettings.Builder	useUpdateLookUp(Boolean useUpdateLookUp) If true, DMS retrieves the entire document from the MongoDB source during migration.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

username

MongoDbSettings.Builder username(String username)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

password

MongoDbSettings.Builder password(String password)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

serverName

MongoDbSettings.Builder serverName(String serverName)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

port

MongoDbSettings.Builder port(Integer port)

The port value for the MongoDB source endpoint.

Parameters:

port - The port value for the MongoDB source endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

databaseName

MongoDbSettings.Builder databaseName(String databaseName)

The database name on the MongoDB source endpoint.

Parameters:

databaseName - The database name on the MongoDB source endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

authType

MongoDbSettings.Builder authType(String authType)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthTypeValue, AuthTypeValue

authType

MongoDbSettings.Builder authType(AuthTypeValue authType)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthTypeValue, AuthTypeValue

authMechanism

MongoDbSettings.Builder authMechanism(String 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".

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthMechanismValue, AuthMechanismValue

authMechanism

MongoDbSettings.Builder authMechanism(AuthMechanismValue 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".

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthMechanismValue, AuthMechanismValue

nestingLevel

MongoDbSettings.Builder nestingLevel(String nestingLevel)

Specifies either document or table mode.

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

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

NestingLevelValue, NestingLevelValue

nestingLevel

MongoDbSettings.Builder nestingLevel(NestingLevelValue nestingLevel)

Specifies either document or table mode.

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

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

NestingLevelValue, NestingLevelValue

extractDocId

MongoDbSettings.Builder extractDocId(String extractDocId)

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

Default value is "false".

Parameters:

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

Default value is "false".

Returns:

Returns a reference to this object so that method calls can be chained together.

docsToInvestigate

MongoDbSettings.Builder docsToInvestigate(String 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.

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:

Returns a reference to this object so that method calls can be chained together.

authSource

MongoDbSettings.Builder authSource(String authSource)

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

The default is "admin".

Parameters:

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

The default is "admin".

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

MongoDbSettings.Builder kmsKeyId(String kmsKeyId)

The KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

Parameters:

kmsKeyId - The KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

Returns:

Returns a reference to this object so that method calls can be chained together.

secretsManagerAccessRoleArn

MongoDbSettings.Builder secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)

The full Amazon Resource Name (ARN) of the IAM role that specifies 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 Amazon Web Services 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 and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

Parameters:

secretsManagerAccessRoleArn - The full Amazon Resource Name (ARN) of the IAM role that specifies 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 Amazon Web Services 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 and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

secretsManagerSecretId

MongoDbSettings.Builder secretsManagerSecretId(String secretsManagerSecretId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

useUpdateLookUp

MongoDbSettings.Builder useUpdateLookUp(Boolean useUpdateLookUp)

If true, DMS retrieves the entire document from the MongoDB source during migration. This may cause a migration failure if the server response exceeds bandwidth limits. To fetch only updates and deletes during migration, set this parameter to false.

Parameters:

useUpdateLookUp - If true, DMS retrieves the entire document from the MongoDB source during migration. This may cause a migration failure if the server response exceeds bandwidth limits. To fetch only updates and deletes during migration, set this parameter to false.

Returns:

Returns a reference to this object so that method calls can be chained together.

replicateShardCollections

MongoDbSettings.Builder replicateShardCollections(Boolean replicateShardCollections)

If true, DMS replicates data to shard collections. DMS only uses this setting if the target endpoint is a DocumentDB elastic cluster.

When this setting is true, note the following:

• You must set TargetTablePrepMode to nothing.

• DMS automatically sets useUpdateLookup to false.

Parameters:

replicateShardCollections - If true, DMS replicates data to shard collections. DMS only uses this setting if the target endpoint is a DocumentDB elastic cluster.

When this setting is true, note the following:

• You must set TargetTablePrepMode to nothing.

• DMS automatically sets useUpdateLookup to false.

Returns:

Returns a reference to this object so that method calls can be chained together.