Amazonka.ApiGatewayV2.Types.JWTConfiguration

Documentation

data JWTConfiguration

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

See: newJWTConfiguration smart constructor.

Constructors

JWTConfiguration'

Fields

• audience :: Maybe [Text]

  A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

• issuer :: Maybe Text

  The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId} . Required for the JWT authorizer type. Supported only for HTTP APIs.

Instances

FromJSON JWTConfiguration

Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration

Methods

parseJSON :: Value -> Parser JWTConfiguration

parseJSONList :: Value -> Parser [JWTConfiguration]

ToJSON JWTConfiguration

Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration

Methods

toJSON :: JWTConfiguration -> Value

toEncoding :: JWTConfiguration -> Encoding

toJSONList :: [JWTConfiguration] -> Value

toEncodingList :: [JWTConfiguration] -> Encoding

Generic JWTConfiguration

Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration

Associated Types

type Rep JWTConfiguration :: Type -> Type

Methods

from :: JWTConfiguration -> Rep JWTConfiguration x

to :: Rep JWTConfiguration x -> JWTConfiguration

Read JWTConfiguration

Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration

Methods

readsPrec :: Int -> ReadS JWTConfiguration

readList :: ReadS [JWTConfiguration]

readPrec :: ReadPrec JWTConfiguration

readListPrec :: ReadPrec [JWTConfiguration]

Show JWTConfiguration

Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration

Methods

showsPrec :: Int -> JWTConfiguration -> ShowS

show :: JWTConfiguration -> String

showList :: [JWTConfiguration] -> ShowS

NFData JWTConfiguration

Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration

Methods

rnf :: JWTConfiguration -> ()

Eq JWTConfiguration

Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration

Methods

(==) :: JWTConfiguration -> JWTConfiguration -> Bool

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

Hashable JWTConfiguration

Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration

Methods

hashWithSalt :: Int -> JWTConfiguration -> Int

hash :: JWTConfiguration -> Int

type Rep JWTConfiguration

Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration

type Rep JWTConfiguration = D1 ('MetaData "JWTConfiguration" "Amazonka.ApiGatewayV2.Types.JWTConfiguration" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "JWTConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "audience") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "issuer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newJWTConfiguration :: JWTConfiguration

Create a value of JWTConfiguration 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:audience:JWTConfiguration', jWTConfiguration_audience - A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

$sel:issuer:JWTConfiguration', jWTConfiguration_issuer - The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId} . Required for the JWT authorizer type. Supported only for HTTP APIs.

jWTConfiguration_audience :: Lens' JWTConfiguration (Maybe [Text])

A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

jWTConfiguration_issuer :: Lens' JWTConfiguration (Maybe Text)

The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId} . Required for the JWT authorizer type. Supported only for HTTP APIs.