Class MongoDbDataProviderSettings
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<MongoDbDataProviderSettings.Builder,MongoDbDataProviderSettings>
Provides information that defines a MongoDB data provider.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AuthMechanismValueThe authentication method for connecting to the data provider.final StringThe authentication method for connecting to the data provider.final StringThe MongoDB database name.final AuthTypeValueauthType()The authentication type for the database connection.final StringThe authentication type for the database connection.builder()final StringThe Amazon Resource Name (ARN) of the certificate used for SSL connection.final StringThe database name on the MongoDB data provider.final booleanfinal booleanequalsBySdkFields(Object obj) final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final inthashCode()final Integerport()The port value for the MongoDB data provider.static Class<? extends MongoDbDataProviderSettings.Builder>final StringThe name of the MongoDB server.final DmsSslModeValuesslMode()The SSL mode used to connect to the MongoDB data provider.final StringThe SSL mode used to connect to the MongoDB data provider.final StringtoString()Returns a string representation of this object.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
serverName
The name of the MongoDB server.
- Returns:
- The name of the MongoDB server.
-
port
The port value for the MongoDB data provider.
- Returns:
- The port value for the MongoDB data provider.
-
databaseName
The database name on the MongoDB data provider.
- Returns:
- The database name on the MongoDB data provider.
-
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,
sslModewill returnDmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsslModeAsString().- Returns:
- The SSL mode used to connect to the MongoDB data provider. The default value is
none. - See Also:
-
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,
sslModewill returnDmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsslModeAsString().- Returns:
- The SSL mode used to connect to the MongoDB data provider. The default value is
none. - See Also:
-
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
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,
authTypewill returnAuthTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthTypeAsString().- Returns:
- The authentication type for the database connection. Valid values are PASSWORD or NO.
- See Also:
-
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,
authTypewill returnAuthTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthTypeAsString().- Returns:
- The authentication type for the database connection. Valid values are PASSWORD or NO.
- See Also:
-
authSource
The MongoDB database name. This setting isn't used when
AuthTypeis set to"no".The default is
"admin".- Returns:
- The MongoDB database name. This setting isn't used when
AuthTypeis set to"no".The default is
"admin".
-
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,
authMechanismwill returnAuthMechanismValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthMechanismAsString().- Returns:
- The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.
- See Also:
-
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,
authMechanismwill returnAuthMechanismValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthMechanismAsString().- Returns:
- The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.
- See Also:
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<MongoDbDataProviderSettings.Builder,MongoDbDataProviderSettings>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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. -
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-