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

Interface RedisSettings.Builder

    • Method Detail

      • serverName

        RedisSettings.Builder serverName​(String serverName)

        Fully qualified domain name of the endpoint.

        Parameters:
        serverName - Fully qualified domain name of the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • port

        RedisSettings.Builder port​(Integer port)

        Transmission Control Protocol (TCP) port for the endpoint.

        Parameters:
        port - Transmission Control Protocol (TCP) port for the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sslSecurityProtocol

        RedisSettings.Builder sslSecurityProtocol​(String 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SslSecurityProtocolValue, SslSecurityProtocolValue

      • sslSecurityProtocol

        RedisSettings.Builder sslSecurityProtocol​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SslSecurityProtocolValue, SslSecurityProtocolValue

      • authType

        RedisSettings.Builder authType​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RedisAuthTypeValue, RedisAuthTypeValue

      • authType

        RedisSettings.Builder authType​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RedisAuthTypeValue, RedisAuthTypeValue

      • authUserName

        RedisSettings.Builder authUserName​(String authUserName)

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

        Parameters:
        authUserName - The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • authPassword

        RedisSettings.Builder authPassword​(String authPassword)

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

        Parameters:
        authPassword - The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sslCaCertificateArn

        RedisSettings.Builder sslCaCertificateArn​(String sslCaCertificateArn)

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

        Parameters:
        sslCaCertificateArn - The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.