/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.databasemigrationservice.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Provides information that defines a MongoDB endpoint. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class MongoDbSettings implements Serializable, Cloneable, StructuredPojo { /** ** The user name you use to access the MongoDB source endpoint. *
*/ private String username; /** ** The password for the user account you use to access the MongoDB source endpoint. *
*/ private String password; /** ** The name of the server on the MongoDB source endpoint. *
*/ private String serverName; /** ** The port value for the MongoDB source endpoint. *
*/ private Integer port; /** ** The database name on the MongoDB source endpoint. *
*/ private String databaseName; /** ** 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.
*
* 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"
.
*
* Specifies either document or table mode. *
*
* Default value is "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
*
* Specifies the document ID. Use this setting when NestingLevel
is set to "none"
.
*
* Default value is "false"
.
*
* 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
.
*
* The MongoDB database name. This setting isn't used when AuthType
is set to "no"
.
*
* The default is "admin"
.
*
* 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.
*
* 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.
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the MongoDB
* endpoint connection details.
*
* 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
.
*
* 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
.
*
* The user name you use to access the MongoDB source endpoint. *
* * @param username * The user name you use to access the MongoDB source endpoint. */ public void setUsername(String username) { this.username = username; } /** ** The user name you use to access the MongoDB source endpoint. *
* * @return The user name you use to access the MongoDB source endpoint. */ public String getUsername() { return this.username; } /** ** The user name you use to access the MongoDB source endpoint. *
* * @param username * The user name you use to access the MongoDB source endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public MongoDbSettings withUsername(String username) { setUsername(username); return this; } /** ** The password for the user account you use to access the MongoDB source endpoint. *
* * @param password * The password for the user account you use to access the MongoDB source endpoint. */ public void setPassword(String password) { this.password = password; } /** ** The password for the user account you use to access the MongoDB source endpoint. *
* * @return The password for the user account you use to access the MongoDB source endpoint. */ public String getPassword() { return this.password; } /** ** The password for the user account you use to access the MongoDB source endpoint. *
* * @param password * The password for the user account you use to access the MongoDB source endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public MongoDbSettings withPassword(String password) { setPassword(password); return this; } /** ** The name of the server on the MongoDB source endpoint. *
* * @param serverName * The name of the server on the MongoDB source endpoint. */ public void setServerName(String serverName) { this.serverName = serverName; } /** ** The name of the server on the MongoDB source endpoint. *
* * @return The name of the server on the MongoDB source endpoint. */ public String getServerName() { return this.serverName; } /** ** The name of the server on the MongoDB source endpoint. *
* * @param serverName * The name of the server on the MongoDB source endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public MongoDbSettings withServerName(String serverName) { setServerName(serverName); return this; } /** ** The port value for the MongoDB source endpoint. *
* * @param port * The port value for the MongoDB source endpoint. */ public void setPort(Integer port) { this.port = port; } /** ** The port value for the MongoDB source endpoint. *
* * @return The port value for the MongoDB source endpoint. */ public Integer getPort() { return this.port; } /** ** The port value for the MongoDB source endpoint. *
* * @param port * The port value for the MongoDB source endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public MongoDbSettings withPort(Integer port) { setPort(port); return this; } /** ** The database name on the MongoDB source endpoint. *
* * @param databaseName * The database name on the MongoDB source endpoint. */ public void setDatabaseName(String databaseName) { this.databaseName = databaseName; } /** ** The database name on the MongoDB source endpoint. *
* * @return The database name on the MongoDB source endpoint. */ public String getDatabaseName() { return this.databaseName; } /** ** The database name on the MongoDB source endpoint. *
* * @param databaseName * The database name on the MongoDB source endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public MongoDbSettings withDatabaseName(String databaseName) { setDatabaseName(databaseName); return this; } /** ** 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.
*
* When when set to "no"
, user name and password parameters are not used and can be empty.
* @see AuthTypeValue
*/
public void setAuthType(String authType) {
this.authType = 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.
*
* When when set to "no"
, user name and password parameters are not used and can be empty.
* @see AuthTypeValue
*/
public String getAuthType() {
return this.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.
*
* When when set to "no"
, user name and password parameters are not used and can be empty.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthTypeValue
*/
public MongoDbSettings withAuthType(String authType) {
setAuthType(authType);
return this;
}
/**
*
* 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.
*
* When when set to "no"
, user name and password parameters are not used and can be empty.
* @see AuthTypeValue
*/
public void setAuthType(AuthTypeValue authType) {
withAuthType(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.
*
* When when set to "no"
, user name and password parameters are not used and can be empty.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthTypeValue
*/
public MongoDbSettings withAuthType(AuthTypeValue authType) {
this.authType = authType.toString();
return this;
}
/**
*
* 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"
.
*
* 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 AuthMechanismValue
*/
public void setAuthMechanism(String authMechanism) {
this.authMechanism = 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"
.
*
* 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 AuthMechanismValue
*/
public String getAuthMechanism() {
return this.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"
.
*
* 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"
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthMechanismValue
*/
public MongoDbSettings withAuthMechanism(String authMechanism) {
setAuthMechanism(authMechanism);
return this;
}
/**
*
* 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"
.
*
* 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 AuthMechanismValue
*/
public void setAuthMechanism(AuthMechanismValue authMechanism) {
withAuthMechanism(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"
.
*
* 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"
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthMechanismValue
*/
public MongoDbSettings withAuthMechanism(AuthMechanismValue authMechanism) {
this.authMechanism = authMechanism.toString();
return this;
}
/**
*
* Specifies either document or table mode. *
*
* Default value is "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
*
* Default value is "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
* @see NestingLevelValue
*/
public void setNestingLevel(String nestingLevel) {
this.nestingLevel = nestingLevel;
}
/**
*
* Specifies either document or table mode. *
*
* Default value is "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
*
* Default value is "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
* @see NestingLevelValue
*/
public String getNestingLevel() {
return this.nestingLevel;
}
/**
*
* Specifies either document or table mode. *
*
* Default value is "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
*
* Default value is "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NestingLevelValue
*/
public MongoDbSettings withNestingLevel(String nestingLevel) {
setNestingLevel(nestingLevel);
return this;
}
/**
*
* Specifies either document or table mode. *
*
* Default value is "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
*
* Default value is "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
* @see NestingLevelValue
*/
public void setNestingLevel(NestingLevelValue nestingLevel) {
withNestingLevel(nestingLevel);
}
/**
*
* Specifies either document or table mode. *
*
* Default value is "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
*
* Default value is "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NestingLevelValue
*/
public MongoDbSettings withNestingLevel(NestingLevelValue nestingLevel) {
this.nestingLevel = nestingLevel.toString();
return this;
}
/**
*
* Specifies the document ID. Use this setting when NestingLevel
is set to "none"
.
*
* Default value is "false"
.
*
NestingLevel
is set to "none"
.
*
*
* Default value is "false"
.
*/
public void setExtractDocId(String extractDocId) {
this.extractDocId = extractDocId;
}
/**
*
* Specifies the document ID. Use this setting when NestingLevel
is set to "none"
.
*
* Default value is "false"
.
*
NestingLevel
is set to "none"
.
*
*
* Default value is "false"
.
*/
public String getExtractDocId() {
return this.extractDocId;
}
/**
*
* Specifies the document ID. Use this setting when NestingLevel
is set to "none"
.
*
* Default value is "false"
.
*
NestingLevel
is set to "none"
.
*
*
* Default value is "false"
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MongoDbSettings withExtractDocId(String extractDocId) {
setExtractDocId(extractDocId);
return this;
}
/**
*
* 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
.
*
NestingLevel
is set to "one"
.
*
* Must be a positive value greater than 0
. Default value is 1000
.
*/
public void setDocsToInvestigate(String docsToInvestigate) {
this.docsToInvestigate = 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
.
*
NestingLevel
is set to "one"
.
*
* Must be a positive value greater than 0
. Default value is 1000
.
*/
public String getDocsToInvestigate() {
return this.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
.
*
NestingLevel
is set to "one"
.
*
* Must be a positive value greater than 0
. Default value is 1000
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MongoDbSettings withDocsToInvestigate(String docsToInvestigate) {
setDocsToInvestigate(docsToInvestigate);
return this;
}
/**
*
* The MongoDB database name. This setting isn't used when AuthType
is set to "no"
.
*
* The default is "admin"
.
*
AuthType
is set to "no"
.
*
*
* The default is "admin"
.
*/
public void setAuthSource(String authSource) {
this.authSource = authSource;
}
/**
*
* The MongoDB database name. This setting isn't used when AuthType
is set to "no"
.
*
* The default is "admin"
.
*
AuthType
is set to "no"
* .
*
* The default is "admin"
.
*/
public String getAuthSource() {
return this.authSource;
}
/**
*
* The MongoDB database name. This setting isn't used when AuthType
is set to "no"
.
*
* The default is "admin"
.
*
AuthType
is set to "no"
.
*
*
* The default is "admin"
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MongoDbSettings withAuthSource(String authSource) {
setAuthSource(authSource);
return this;
}
/**
*
* 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.
*
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.
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = 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.
*
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.
*/
public String getKmsKeyId() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MongoDbSettings withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* 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.
*
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.
*
* 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.
*
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.
*
* 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.
*
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.
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the MongoDB
* endpoint connection details.
*
SecretsManagerSecret
that contains the
* MongoDB endpoint connection details.
*/
public void setSecretsManagerSecretId(String secretsManagerSecretId) {
this.secretsManagerSecretId = secretsManagerSecretId;
}
/**
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the MongoDB
* endpoint connection details.
*
SecretsManagerSecret
that contains the
* MongoDB endpoint connection details.
*/
public String getSecretsManagerSecretId() {
return this.secretsManagerSecretId;
}
/**
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the MongoDB
* endpoint connection details.
*
SecretsManagerSecret
that contains the
* MongoDB endpoint connection details.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MongoDbSettings withSecretsManagerSecretId(String secretsManagerSecretId) {
setSecretsManagerSecretId(secretsManagerSecretId);
return this;
}
/**
*
* 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
.
*
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
.
*/
public void setUseUpdateLookUp(Boolean useUpdateLookUp) {
this.useUpdateLookUp = 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
.
*
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
.
*/
public Boolean getUseUpdateLookUp() {
return this.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
.
*
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
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MongoDbSettings withUseUpdateLookUp(Boolean useUpdateLookUp) {
setUseUpdateLookUp(useUpdateLookUp);
return this;
}
/**
*
* 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
.
*
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
.
*/
public Boolean isUseUpdateLookUp() {
return this.useUpdateLookUp;
}
/**
*
* 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
.
*
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
.
*
* 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
.
*
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
.
*
* 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
.
*
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
.
*
* 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
.
*
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
.
*