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.RDS.Types.UserAuthConfig

Description

Documentation

data UserAuthConfig Source #

Specifies the details of authentication used by a proxy to log in as a specific database user.

See: newUserAuthConfig smart constructor.

Constructors

UserAuthConfig'

Fields

authScheme :: Maybe AuthScheme
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
clientPasswordAuthType :: Maybe ClientPasswordAuthType
The type of authentication the proxy uses for connections from clients.
description :: Maybe Text
A user-specified description about the authentication used by a proxy to log in as a specific database user.
iAMAuth :: Maybe IAMAuthMode
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
secretArn :: Maybe Text
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
userName :: Maybe Text
The name of the database user to which the proxy connects.

Instances

Instances details

ToQuery UserAuthConfig Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfig Methods toQuery :: UserAuthConfig -> QueryString #
Generic UserAuthConfig Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfig Associated Types type Rep UserAuthConfig :: Type -> Type # Methods from :: UserAuthConfig -> Rep UserAuthConfig x # to :: Rep UserAuthConfig x -> UserAuthConfig #
Read UserAuthConfig Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfig Methods readsPrec :: Int -> ReadS UserAuthConfig # readList :: ReadS [UserAuthConfig] # readPrec :: ReadPrec UserAuthConfig # readListPrec :: ReadPrec [UserAuthConfig] #
Show UserAuthConfig Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfig Methods showsPrec :: Int -> UserAuthConfig -> ShowS # show :: UserAuthConfig -> String # showList :: [UserAuthConfig] -> ShowS #
NFData UserAuthConfig Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfig Methods rnf :: UserAuthConfig -> () #
Eq UserAuthConfig Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfig Methods (==) :: UserAuthConfig -> UserAuthConfig -> Bool # (/=) :: UserAuthConfig -> UserAuthConfig -> Bool #
Hashable UserAuthConfig Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfig Methods hashWithSalt :: Int -> UserAuthConfig -> Int # hash :: UserAuthConfig -> Int #
type Rep UserAuthConfig Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfig type Rep UserAuthConfig = D1 ('MetaData "UserAuthConfig" "Amazonka.RDS.Types.UserAuthConfig" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "UserAuthConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthScheme)) :: (S1 ('MetaSel ('Just "clientPasswordAuthType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientPasswordAuthType)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "iAMAuth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IAMAuthMode)) :: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newUserAuthConfig :: UserAuthConfig Source #

Create a value of UserAuthConfig 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:authScheme:UserAuthConfig', userAuthConfig_authScheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.

$sel:clientPasswordAuthType:UserAuthConfig', userAuthConfig_clientPasswordAuthType - The type of authentication the proxy uses for connections from clients.

$sel:description:UserAuthConfig', userAuthConfig_description - A user-specified description about the authentication used by a proxy to log in as a specific database user.

$sel:iAMAuth:UserAuthConfig', userAuthConfig_iAMAuth - Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

$sel:secretArn:UserAuthConfig', userAuthConfig_secretArn - The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

$sel:userName:UserAuthConfig', userAuthConfig_userName - The name of the database user to which the proxy connects.

userAuthConfig_authScheme :: Lens' UserAuthConfig (Maybe AuthScheme) Source #

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

userAuthConfig_clientPasswordAuthType :: Lens' UserAuthConfig (Maybe ClientPasswordAuthType) Source #

The type of authentication the proxy uses for connections from clients.

userAuthConfig_description :: Lens' UserAuthConfig (Maybe Text) Source #

A user-specified description about the authentication used by a proxy to log in as a specific database user.

userAuthConfig_iAMAuth :: Lens' UserAuthConfig (Maybe IAMAuthMode) Source #

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

userAuthConfig_secretArn :: Lens' UserAuthConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

userAuthConfig_userName :: Lens' UserAuthConfig (Maybe Text) Source #

The name of the database user to which the proxy connects.