Package software.amazon.awscdk.services.dms

Interface CfnEndpoint.RedisSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.RedisSettingsProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

@Stability(Stable)
public static interface CfnEndpoint.RedisSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Provides information that defines a Redis target endpoint.

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 RedisSettingsProperty redisSettingsProperty = RedisSettingsProperty.builder()
         .authPassword("authPassword")
         .authType("authType")
         .authUserName("authUserName")
         .port(123)
         .serverName("serverName")
         .sslCaCertificateArn("sslCaCertificateArn")
         .sslSecurityProtocol("sslSecurityProtocol")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpoint.RedisSettingsProperty.Builder	A builder for CfnEndpoint.RedisSettingsProperty
static final class	CfnEndpoint.RedisSettingsProperty.Jsii$Proxy	An implementation for CfnEndpoint.RedisSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnEndpoint.RedisSettingsProperty.Builder	builder()
default String	getAuthPassword()	The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.
default String	getAuthType()	The type of authentication to perform when connecting to a Redis target.
default String	getAuthUserName()	The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.
default Number	getPort()	Transmission Control Protocol (TCP) port for the endpoint.
default String	getServerName()	Fully qualified domain name of the endpoint.
default String	getSslCaCertificateArn()	The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
default String	getSslSecurityProtocol()	The connection to a Redis target endpoint using Transport Layer Security (TLS).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthPassword

@Stability(Stable)
@Nullable
default String getAuthPassword()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-authpassword

getAuthType

@Stability(Stable)
@Nullable
default String getAuthType()

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-authtype

getAuthUserName

@Stability(Stable)
@Nullable
default String getAuthUserName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-authusername

getPort

@Stability(Stable)
@Nullable
default Number getPort()

Transmission Control Protocol (TCP) port for the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-port

getServerName

@Stability(Stable)
@Nullable
default String getServerName()

Fully qualified domain name of the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-servername

getSslCaCertificateArn

@Stability(Stable)
@Nullable
default String getSslCaCertificateArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-sslcacertificatearn

getSslSecurityProtocol

@Stability(Stable)
@Nullable
default String getSslSecurityProtocol()

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-sslsecurityprotocol

builder

@Stability(Stable)
static CfnEndpoint.RedisSettingsProperty.Builder builder()

Returns:

a CfnEndpoint.RedisSettingsProperty.Builder of CfnEndpoint.RedisSettingsProperty