Class RedisSettings

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

Provides information that defines a Redis target endpoint.

See Also:

  • Method Details

    • serverName

      public final String serverName()

      Fully qualified domain name of the endpoint.

      Returns:
      Fully qualified domain name of the endpoint.

    • port

      public final Integer port()

      Transmission Control Protocol (TCP) port for the endpoint.

      Returns:
      Transmission Control Protocol (TCP) port for the endpoint.

    • sslSecurityProtocol

      public final SslSecurityProtocolValue sslSecurityProtocol()

      The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption. The default is ssl-encryption. The ssl-encryption option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the SslCaCertificateArn setting. If an ARN isn't given for a CA, DMS uses the Amazon root CA.

      The plaintext option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.

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

      Returns:
      The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption. The default is ssl-encryption. The ssl-encryption option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the SslCaCertificateArn setting. If an ARN isn't given for a CA, DMS uses the Amazon root CA.

      The plaintext option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.

      See Also:

    • sslSecurityProtocolAsString

      public final String sslSecurityProtocolAsString()

      The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption. The default is ssl-encryption. The ssl-encryption option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the SslCaCertificateArn setting. If an ARN isn't given for a CA, DMS uses the Amazon root CA.

      The plaintext option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.

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

      Returns:
      The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption. The default is ssl-encryption. The ssl-encryption option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the SslCaCertificateArn setting. If an ARN isn't given for a CA, DMS uses the Amazon root CA.

      The plaintext option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.

      See Also:

    • authType

      public final RedisAuthTypeValue authType()

      The type of authentication to perform when connecting to a Redis target. Options include none, auth-token, and auth-role. The auth-token option requires an AuthPassword value to be provided. The auth-role option requires AuthUserName and AuthPassword values to be provided.

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

      Returns:
      The type of authentication to perform when connecting to a Redis target. Options include none, auth-token, and auth-role. The auth-token option requires an AuthPassword value to be provided. The auth-role option requires AuthUserName and AuthPassword values to be provided.
      See Also:

    • authTypeAsString

      public final String authTypeAsString()

      The type of authentication to perform when connecting to a Redis target. Options include none, auth-token, and auth-role. The auth-token option requires an AuthPassword value to be provided. The auth-role option requires AuthUserName and AuthPassword values to be provided.

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

      Returns:
      The type of authentication to perform when connecting to a Redis target. Options include none, auth-token, and auth-role. The auth-token option requires an AuthPassword value to be provided. The auth-role option requires AuthUserName and AuthPassword values to be provided.
      See Also:

    • authUserName

      public final String authUserName()

      The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.

      Returns:
      The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.

    • authPassword

      public final String authPassword()

      The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.

      Returns:
      The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.

    • sslCaCertificateArn

      public final String sslCaCertificateArn()

      The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.

      Returns:
      The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.

    • toBuilder

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

    • builder

      public static RedisSettings.Builder builder()

    • serializableBuilderClass

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