Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DMS.Types.RedisSettings

Description

Documentation

data RedisSettings Source #

Provides information that defines a Redis target endpoint.

See: newRedisSettings smart constructor.

Constructors

RedisSettings'

Fields

authPassword :: Maybe (Sensitive Text)
The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.
authType :: Maybe 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.
authUserName :: Maybe Text
The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.
sslCaCertificateArn :: Maybe Text
The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
sslSecurityProtocol :: Maybe 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.
serverName :: Text
Fully qualified domain name of the endpoint.
port :: Int
Transmission Control Protocol (TCP) port for the endpoint.

Instances

Instances details

FromJSON RedisSettings Source #
Instance details Defined in Amazonka.DMS.Types.RedisSettings Methods parseJSON :: Value -> Parser RedisSettings # parseJSONList :: Value -> Parser [RedisSettings] #
ToJSON RedisSettings Source #
Instance details Defined in Amazonka.DMS.Types.RedisSettings Methods toJSON :: RedisSettings -> Value # toEncoding :: RedisSettings -> Encoding # toJSONList :: [RedisSettings] -> Value # toEncodingList :: [RedisSettings] -> Encoding #
Generic RedisSettings Source #
Instance details Defined in Amazonka.DMS.Types.RedisSettings Associated Types type Rep RedisSettings :: Type -> Type # Methods from :: RedisSettings -> Rep RedisSettings x # to :: Rep RedisSettings x -> RedisSettings #
Show RedisSettings Source #
Instance details Defined in Amazonka.DMS.Types.RedisSettings Methods showsPrec :: Int -> RedisSettings -> ShowS # show :: RedisSettings -> String # showList :: [RedisSettings] -> ShowS #
NFData RedisSettings Source #
Instance details Defined in Amazonka.DMS.Types.RedisSettings Methods rnf :: RedisSettings -> () #
Eq RedisSettings Source #
Instance details Defined in Amazonka.DMS.Types.RedisSettings Methods (==) :: RedisSettings -> RedisSettings -> Bool # (/=) :: RedisSettings -> RedisSettings -> Bool #
Hashable RedisSettings Source #
Instance details Defined in Amazonka.DMS.Types.RedisSettings Methods hashWithSalt :: Int -> RedisSettings -> Int # hash :: RedisSettings -> Int #
type Rep RedisSettings Source #
Instance details Defined in Amazonka.DMS.Types.RedisSettings type Rep RedisSettings = D1 ('MetaData "RedisSettings" "Amazonka.DMS.Types.RedisSettings" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "RedisSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "authType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedisAuthTypeValue)) :: S1 ('MetaSel ('Just "authUserName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "sslCaCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sslSecurityProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SslSecurityProtocolValue))) :: (S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newRedisSettings Source #

Arguments

:: Text	`$sel:serverName:RedisSettings'`
-> Int	`$sel:port:RedisSettings'`
-> RedisSettings

Create a value of RedisSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authPassword:RedisSettings', redisSettings_authPassword - The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.

$sel:authType:RedisSettings', redisSettings_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.

$sel:authUserName:RedisSettings', redisSettings_authUserName - The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.

$sel:sslCaCertificateArn:RedisSettings', redisSettings_sslCaCertificateArn - The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.

$sel:sslSecurityProtocol:RedisSettings', redisSettings_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.

$sel:serverName:RedisSettings', redisSettings_serverName - Fully qualified domain name of the endpoint.

$sel:port:RedisSettings', redisSettings_port - Transmission Control Protocol (TCP) port for the endpoint.

redisSettings_authPassword :: Lens' RedisSettings (Maybe Text) Source #

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

redisSettings_authType :: Lens' RedisSettings (Maybe RedisAuthTypeValue) Source #

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.

redisSettings_authUserName :: Lens' RedisSettings (Maybe Text) Source #

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

redisSettings_sslCaCertificateArn :: Lens' RedisSettings (Maybe Text) Source #

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

redisSettings_sslSecurityProtocol :: Lens' RedisSettings (Maybe SslSecurityProtocolValue) Source #

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.

redisSettings_serverName :: Lens' RedisSettings Text Source #

Fully qualified domain name of the endpoint.

redisSettings_port :: Lens' RedisSettings Int Source #

Transmission Control Protocol (TCP) port for the endpoint.