libZSservicesZSamazonka-rdsZSamazonka-rds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RDS.Types.UserAuthConfigInfo

Description

 
Synopsis

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

  • iAMAuth :: Maybe IAMAuthMode

    Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.

  • userName :: Maybe Text

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

  • authScheme :: Maybe AuthScheme

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

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

  • description :: Maybe Text

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

Instances

Instances details
Eq UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

Read UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

Show UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

Generic UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

Associated Types

type Rep UserAuthConfigInfo :: Type -> Type #

NFData UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

Methods

rnf :: UserAuthConfigInfo -> () #

Hashable UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

FromXML UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

type Rep UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

type Rep UserAuthConfigInfo = D1 ('MetaData "UserAuthConfigInfo" "Amazonka.RDS.Types.UserAuthConfigInfo" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "UserAuthConfigInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "iAMAuth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IAMAuthMode)) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "authScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthScheme)) :*: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") '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:iAMAuth:UserAuthConfigInfo', userAuthConfigInfo_iAMAuth - Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.

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

$sel:authScheme:UserAuthConfigInfo', userAuthConfigInfo_authScheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.

$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:description:UserAuthConfigInfo', userAuthConfigInfo_description - 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.

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

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