Class DocDbSettings

java.lang.Object
software.amazon.awssdk.services.databasemigration.model.DocDbSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DocDbSettings.Builder,DocDbSettings>
@Generated("software.amazon.awssdk:codegen") public final class DocDbSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocDbSettings.Builder,DocDbSettings>

Provides information that defines a DocumentDB endpoint.

See Also:

  • Method Details

    • username

      public final String username()

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

      Returns:
      The user name you use to access the DocumentDB source endpoint.

    • password

      public final String password()

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

      Returns:
      The password for the user account you use to access the DocumentDB source endpoint.

    • serverName

      public final String serverName()

      The name of the server on the DocumentDB source endpoint.

      Returns:
      The name of the server on the DocumentDB source endpoint.

    • port

      public final Integer port()

      The port value for the DocumentDB source endpoint.

      Returns:
      The port value for the DocumentDB source endpoint.

    • databaseName

      public final String databaseName()

      The database name on the DocumentDB source endpoint.

      Returns:
      The database name on the DocumentDB source endpoint.

    • nestingLevel

      public final NestingLevelValue nestingLevel()

      Specifies either document or table mode.

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

      If the service returns an enum value that is not available in the current SDK version, nestingLevel will return NestingLevelValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nestingLevelAsString().

      Returns:
      Specifies either document or table mode.

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

      See Also:

    • nestingLevelAsString

      public final String nestingLevelAsString()

      Specifies either document or table mode.

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

      If the service returns an enum value that is not available in the current SDK version, nestingLevel will return NestingLevelValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nestingLevelAsString().

      Returns:
      Specifies either document or table mode.

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

      See Also:

    • extractDocId

      public final Boolean extractDocId()

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

      Default value is "false".

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

      Default value is "false".

    • docsToInvestigate

      public final Integer 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:
      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.

    • kmsKeyId

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

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

    • secretsManagerAccessRoleArn

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

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

    • secretsManagerSecretId

      public final String secretsManagerSecretId()

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

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

    • useUpdateLookUp

      public final Boolean 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.

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

    • replicateShardCollections

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

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

    • toBuilder

      public DocDbSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DocDbSettings.Builder,DocDbSettings>
      Returns:
      a builder for type T

    • builder

      public static DocDbSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DocDbSettings.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.