blib/lib/Paws/ApiGatewayV2/Authorizer.pm untested

filter: Statementstmt 0.0% 0 / 25 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 26 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::ApiGatewayV2::Authorizer;
3 use Moose;
4 has AuthorizerCredentialsArn => (is => 'ro', isa => 'Str', request_name => 'authorizerCredentialsArn', traits => ['NameInRequest']);
5 has AuthorizerId => (is => 'ro', isa => 'Str', request_name => 'authorizerId', traits => ['NameInRequest']);
6 has AuthorizerPayloadFormatVersion => (is => 'ro', isa => 'Str', request_name => 'authorizerPayloadFormatVersion', traits => ['NameInRequest']);
7 has AuthorizerResultTtlInSeconds => (is => 'ro', isa => 'Int', request_name => 'authorizerResultTtlInSeconds', traits => ['NameInRequest']);
8 has AuthorizerType => (is => 'ro', isa => 'Str', request_name => 'authorizerType', traits => ['NameInRequest']);
9 has AuthorizerUri => (is => 'ro', isa => 'Str', request_name => 'authorizerUri', traits => ['NameInRequest']);
10 has EnableSimpleResponses => (is => 'ro', isa => 'Bool', request_name => 'enableSimpleResponses', traits => ['NameInRequest']);
11 has IdentitySource => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'identitySource', traits => ['NameInRequest']);
12 has IdentityValidationExpression => (is => 'ro', isa => 'Str', request_name => 'identityValidationExpression', traits => ['NameInRequest']);
13 has JwtConfiguration => (is => 'ro', isa => 'Paws::ApiGatewayV2::JWTConfiguration', request_name => 'jwtConfiguration', traits => ['NameInRequest']);
14 has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1);
15  
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::ApiGatewayV2::Authorizer
23  
24 =head1 USAGE
25  
26 This class represents one of two things:
27  
28 =head3 Arguments in a call to a service
29  
30 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31 Each attribute should be used as a named argument in the calls that expect this type of object.
32  
33 As an example, if Att1 is expected to be a Paws::ApiGatewayV2::Authorizer object:
34  
35 $service_obj->Method(Att1 => { AuthorizerCredentialsArn => $value, ..., Name => $value });
36  
37 =head3 Results returned from an API call
38  
39 Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::Authorizer object:
40  
41 $result = $service_obj->Method(...);
42 $result->Att1->AuthorizerCredentialsArn
43  
44 =head1 DESCRIPTION
45  
46 Represents an authorizer.
47  
48 =head1 ATTRIBUTES
49  
50  
51 =head2 AuthorizerCredentialsArn => Str
52  
53 Specifies the required credentials as an IAM role for API Gateway to
54 invoke the authorizer. To specify an IAM role for API Gateway to
55 assume, use the role's Amazon Resource Name (ARN). To use
56 resource-based permissions on the Lambda function, don't specify this
57 parameter. Supported only for REQUEST authorizers.
58  
59  
60 =head2 AuthorizerId => Str
61  
62 The authorizer identifier.
63  
64  
65 =head2 AuthorizerPayloadFormatVersion => Str
66  
67 Specifies the format of the payload sent to an HTTP API Lambda
68 authorizer. Required for HTTP API Lambda authorizers. Supported values
69 are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers
70 for HTTP APIs
71 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
72  
73  
74 =head2 AuthorizerResultTtlInSeconds => Int
75  
76 The time to live (TTL) for cached authorizer results, in seconds. If it
77 equals 0, authorization caching is disabled. If it is greater than 0,
78 API Gateway caches authorizer responses. The maximum value is 3600, or
79 1 hour. Supported only for HTTP API Lambda authorizers.
80  
81  
82 =head2 AuthorizerType => Str
83  
84 The authorizer type. Specify REQUEST for a Lambda function using
85 incoming request parameters. Specify JWT to use JSON Web Tokens
86 (supported only for HTTP APIs).
87  
88  
89 =head2 AuthorizerUri => Str
90  
91 The authorizer's Uniform Resource Identifier (URI). For REQUEST
92 authorizers, this must be a well-formed Lambda function URI, for
93 example,
94 arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.
95 In general, the URI has this form:
96 arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region}
97 is the same as the region hosting the Lambda function, path indicates
98 that the remaining substring in the URI should be treated as the path
99 to the resource, including the initial /. For Lambda functions, this is
100 usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
101 Supported only for REQUEST authorizers.
102  
103  
104 =head2 EnableSimpleResponses => Bool
105  
106 Specifies whether a Lambda authorizer returns a response in a simple
107 format. If enabled, the Lambda authorizer can return a boolean value
108 instead of an IAM policy. Supported only for HTTP APIs. To learn more,
109 see Working with AWS Lambda authorizers for HTTP APIs
110 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html)
111  
112  
113 =head2 IdentitySource => ArrayRef[Str|Undef]
114  
115 The identity source for which authorization is requested.
116  
117 For a REQUEST authorizer, this is optional. The value is a set of one
118 or more mapping expressions of the specified request parameters. The
119 identity source can be headers, query string parameters, stage
120 variables, and context parameters. For example, if an Auth header and a
121 Name query string parameter are defined as identity sources, this value
122 is route.request.header.Auth, route.request.querystring.Name for
123 WebSocket APIs. For HTTP APIs, use selection expressions prefixed with
124 $, for example, $request.header.Auth, $request.querystring.Name. These
125 parameters are used to perform runtime validation for Lambda-based
126 authorizers by verifying all of the identity-related request parameters
127 are present in the request, not null, and non-empty. Only when this is
128 true does the authorizer invoke the authorizer Lambda function.
129 Otherwise, it returns a 401 Unauthorized response without calling the
130 Lambda function. For HTTP APIs, identity sources are also used as the
131 cache key when caching is enabled. To learn more, see Working with AWS
132 Lambda authorizers for HTTP APIs
133 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
134  
135 For JWT, a single entry that specifies where to extract the JSON Web
136 Token (JWT) from inbound requests. Currently only header-based and
137 query parameter-based selections are supported, for example
138 $request.header.Authorization.
139  
140  
141 =head2 IdentityValidationExpression => Str
142  
143 The validation expression does not apply to the REQUEST authorizer.
144  
145  
146 =head2 JwtConfiguration => L<Paws::ApiGatewayV2::JWTConfiguration>
147  
148 Represents the configuration of a JWT authorizer. Required for the JWT
149 authorizer type. Supported only for HTTP APIs.
150  
151  
152 =head2 B<REQUIRED> Name => Str
153  
154 The name of the authorizer.
155  
156  
157  
158 =head1 SEE ALSO
159  
160 This class forms part of L<Paws>, describing an object used in L<Paws::ApiGatewayV2>
161  
162 =head1 BUGS and CONTRIBUTIONS
163  
164 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
165  
166 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
167  
168 =cut
169