Amazonka.AppSync.Types.UserPoolConfig

Documentation

data UserPoolConfig

Describes an Amazon Cognito user pool configuration.

See: newUserPoolConfig smart constructor.

Constructors

UserPoolConfig'

Fields

• appIdClientRegex :: Maybe Text

  A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

• userPoolId :: Text

  The user pool ID.

• awsRegion :: Text

  The Amazon Web Services Region in which the user pool was created.

• defaultAction :: DefaultAction

  The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

Instances

FromJSON UserPoolConfig

Defined in Amazonka.AppSync.Types.UserPoolConfig

Methods

parseJSON :: Value -> Parser UserPoolConfig

parseJSONList :: Value -> Parser [UserPoolConfig]

ToJSON UserPoolConfig

Defined in Amazonka.AppSync.Types.UserPoolConfig

Methods

toJSON :: UserPoolConfig -> Value

toEncoding :: UserPoolConfig -> Encoding

toJSONList :: [UserPoolConfig] -> Value

toEncodingList :: [UserPoolConfig] -> Encoding

Generic UserPoolConfig

Defined in Amazonka.AppSync.Types.UserPoolConfig

Associated Types

type Rep UserPoolConfig :: Type -> Type

Methods

from :: UserPoolConfig -> Rep UserPoolConfig x

to :: Rep UserPoolConfig x -> UserPoolConfig

Read UserPoolConfig

Defined in Amazonka.AppSync.Types.UserPoolConfig

Methods

readsPrec :: Int -> ReadS UserPoolConfig

readList :: ReadS [UserPoolConfig]

readPrec :: ReadPrec UserPoolConfig

readListPrec :: ReadPrec [UserPoolConfig]

Show UserPoolConfig

Defined in Amazonka.AppSync.Types.UserPoolConfig

Methods

showsPrec :: Int -> UserPoolConfig -> ShowS

show :: UserPoolConfig -> String

showList :: [UserPoolConfig] -> ShowS

NFData UserPoolConfig

Defined in Amazonka.AppSync.Types.UserPoolConfig

Methods

rnf :: UserPoolConfig -> ()

Eq UserPoolConfig

Defined in Amazonka.AppSync.Types.UserPoolConfig

Methods

(==) :: UserPoolConfig -> UserPoolConfig -> Bool

(/=) :: UserPoolConfig -> UserPoolConfig -> Bool

Hashable UserPoolConfig

Defined in Amazonka.AppSync.Types.UserPoolConfig

Methods

hashWithSalt :: Int -> UserPoolConfig -> Int

hash :: UserPoolConfig -> Int

type Rep UserPoolConfig

Defined in Amazonka.AppSync.Types.UserPoolConfig

type Rep UserPoolConfig = D1 ('MetaData "UserPoolConfig" "Amazonka.AppSync.Types.UserPoolConfig" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "UserPoolConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "appIdClientRegex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "awsRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "defaultAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DefaultAction))))

newUserPoolConfig

Arguments

:: Text

$sel:userPoolId:UserPoolConfig'

-> Text

$sel:awsRegion:UserPoolConfig'

-> DefaultAction

$sel:defaultAction:UserPoolConfig'

-> UserPoolConfig

Create a value of UserPoolConfig 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:appIdClientRegex:UserPoolConfig', userPoolConfig_appIdClientRegex - A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

$sel:userPoolId:UserPoolConfig', userPoolConfig_userPoolId - The user pool ID.

$sel:awsRegion:UserPoolConfig', userPoolConfig_awsRegion - The Amazon Web Services Region in which the user pool was created.

$sel:defaultAction:UserPoolConfig', userPoolConfig_defaultAction - The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

userPoolConfig_appIdClientRegex :: Lens' UserPoolConfig (Maybe Text)

A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

userPoolConfig_userPoolId :: Lens' UserPoolConfig Text

The user pool ID.

userPoolConfig_awsRegion :: Lens' UserPoolConfig Text

The Amazon Web Services Region in which the user pool was created.

userPoolConfig_defaultAction :: Lens' UserPoolConfig DefaultAction

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.