com.amazonaws.services.databasemigrationservice.model.DocDbSettings Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dms Show documentation
/*
* Copyright 2019-2024 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 DocumentDB endpoint.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DocDbSettings implements Serializable, Cloneable, StructuredPojo {
/**
*
* The user name you use to access the DocumentDB source endpoint.
*
*/
private String username;
/**
*
* The password for the user account you use to access the DocumentDB source endpoint.
*
*/
private String password;
/**
*
* The name of the server on the DocumentDB source endpoint.
*
*/
private String serverName;
/**
*
* The port value for the DocumentDB source endpoint.
*
*/
private Integer port;
/**
*
* The database name on the DocumentDB source endpoint.
*
*/
private String databaseName;
/**
*
* Specifies either document or table mode.
*
*
* Default value is "none". Specify "none" to use document mode. Specify
* "one" to use table mode.
*
*/
private String nestingLevel;
/**
*
* Specifies the document ID. Use this setting when NestingLevel is set to "none".
*
*
* Default value is "false".
*
*/
private Boolean extractDocId;
/**
*
* 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.
*
*/
private Integer docsToInvestigate;
/**
*
* 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.
*
*/
private String kmsKeyId;
/**
*
* 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 DocumentDB 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.
*
*
*/
private String secretsManagerAccessRoleArn;
/**
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB
* endpoint connection details.
*
*/
private String secretsManagerSecretId;
/**
*
* If true, DMS retrieves the entire document from the DocumentDB 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.
*
*/
private Boolean 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.
*
*
*
*/
private Boolean replicateShardCollections;
/**
*
* The user name you use to access the DocumentDB source endpoint.
*
*
* @param username
* The user name you use to access the DocumentDB source endpoint.
*/
public void setUsername(String username) {
this.username = username;
}
/**
*
* The user name you use to access the DocumentDB source endpoint.
*
*
* @return The user name you use to access the DocumentDB source endpoint.
*/
public String getUsername() {
return this.username;
}
/**
*
* The user name you use to access the DocumentDB source endpoint.
*
*
* @param username
* The user name you use to access the DocumentDB source endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocDbSettings withUsername(String username) {
setUsername(username);
return this;
}
/**
*
* The password for the user account you use to access the DocumentDB source endpoint.
*
*
* @param password
* The password for the user account you use to access the DocumentDB source endpoint.
*/
public void setPassword(String password) {
this.password = password;
}
/**
*
* The password for the user account you use to access the DocumentDB source endpoint.
*
*
* @return The password for the user account you use to access the DocumentDB source endpoint.
*/
public String getPassword() {
return this.password;
}
/**
*
* The password for the user account you use to access the DocumentDB source endpoint.
*
*
* @param password
* The password for the user account you use to access the DocumentDB source endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocDbSettings withPassword(String password) {
setPassword(password);
return this;
}
/**
*
* The name of the server on the DocumentDB source endpoint.
*
*
* @param serverName
* The name of the server on the DocumentDB source endpoint.
*/
public void setServerName(String serverName) {
this.serverName = serverName;
}
/**
*
* The name of the server on the DocumentDB source endpoint.
*
*
* @return The name of the server on the DocumentDB source endpoint.
*/
public String getServerName() {
return this.serverName;
}
/**
*
* The name of the server on the DocumentDB source endpoint.
*
*
* @param serverName
* The name of the server on the DocumentDB source endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocDbSettings withServerName(String serverName) {
setServerName(serverName);
return this;
}
/**
*
* The port value for the DocumentDB source endpoint.
*
*
* @param port
* The port value for the DocumentDB source endpoint.
*/
public void setPort(Integer port) {
this.port = port;
}
/**
*
* The port value for the DocumentDB source endpoint.
*
*
* @return The port value for the DocumentDB source endpoint.
*/
public Integer getPort() {
return this.port;
}
/**
*
* The port value for the DocumentDB source endpoint.
*
*
* @param port
* The port value for the DocumentDB source endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocDbSettings withPort(Integer port) {
setPort(port);
return this;
}
/**
*
* The database name on the DocumentDB source endpoint.
*
*
* @param databaseName
* The database name on the DocumentDB source endpoint.
*/
public void setDatabaseName(String databaseName) {
this.databaseName = databaseName;
}
/**
*
* The database name on the DocumentDB source endpoint.
*
*
* @return The database name on the DocumentDB source endpoint.
*/
public String getDatabaseName() {
return this.databaseName;
}
/**
*
* The database name on the DocumentDB source endpoint.
*
*
* @param databaseName
* The database name on the DocumentDB source endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocDbSettings withDatabaseName(String databaseName) {
setDatabaseName(databaseName);
return this;
}
/**
*
* Specifies either document or table mode.
*
*
* Default value is "none". Specify "none" to use document mode. Specify
* "one" to use table mode.
*
*
* @param nestingLevel
* Specifies either document or 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.
*
*
* @return Specifies either document or 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.
*
*
* @param nestingLevel
* Specifies either document or 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 DocDbSettings 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.
*
*
* @param nestingLevel
* Specifies either document or 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 DocDbSettings 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".
*
*
* @param extractDocId
* Specifies the document ID. Use this setting when NestingLevel is set to "none".
*
*
* Default value is "false".
*/
public void setExtractDocId(Boolean extractDocId) {
this.extractDocId = extractDocId;
}
/**
*
* Specifies the document ID. Use this setting when NestingLevel is set to "none".
*
*
* Default value is "false".
*
*
* @return Specifies the document ID. Use this setting when NestingLevel is set to "none".
*
*
* Default value is "false".
*/
public Boolean getExtractDocId() {
return this.extractDocId;
}
/**
*
* Specifies the document ID. Use this setting when NestingLevel is set to "none".
*
*
* Default value is "false".
*
*
* @param extractDocId
* Specifies the document ID. Use this setting when 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 DocDbSettings withExtractDocId(Boolean extractDocId) {
setExtractDocId(extractDocId);
return this;
}
/**
*
* Specifies the document ID. Use this setting when NestingLevel is set to "none".
*
*
* Default value is "false".
*
*
* @return Specifies the document ID. Use this setting when NestingLevel is set to "none".
*
*
* Default value is "false".
*/
public Boolean isExtractDocId() {
return this.extractDocId;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setDocsToInvestigate(Integer 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.
*
*
* @return 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.
*/
public Integer 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocDbSettings withDocsToInvestigate(Integer docsToInvestigate) {
setDocsToInvestigate(docsToInvestigate);
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.
*
*
* @param 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.
*/
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.
*
*
* @return 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.
*/
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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocDbSettings 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 DocumentDB 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.
*
*
*
* @param 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 DocumentDB 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.
*
*/
public void setSecretsManagerAccessRoleArn(String secretsManagerAccessRoleArn) {
this.secretsManagerAccessRoleArn = 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 DocumentDB 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.
*
*
*
* @return 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 DocumentDB 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.
*
*/
public String getSecretsManagerAccessRoleArn() {
return this.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 DocumentDB 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.
*
*
*
* @param 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 DocumentDB 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocDbSettings withSecretsManagerAccessRoleArn(String secretsManagerAccessRoleArn) {
setSecretsManagerAccessRoleArn(secretsManagerAccessRoleArn);
return this;
}
/**
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB
* endpoint connection details.
*
*
* @param secretsManagerSecretId
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the
* DocumentDB 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 DocumentDB
* endpoint connection details.
*
*
* @return The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the
* DocumentDB endpoint connection details.
*/
public String getSecretsManagerSecretId() {
return this.secretsManagerSecretId;
}
/**
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB
* endpoint connection details.
*
*
* @param secretsManagerSecretId
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the
* DocumentDB endpoint connection details.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocDbSettings withSecretsManagerSecretId(String secretsManagerSecretId) {
setSecretsManagerSecretId(secretsManagerSecretId);
return this;
}
/**
*
* If true, DMS retrieves the entire document from the DocumentDB 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.
*
*
* @param useUpdateLookUp
* If true, DMS retrieves the entire document from the DocumentDB 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 DocumentDB 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 If true, DMS retrieves the entire document from the DocumentDB 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 DocumentDB 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.
*
*
* @param useUpdateLookUp
* If true, DMS retrieves the entire document from the DocumentDB 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 DocDbSettings withUseUpdateLookUp(Boolean useUpdateLookUp) {
setUseUpdateLookUp(useUpdateLookUp);
return this;
}
/**
*
* If true, DMS retrieves the entire document from the DocumentDB 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 If true, DMS retrieves the entire document from the DocumentDB 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.
*
*
*
*
* @param 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.
*
*
*/
public void setReplicateShardCollections(Boolean replicateShardCollections) {
this.replicateShardCollections = 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.
*
*
*
*
* @return 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.
*
*
*/
public Boolean getReplicateShardCollections() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocDbSettings withReplicateShardCollections(Boolean replicateShardCollections) {
setReplicateShardCollections(replicateShardCollections);
return this;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
*/
public Boolean isReplicateShardCollections() {
return this.replicateShardCollections;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getUsername() != null)
sb.append("Username: ").append(getUsername()).append(",");
if (getPassword() != null)
sb.append("Password: ").append("***Sensitive Data Redacted***").append(",");
if (getServerName() != null)
sb.append("ServerName: ").append(getServerName()).append(",");
if (getPort() != null)
sb.append("Port: ").append(getPort()).append(",");
if (getDatabaseName() != null)
sb.append("DatabaseName: ").append(getDatabaseName()).append(",");
if (getNestingLevel() != null)
sb.append("NestingLevel: ").append(getNestingLevel()).append(",");
if (getExtractDocId() != null)
sb.append("ExtractDocId: ").append(getExtractDocId()).append(",");
if (getDocsToInvestigate() != null)
sb.append("DocsToInvestigate: ").append(getDocsToInvestigate()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getSecretsManagerAccessRoleArn() != null)
sb.append("SecretsManagerAccessRoleArn: ").append(getSecretsManagerAccessRoleArn()).append(",");
if (getSecretsManagerSecretId() != null)
sb.append("SecretsManagerSecretId: ").append(getSecretsManagerSecretId()).append(",");
if (getUseUpdateLookUp() != null)
sb.append("UseUpdateLookUp: ").append(getUseUpdateLookUp()).append(",");
if (getReplicateShardCollections() != null)
sb.append("ReplicateShardCollections: ").append(getReplicateShardCollections());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DocDbSettings == false)
return false;
DocDbSettings other = (DocDbSettings) obj;
if (other.getUsername() == null ^ this.getUsername() == null)
return false;
if (other.getUsername() != null && other.getUsername().equals(this.getUsername()) == false)
return false;
if (other.getPassword() == null ^ this.getPassword() == null)
return false;
if (other.getPassword() != null && other.getPassword().equals(this.getPassword()) == false)
return false;
if (other.getServerName() == null ^ this.getServerName() == null)
return false;
if (other.getServerName() != null && other.getServerName().equals(this.getServerName()) == false)
return false;
if (other.getPort() == null ^ this.getPort() == null)
return false;
if (other.getPort() != null && other.getPort().equals(this.getPort()) == false)
return false;
if (other.getDatabaseName() == null ^ this.getDatabaseName() == null)
return false;
if (other.getDatabaseName() != null && other.getDatabaseName().equals(this.getDatabaseName()) == false)
return false;
if (other.getNestingLevel() == null ^ this.getNestingLevel() == null)
return false;
if (other.getNestingLevel() != null && other.getNestingLevel().equals(this.getNestingLevel()) == false)
return false;
if (other.getExtractDocId() == null ^ this.getExtractDocId() == null)
return false;
if (other.getExtractDocId() != null && other.getExtractDocId().equals(this.getExtractDocId()) == false)
return false;
if (other.getDocsToInvestigate() == null ^ this.getDocsToInvestigate() == null)
return false;
if (other.getDocsToInvestigate() != null && other.getDocsToInvestigate().equals(this.getDocsToInvestigate()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
if (other.getSecretsManagerAccessRoleArn() == null ^ this.getSecretsManagerAccessRoleArn() == null)
return false;
if (other.getSecretsManagerAccessRoleArn() != null && other.getSecretsManagerAccessRoleArn().equals(this.getSecretsManagerAccessRoleArn()) == false)
return false;
if (other.getSecretsManagerSecretId() == null ^ this.getSecretsManagerSecretId() == null)
return false;
if (other.getSecretsManagerSecretId() != null && other.getSecretsManagerSecretId().equals(this.getSecretsManagerSecretId()) == false)
return false;
if (other.getUseUpdateLookUp() == null ^ this.getUseUpdateLookUp() == null)
return false;
if (other.getUseUpdateLookUp() != null && other.getUseUpdateLookUp().equals(this.getUseUpdateLookUp()) == false)
return false;
if (other.getReplicateShardCollections() == null ^ this.getReplicateShardCollections() == null)
return false;
if (other.getReplicateShardCollections() != null && other.getReplicateShardCollections().equals(this.getReplicateShardCollections()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUsername() == null) ? 0 : getUsername().hashCode());
hashCode = prime * hashCode + ((getPassword() == null) ? 0 : getPassword().hashCode());
hashCode = prime * hashCode + ((getServerName() == null) ? 0 : getServerName().hashCode());
hashCode = prime * hashCode + ((getPort() == null) ? 0 : getPort().hashCode());
hashCode = prime * hashCode + ((getDatabaseName() == null) ? 0 : getDatabaseName().hashCode());
hashCode = prime * hashCode + ((getNestingLevel() == null) ? 0 : getNestingLevel().hashCode());
hashCode = prime * hashCode + ((getExtractDocId() == null) ? 0 : getExtractDocId().hashCode());
hashCode = prime * hashCode + ((getDocsToInvestigate() == null) ? 0 : getDocsToInvestigate().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getSecretsManagerAccessRoleArn() == null) ? 0 : getSecretsManagerAccessRoleArn().hashCode());
hashCode = prime * hashCode + ((getSecretsManagerSecretId() == null) ? 0 : getSecretsManagerSecretId().hashCode());
hashCode = prime * hashCode + ((getUseUpdateLookUp() == null) ? 0 : getUseUpdateLookUp().hashCode());
hashCode = prime * hashCode + ((getReplicateShardCollections() == null) ? 0 : getReplicateShardCollections().hashCode());
return hashCode;
}
@Override
public DocDbSettings clone() {
try {
return (DocDbSettings) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.databasemigrationservice.model.transform.DocDbSettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}