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.UserAuthConfigInfo

Description

Documentation

data UserAuthConfigInfo Source #

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

See: newUserAuthConfigInfo smart constructor.

Constructors

UserAuthConfigInfo'

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

FromXML UserAuthConfigInfo Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfigInfo Methods parseXML :: [Node] -> Either String UserAuthConfigInfo #
Generic UserAuthConfigInfo Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfigInfo Associated Types type Rep UserAuthConfigInfo :: Type -> Type # Methods from :: UserAuthConfigInfo -> Rep UserAuthConfigInfo x # to :: Rep UserAuthConfigInfo x -> UserAuthConfigInfo #
Read UserAuthConfigInfo Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfigInfo Methods readsPrec :: Int -> ReadS UserAuthConfigInfo # readList :: ReadS [UserAuthConfigInfo] # readPrec :: ReadPrec UserAuthConfigInfo # readListPrec :: ReadPrec [UserAuthConfigInfo] #
Show UserAuthConfigInfo Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfigInfo Methods showsPrec :: Int -> UserAuthConfigInfo -> ShowS # show :: UserAuthConfigInfo -> String # showList :: [UserAuthConfigInfo] -> ShowS #
NFData UserAuthConfigInfo Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfigInfo Methods rnf :: UserAuthConfigInfo -> () #
Eq UserAuthConfigInfo Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfigInfo Methods (==) :: UserAuthConfigInfo -> UserAuthConfigInfo -> Bool # (/=) :: UserAuthConfigInfo -> UserAuthConfigInfo -> Bool #
Hashable UserAuthConfigInfo Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfigInfo Methods hashWithSalt :: Int -> UserAuthConfigInfo -> Int # hash :: UserAuthConfigInfo -> Int #
type Rep UserAuthConfigInfo Source #
Instance details Defined in Amazonka.RDS.Types.UserAuthConfigInfo type Rep UserAuthConfigInfo = D1 ('MetaData "UserAuthConfigInfo" "Amazonka.RDS.Types.UserAuthConfigInfo" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "UserAuthConfigInfo'" '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))))))

newUserAuthConfigInfo :: UserAuthConfigInfo Source #

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

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

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

$sel:iAMAuth:UserAuthConfigInfo', userAuthConfigInfo_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:UserAuthConfigInfo', userAuthConfigInfo_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:UserAuthConfigInfo', userAuthConfigInfo_userName - The name of the database user to which the proxy connects.

userAuthConfigInfo_authScheme :: Lens' UserAuthConfigInfo (Maybe AuthScheme) Source #

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

userAuthConfigInfo_clientPasswordAuthType :: Lens' UserAuthConfigInfo (Maybe ClientPasswordAuthType) Source #

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

userAuthConfigInfo_description :: Lens' UserAuthConfigInfo (Maybe Text) Source #

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

userAuthConfigInfo_iAMAuth :: Lens' UserAuthConfigInfo (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.

userAuthConfigInfo_secretArn :: Lens' UserAuthConfigInfo (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.

userAuthConfigInfo_userName :: Lens' UserAuthConfigInfo (Maybe Text) Source #

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