« blib/lib/Paws/ApiGatewayV2/Integrations.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/LimitExceededException.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGatewayV2::JWTConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Audience => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'audience', traits => ['NameInRequest']); | ||
| 5 | has Issuer => (is => 'ro', isa => 'Str', request_name => 'issuer', traits => ['NameInRequest']); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::ApiGatewayV2::JWTConfiguration | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::ApiGatewayV2::JWTConfiguration object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Audience => $value, ..., Issuer => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::JWTConfiguration object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Audience | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Represents the configuration of a JWT authorizer. Required for the JWT | ||
| 38 | authorizer type. Supported only for HTTP APIs. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 Audience => ArrayRef[Str|Undef] | ||
| 44 | |||
| 45 | A list of the intended recipients of the JWT. A valid JWT must provide | ||
| 46 | an aud that matches at least one entry in this list. See RFC 7519 | ||
| 47 | (https://tools.ietf.org/html/rfc7519#section-4.1.3). Supported only for | ||
| 48 | HTTP APIs. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Issuer => Str | ||
| 52 | |||
| 53 | The base domain of the identity provider that issues JSON Web Tokens. | ||
| 54 | For example, an Amazon Cognito user pool has the following format: | ||
| 55 | https://cognito-idp.{region}.amazonaws.com/{userPoolId} . Required for | ||
| 56 | the JWT authorizer type. Supported only for HTTP APIs. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head1 SEE ALSO | ||
| 61 | |||
| 62 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGatewayV2> | ||
| 63 | |||
| 64 | =head1 BUGS and CONTRIBUTIONS | ||
| 65 | |||
| 66 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 67 | |||
| 68 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 69 | |||
| 70 | =cut | ||
| 71 |