Class CfnEndpoint.RedisSettingsProperty
Provides information that defines a Redis target endpoint.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.AWS.DMS.dll
Syntax (csharp)
public class RedisSettingsProperty : Object, CfnEndpoint.IRedisSettingsProperty
Syntax (vb)
Public Class RedisSettingsProperty
Inherits Object
Implements CfnEndpoint.IRedisSettingsProperty
Remarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DMS;
var redisSettingsProperty = new RedisSettingsProperty {
AuthPassword = "authPassword",
AuthType = "authType",
AuthUserName = "authUserName",
Port = 123,
ServerName = "serverName",
SslCaCertificateArn = "sslCaCertificateArn",
SslSecurityProtocol = "sslSecurityProtocol"
};
Synopsis
Constructors
RedisSettingsProperty() |
Properties
AuthPassword | The password provided with the |
AuthType | The type of authentication to perform when connecting to a Redis target. |
AuthUserName | The user name provided with the |
Port | Transmission Control Protocol (TCP) port for the endpoint. |
ServerName | Fully qualified domain name of the endpoint. |
SslCaCertificateArn | The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint. |
SslSecurityProtocol | The connection to a Redis target endpoint using Transport Layer Security (TLS). |
Constructors
RedisSettingsProperty()
public RedisSettingsProperty()
Properties
AuthPassword
The password provided with the auth-role
and auth-token
options of the AuthType
setting for a Redis target endpoint.
public string AuthPassword { get; set; }
Property Value
System.String
Remarks
AuthType
The type of authentication to perform when connecting to a Redis target.
public string AuthType { get; set; }
Property Value
System.String
Remarks
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.
AuthUserName
The user name provided with the auth-role
option of the AuthType
setting for a Redis target endpoint.
public string AuthUserName { get; set; }
Property Value
System.String
Remarks
Port
Transmission Control Protocol (TCP) port for the endpoint.
public Nullable<double> Port { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
ServerName
Fully qualified domain name of the endpoint.
public string ServerName { get; set; }
Property Value
System.String
Remarks
SslCaCertificateArn
The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
public string SslCaCertificateArn { get; set; }
Property Value
System.String
Remarks
SslSecurityProtocol
The connection to a Redis target endpoint using Transport Layer Security (TLS).
public string SslSecurityProtocol { get; set; }
Property Value
System.String
Remarks
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.