Skip to content

RedisSettings

Used by
Source code in docs_src/capo_database_migration_service/types/redis_settings.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class RedisSettings(TypedDict, closed=True):
    server_name: "capo_database_migration_service.types.string.String"
    """<p>Fully qualified domain name of the endpoint.</p>"""
    port: "capo_database_migration_service.types.integer.Integer"
    """<p>Transmission Control Protocol (TCP) port for the endpoint.</p>"""
    ssl_security_protocol: NotRequired[
        "capo_database_migration_service.types.ssl_security_protocol_value.SslSecurityProtocolValue"
    ]
    """<p>The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include <code>plaintext</code> and <code>ssl-encryption</code>. The default is <code>ssl-encryption</code>. The <code>ssl-encryption</code> option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the <code>SslCaCertificateArn </code>setting. If an ARN isn't given for a CA, DMS uses the Amazon root CA.</p> <p>The <code>plaintext</code> option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.</p>"""
    auth_type: NotRequired[
        "capo_database_migration_service.types.redis_auth_type_value.RedisAuthTypeValue"
    ]
    """<p>The type of authentication to perform when connecting to a Redis target. Options include <code>none</code>, <code>auth-token</code>, and <code>auth-role</code>. The <code>auth-token</code> option requires an <code>AuthPassword</code> value to be provided. The <code>auth-role</code> option requires <code>AuthUserName</code> and <code>AuthPassword</code> values to be provided.</p>"""
    auth_user_name: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The user name provided with the <code>auth-role</code> option of the <code>AuthType</code> setting for a Redis target endpoint.</p>"""
    auth_password: NotRequired[
        "capo_database_migration_service.types.secret_string.SecretString"
    ]
    """<p>The password provided with the <code>auth-role</code> and <code>auth-token</code> options of the <code>AuthType</code> setting for a Redis target endpoint.</p>"""
    ssl_ca_certificate_arn: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.</p>"""

auth_password instance-attribute 

auth_password: NotRequired[SecretString]

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

auth_type instance-attribute 

auth_type: NotRequired[RedisAuthTypeValue]

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.

auth_user_name instance-attribute 

auth_user_name: NotRequired[String]

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

port instance-attribute 

port: Integer

Transmission Control Protocol (TCP) port for the endpoint.

server_name instance-attribute 

server_name: String

Fully qualified domain name of the endpoint.

ssl_ca_certificate_arn instance-attribute 

ssl_ca_certificate_arn: NotRequired[String]

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

ssl_security_protocol instance-attribute 

ssl_security_protocol: NotRequired[SslSecurityProtocolValue]

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.