Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ApiGatewayV2.Types.JWTConfiguration

Description

Synopsis

data JWTConfiguration = JWTConfiguration' {
- audience :: Maybe [Text]
- issuer :: Maybe Text
}
newJWTConfiguration :: JWTConfiguration
jWTConfiguration_audience :: Lens' JWTConfiguration (Maybe [Text])
jWTConfiguration_issuer :: Lens' JWTConfiguration (Maybe Text)

Documentation

data JWTConfiguration Source #

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

Instances details

Eq JWTConfiguration Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration Methods (==) :: JWTConfiguration -> JWTConfiguration -> Bool # (/=) :: JWTConfiguration -> JWTConfiguration -> Bool #
Read JWTConfiguration Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration Methods readsPrec :: Int -> ReadS JWTConfiguration # readList :: ReadS [JWTConfiguration] # readPrec :: ReadPrec JWTConfiguration # readListPrec :: ReadPrec [JWTConfiguration] #
Show JWTConfiguration Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration Methods showsPrec :: Int -> JWTConfiguration -> ShowS # show :: JWTConfiguration -> String # showList :: [JWTConfiguration] -> ShowS #
Generic JWTConfiguration Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration Associated Types type Rep JWTConfiguration :: Type -> Type # Methods from :: JWTConfiguration -> Rep JWTConfiguration x # to :: Rep JWTConfiguration x -> JWTConfiguration #
NFData JWTConfiguration Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration Methods rnf :: JWTConfiguration -> () #
Hashable JWTConfiguration Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration Methods hashWithSalt :: Int -> JWTConfiguration -> Int # hash :: JWTConfiguration -> Int #
ToJSON JWTConfiguration Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration Methods toJSON :: JWTConfiguration -> Value # toEncoding :: JWTConfiguration -> Encoding # toJSONList :: [JWTConfiguration] -> Value # toEncodingList :: [JWTConfiguration] -> Encoding #
FromJSON JWTConfiguration Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration Methods parseJSON :: Value -> Parser JWTConfiguration # parseJSONList :: Value -> Parser [JWTConfiguration] #
type Rep JWTConfiguration Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.JWTConfiguration type Rep JWTConfiguration = D1 ('MetaData "JWTConfiguration" "Amazonka.ApiGatewayV2.Types.JWTConfiguration" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" '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 Source #

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]) Source #

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) Source #

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.