Package software.amazon.awssdk.services.databasemigration.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MongoDbDataProviderSettings.Builder

Method Summary

Modifier and Type	Method	Description
AuthMechanismValue	authMechanism()	The authentication method for connecting to the data provider.
String	authMechanismAsString()	The authentication method for connecting to the data provider.
String	authSource()	The MongoDB database name.
AuthTypeValue	authType()	The authentication type for the database connection.
String	authTypeAsString()	The authentication type for the database connection.
static MongoDbDataProviderSettings.Builder	builder()
String	certificateArn()	The Amazon Resource Name (ARN) of the certificate used for SSL connection.
String	databaseName()	The database name on the MongoDB data provider.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	port()	The port value for the MongoDB data provider.
List<SdkField<?>>	sdkFields()
static Class<? extends MongoDbDataProviderSettings.Builder>	serializableBuilderClass()
String	serverName()	The name of the MongoDB server.
DmsSslModeValue	sslMode()	The SSL mode used to connect to the MongoDB data provider.
String	sslModeAsString()	The SSL mode used to connect to the MongoDB data provider.
MongoDbDataProviderSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

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:

DmsSslModeValue

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:

DmsSslModeValue

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:

AuthTypeValue

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:

AuthTypeValue

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:

AuthMechanismValue

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:

AuthMechanismValue

toBuilder

public MongoDbDataProviderSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MongoDbDataProviderSettings.Builder,MongoDbDataProviderSettings>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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