Interface RedisSettings.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<RedisSettings.Builder,
,RedisSettings> SdkBuilder<RedisSettings.Builder,
,RedisSettings> SdkPojo
- Enclosing class:
RedisSettings
-
Method Summary
Modifier and TypeMethodDescriptionauthPassword
(String authPassword) The password provided with theauth-role
andauth-token
options of theAuthType
setting for a Redis target endpoint.The type of authentication to perform when connecting to a Redis target.authType
(RedisAuthTypeValue authType) The type of authentication to perform when connecting to a Redis target.authUserName
(String authUserName) The user name provided with theauth-role
option of theAuthType
setting for a Redis target endpoint.Transmission Control Protocol (TCP) port for the endpoint.serverName
(String serverName) Fully qualified domain name of the endpoint.sslCaCertificateArn
(String sslCaCertificateArn) The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.sslSecurityProtocol
(String sslSecurityProtocol) The connection to a Redis target endpoint using Transport Layer Security (TLS).sslSecurityProtocol
(SslSecurityProtocolValue sslSecurityProtocol) The connection to a Redis target endpoint using Transport Layer Security (TLS).Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include
plaintext
andssl-encryption
. The default isssl-encryption
. Thessl-encryption
option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using theSslCaCertificateArn
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 includeplaintext
andssl-encryption
. The default isssl-encryption
. Thessl-encryption
option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using theSslCaCertificateArn
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:
-
sslSecurityProtocol
The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include
plaintext
andssl-encryption
. The default isssl-encryption
. Thessl-encryption
option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using theSslCaCertificateArn
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 includeplaintext
andssl-encryption
. The default isssl-encryption
. Thessl-encryption
option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using theSslCaCertificateArn
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:
-
authType
The type of authentication to perform when connecting to a Redis target. Options include
none
,auth-token
, andauth-role
. Theauth-token
option requires anAuthPassword
value to be provided. Theauth-role
option requiresAuthUserName
andAuthPassword
values to be provided.- Parameters:
authType
- The type of authentication to perform when connecting to a Redis target. Options includenone
,auth-token
, andauth-role
. Theauth-token
option requires anAuthPassword
value to be provided. Theauth-role
option requiresAuthUserName
andAuthPassword
values to be provided.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authType
The type of authentication to perform when connecting to a Redis target. Options include
none
,auth-token
, andauth-role
. Theauth-token
option requires anAuthPassword
value to be provided. Theauth-role
option requiresAuthUserName
andAuthPassword
values to be provided.- Parameters:
authType
- The type of authentication to perform when connecting to a Redis target. Options includenone
,auth-token
, andauth-role
. Theauth-token
option requires anAuthPassword
value to be provided. Theauth-role
option requiresAuthUserName
andAuthPassword
values to be provided.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authUserName
The user name provided with the
auth-role
option of theAuthType
setting for a Redis target endpoint.- Parameters:
authUserName
- The user name provided with theauth-role
option of theAuthType
setting for a Redis target endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authPassword
The password provided with the
auth-role
andauth-token
options of theAuthType
setting for a Redis target endpoint.- Parameters:
authPassword
- The password provided with theauth-role
andauth-token
options of theAuthType
setting for a Redis target endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-