AWS::DMS::Endpoint RedisSettings - AWS CloudFormation
SyntaxProperties

AWS::DMS::Endpoint RedisSettings

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AuthPassword" : String,
  "AuthType" : String,
  "AuthUserName" : String,
  "Port" : Number,
  "ServerName" : String,
  "SslCaCertificateArn" : String,
  "SslSecurityProtocol" : String
}

YAML

  AuthPassword: String
  AuthType: String
  AuthUserName: String
  Port: Number
  ServerName: String
  SslCaCertificateArn: String
  SslSecurityProtocol: String

Properties

AuthPassword

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

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: String

Allowed values: none | auth-role | auth-token

Update requires: No interruption

AuthUserName

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

Required: No

Type: String

Update requires: No interruption

Port

Transmission Control Protocol (TCP) port for the endpoint.

Required: No

Type: Number

Update requires: No interruption

ServerName

Fully qualified domain name of the endpoint.

Required: No

Type: String

Update requires: No interruption

SslCaCertificateArn

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

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: String

Allowed values: plaintext | ssl-encryption

Update requires: No interruption