aws-cdk-lib.aws_dms.CfnEndpoint.RedisSettingsProperty

RedisSettingsProperty Struct

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 .

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const redisSettingsProperty: dms.CfnEndpoint.RedisSettingsProperty = {
  authPassword: 'authPassword',
  authType: 'authType',
  authUserName: 'authUserName',
  port: 123,
  serverName: 'serverName',
  sslCaCertificateArn: 'sslCaCertificateArn',
  sslSecurityProtocol: 'sslSecurityProtocol',
};

Properties

authPassword?optionalstringauth_password?optionalstrauthPassword?optionalStringAuthPassword?optionalstringAuthPassword?optional*string#

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

authType?optionalstringauth_type?optionalstrauthType?optionalStringAuthType?optionalstringAuthType?optional*string#

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.

authUserName?optionalstringauth_user_name?optionalstrauthUserName?optionalStringAuthUserName?optionalstringAuthUserName?optional*string#

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

port?optionalnumberport?optionalint | floatport?optionalNumberPort?optionaldoublePort?optional*float64#

Transmission Control Protocol (TCP) port for the endpoint.

serverName?optionalstringserver_name?optionalstrserverName?optionalStringServerName?optionalstringServerName?optional*string#

Fully qualified domain name of the endpoint.

sslCaCertificateArn?optionalstringssl_ca_certificate_arn?optionalstrsslCaCertificateArn?optionalStringSslCaCertificateArn?optionalstringSslCaCertificateArn?optional*string#

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

sslSecurityProtocol?optionalstringssl_security_protocol?optionalstrsslSecurityProtocol?optionalStringSslSecurityProtocol?optionalstringSslSecurityProtocol?optional*string#

The connection to a Redis target endpoint using Transport Layer Security (TLS).

notes

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.