Class MongoDbDataProviderSettings

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

Provides information that defines a MongoDB data provider.

See Also:

  • Method Details

    • serverName

      public final String serverName()

      The name of the MongoDB server.

      Returns:
      The name of the MongoDB server.

    • port

      public final Integer port()

      The port value for the MongoDB data provider.

      Returns:
      The port value for the MongoDB data provider.

    • databaseName

      public final String databaseName()

      The database name on the MongoDB data provider.

      Returns:
      The database name on the MongoDB data provider.

    • sslMode

      public final DmsSslModeValue sslMode()

      The SSL mode used to connect to the MongoDB data provider. The default value is none.

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

      Returns:
      The SSL mode used to connect to the MongoDB data provider. The default value is none.
      See Also:

    • sslModeAsString

      public final String sslModeAsString()

      The SSL mode used to connect to the MongoDB data provider. The default value is none.

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

      Returns:
      The SSL mode used to connect to the MongoDB data provider. The default value is none.
      See Also:

    • certificateArn

      public final String certificateArn()

      The Amazon Resource Name (ARN) of the certificate used for SSL connection.

      Returns:
      The Amazon Resource Name (ARN) of the certificate used for SSL connection.

    • authType

      public final AuthTypeValue authType()

      The authentication type for the database connection. Valid values are PASSWORD or NO.

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

      Returns:
      The authentication type for the database connection. Valid values are PASSWORD or NO.
      See Also:

    • authTypeAsString

      public final String authTypeAsString()

      The authentication type for the database connection. Valid values are PASSWORD or NO.

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

      Returns:
      The authentication type for the database connection. Valid values are PASSWORD or NO.
      See Also:

    • authSource

      public final String authSource()

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

      The default is "admin".

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

      The default is "admin".

    • authMechanism

      public final AuthMechanismValue authMechanism()

      The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.

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

      Returns:
      The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.
      See Also:

    • authMechanismAsString

      public final String authMechanismAsString()

      The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.

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

      Returns:
      The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.
      See Also:

    • toBuilder

      public MongoDbDataProviderSettings.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<MongoDbDataProviderSettings.Builder,MongoDbDataProviderSettings>
      Returns:
      a builder for type T

    • builder

      public static MongoDbDataProviderSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MongoDbDataProviderSettings.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.