Amazonka.AppSync.Types.OpenIDConnectConfig

Documentation

data OpenIDConnectConfig

Describes an OpenID Connect (OIDC) configuration.

See: newOpenIDConnectConfig smart constructor.

Constructors

OpenIDConnectConfig'

Fields

• authTTL :: Maybe Integer

  The number of milliseconds that a token is valid after being authenticated.

• clientId :: Maybe Text

  The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

• iatTTL :: Maybe Integer

  The number of milliseconds that a token is valid after it's issued to a user.

• issuer :: Text

  The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

Instances

FromJSON OpenIDConnectConfig

Defined in Amazonka.AppSync.Types.OpenIDConnectConfig

Methods

parseJSON :: Value -> Parser OpenIDConnectConfig

parseJSONList :: Value -> Parser [OpenIDConnectConfig]

ToJSON OpenIDConnectConfig

Defined in Amazonka.AppSync.Types.OpenIDConnectConfig

Methods

toJSON :: OpenIDConnectConfig -> Value

toEncoding :: OpenIDConnectConfig -> Encoding

toJSONList :: [OpenIDConnectConfig] -> Value

toEncodingList :: [OpenIDConnectConfig] -> Encoding

Generic OpenIDConnectConfig

Defined in Amazonka.AppSync.Types.OpenIDConnectConfig

Associated Types

type Rep OpenIDConnectConfig :: Type -> Type

Methods

from :: OpenIDConnectConfig -> Rep OpenIDConnectConfig x

to :: Rep OpenIDConnectConfig x -> OpenIDConnectConfig

Read OpenIDConnectConfig

Defined in Amazonka.AppSync.Types.OpenIDConnectConfig

Methods

readsPrec :: Int -> ReadS OpenIDConnectConfig

readList :: ReadS [OpenIDConnectConfig]

readPrec :: ReadPrec OpenIDConnectConfig

readListPrec :: ReadPrec [OpenIDConnectConfig]

Show OpenIDConnectConfig

Defined in Amazonka.AppSync.Types.OpenIDConnectConfig

Methods

showsPrec :: Int -> OpenIDConnectConfig -> ShowS

show :: OpenIDConnectConfig -> String

showList :: [OpenIDConnectConfig] -> ShowS

NFData OpenIDConnectConfig

Defined in Amazonka.AppSync.Types.OpenIDConnectConfig

Methods

rnf :: OpenIDConnectConfig -> ()

Eq OpenIDConnectConfig

Defined in Amazonka.AppSync.Types.OpenIDConnectConfig

Methods

(==) :: OpenIDConnectConfig -> OpenIDConnectConfig -> Bool

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

Hashable OpenIDConnectConfig

Defined in Amazonka.AppSync.Types.OpenIDConnectConfig

Methods

hashWithSalt :: Int -> OpenIDConnectConfig -> Int

hash :: OpenIDConnectConfig -> Int

type Rep OpenIDConnectConfig

Defined in Amazonka.AppSync.Types.OpenIDConnectConfig

type Rep OpenIDConnectConfig = D1 ('MetaData "OpenIDConnectConfig" "Amazonka.AppSync.Types.OpenIDConnectConfig" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "OpenIDConnectConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authTTL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "iatTTL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "issuer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newOpenIDConnectConfig

Arguments

:: Text

$sel:issuer:OpenIDConnectConfig'

-> OpenIDConnectConfig

Create a value of OpenIDConnectConfig 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:authTTL:OpenIDConnectConfig', openIDConnectConfig_authTTL - The number of milliseconds that a token is valid after being authenticated.

$sel:clientId:OpenIDConnectConfig', openIDConnectConfig_clientId - The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

$sel:iatTTL:OpenIDConnectConfig', openIDConnectConfig_iatTTL - The number of milliseconds that a token is valid after it's issued to a user.

$sel:issuer:OpenIDConnectConfig', openIDConnectConfig_issuer - The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

openIDConnectConfig_authTTL :: Lens' OpenIDConnectConfig (Maybe Integer)

The number of milliseconds that a token is valid after being authenticated.

openIDConnectConfig_clientId :: Lens' OpenIDConnectConfig (Maybe Text)

The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

openIDConnectConfig_iatTTL :: Lens' OpenIDConnectConfig (Maybe Integer)

The number of milliseconds that a token is valid after it's issued to a user.

openIDConnectConfig_issuer :: Lens' OpenIDConnectConfig Text

The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.