/AWS1/CL_DMGREDISSETTINGS¶
Provides information that defines a Redis target endpoint.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_servername TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING¶
Fully qualified domain name of the endpoint.
iv_port TYPE /AWS1/DMGINTEGER /AWS1/DMGINTEGER¶
Transmission Control Protocol (TCP) port for the endpoint.
Optional arguments:¶
iv_sslsecurityprotocol TYPE /AWS1/DMGSSLSECPROTOCOLVALUE /AWS1/DMGSSLSECPROTOCOLVALUE¶
The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include
plaintextandssl-encryption. The default isssl-encryption. Thessl-encryptionoption makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using theSslCaCertificateArnsetting. If an ARN isn't given for a CA, DMS uses the Amazon root CA.The
plaintextoption doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.
iv_authtype TYPE /AWS1/DMGREDISAUTHTYPEVALUE /AWS1/DMGREDISAUTHTYPEVALUE¶
The type of authentication to perform when connecting to a Redis target. Options include
none,auth-token, andauth-role. Theauth-tokenoption requires anAuthPasswordvalue to be provided. Theauth-roleoption requiresAuthUserNameandAuthPasswordvalues to be provided.
iv_authusername TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING¶
The user name provided with the
auth-roleoption of theAuthTypesetting for a Redis target endpoint.
iv_authpassword TYPE /AWS1/DMGSECRETSTRING /AWS1/DMGSECRETSTRING¶
The password provided with the
auth-roleandauth-tokenoptions of theAuthTypesetting for a Redis target endpoint.
iv_sslcacertificatearn TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING¶
The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
Queryable Attributes¶
ServerName¶
Fully qualified domain name of the endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVERNAME() |
Getter for SERVERNAME, with configurable default |
ASK_SERVERNAME() |
Getter for SERVERNAME w/ exceptions if field has no value |
HAS_SERVERNAME() |
Determine if SERVERNAME has a value |
Port¶
Transmission Control Protocol (TCP) port for the endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PORT() |
Getter for PORT |
SslSecurityProtocol¶
The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include
plaintextandssl-encryption. The default isssl-encryption. Thessl-encryptionoption makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using theSslCaCertificateArnsetting. If an ARN isn't given for a CA, DMS uses the Amazon root CA.The
plaintextoption doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SSLSECURITYPROTOCOL() |
Getter for SSLSECURITYPROTOCOL, with configurable default |
ASK_SSLSECURITYPROTOCOL() |
Getter for SSLSECURITYPROTOCOL w/ exceptions if field has no |
HAS_SSLSECURITYPROTOCOL() |
Determine if SSLSECURITYPROTOCOL has a value |
AuthType¶
The type of authentication to perform when connecting to a Redis target. Options include
none,auth-token, andauth-role. Theauth-tokenoption requires anAuthPasswordvalue to be provided. Theauth-roleoption requiresAuthUserNameandAuthPasswordvalues to be provided.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHTYPE() |
Getter for AUTHTYPE, with configurable default |
ASK_AUTHTYPE() |
Getter for AUTHTYPE w/ exceptions if field has no value |
HAS_AUTHTYPE() |
Determine if AUTHTYPE has a value |
AuthUserName¶
The user name provided with the
auth-roleoption of theAuthTypesetting for a Redis target endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHUSERNAME() |
Getter for AUTHUSERNAME, with configurable default |
ASK_AUTHUSERNAME() |
Getter for AUTHUSERNAME w/ exceptions if field has no value |
HAS_AUTHUSERNAME() |
Determine if AUTHUSERNAME has a value |
AuthPassword¶
The password provided with the
auth-roleandauth-tokenoptions of theAuthTypesetting for a Redis target endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHPASSWORD() |
Getter for AUTHPASSWORD, with configurable default |
ASK_AUTHPASSWORD() |
Getter for AUTHPASSWORD w/ exceptions if field has no value |
HAS_AUTHPASSWORD() |
Determine if AUTHPASSWORD has a value |
SslCaCertificateArn¶
The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SSLCACERTIFICATEARN() |
Getter for SSLCACERTIFICATEARN, with configurable default |
ASK_SSLCACERTIFICATEARN() |
Getter for SSLCACERTIFICATEARN w/ exceptions if field has no |
HAS_SSLCACERTIFICATEARN() |
Determine if SSLCACERTIFICATEARN has a value |