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

filter: Statementstmt 0.0% 0 / 34 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 36 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::ApiGatewayV2::UpdateAuthorizer;
3 use Moose;
4 has ApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'apiId', required => 1);
5 has AuthorizerCredentialsArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizerCredentialsArn');
6 has AuthorizerId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'authorizerId', required => 1);
7 has AuthorizerPayloadFormatVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizerPayloadFormatVersion');
8 has AuthorizerResultTtlInSeconds => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'authorizerResultTtlInSeconds');
9 has AuthorizerType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizerType');
10 has AuthorizerUri => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authorizerUri');
11 has EnableSimpleResponses => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableSimpleResponses');
12 has IdentitySource => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'identitySource');
13 has IdentityValidationExpression => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'identityValidationExpression');
14 has JwtConfiguration => (is => 'ro', isa => 'Paws::ApiGatewayV2::JWTConfiguration', traits => ['NameInRequest'], request_name => 'jwtConfiguration');
15 has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name');
16  
17 use MooseX::ClassAttribute;
18  
19 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateAuthorizer');
20 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/apis/{apiId}/authorizers/{authorizerId}');
21 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH');
22 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGatewayV2::UpdateAuthorizerResponse');
23 1;
24  
25 ### main pod documentation begin ###
26  
27 =head1 NAME
28  
29 Paws::ApiGatewayV2::UpdateAuthorizer - Arguments for method UpdateAuthorizer on L<Paws::ApiGatewayV2>
30  
31 =head1 DESCRIPTION
32  
33 This class represents the parameters used for calling the method UpdateAuthorizer on the
34 L<AmazonApiGatewayV2|Paws::ApiGatewayV2> service. Use the attributes of this class
35 as arguments to method UpdateAuthorizer.
36  
37 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateAuthorizer.
38  
39 =head1 SYNOPSIS
40  
41 my $apigateway = Paws->service('ApiGatewayV2');
42 my $UpdateAuthorizerResponse = $apigateway->UpdateAuthorizer(
43 ApiId => 'My__string',
44 AuthorizerId => 'My__string',
45 AuthorizerCredentialsArn => 'MyArn', # OPTIONAL
46 AuthorizerPayloadFormatVersion =>
47 'MyStringWithLengthBetween1And64', # OPTIONAL
48 AuthorizerResultTtlInSeconds => 1, # OPTIONAL
49 AuthorizerType => 'REQUEST', # OPTIONAL
50 AuthorizerUri => 'MyUriWithLengthBetween1And2048', # OPTIONAL
51 EnableSimpleResponses => 1, # OPTIONAL
52 IdentitySource => [ 'My__string', ... ], # OPTIONAL
53 IdentityValidationExpression =>
54 'MyStringWithLengthBetween0And1024', # OPTIONAL
55 JwtConfiguration => {
56 Audience => [ 'My__string', ... ], # OPTIONAL
57 Issuer => 'MyUriWithLengthBetween1And2048',
58 }, # OPTIONAL
59 Name => 'MyStringWithLengthBetween1And128', # OPTIONAL
60 );
61  
62 # Results:
63 my $AuthorizerCredentialsArn =
64 $UpdateAuthorizerResponse->AuthorizerCredentialsArn;
65 my $AuthorizerId = $UpdateAuthorizerResponse->AuthorizerId;
66 my $AuthorizerPayloadFormatVersion =
67 $UpdateAuthorizerResponse->AuthorizerPayloadFormatVersion;
68 my $AuthorizerResultTtlInSeconds =
69 $UpdateAuthorizerResponse->AuthorizerResultTtlInSeconds;
70 my $AuthorizerType = $UpdateAuthorizerResponse->AuthorizerType;
71 my $AuthorizerUri = $UpdateAuthorizerResponse->AuthorizerUri;
72 my $EnableSimpleResponses =
73 $UpdateAuthorizerResponse->EnableSimpleResponses;
74 my $IdentitySource = $UpdateAuthorizerResponse->IdentitySource;
75 my $IdentityValidationExpression =
76 $UpdateAuthorizerResponse->IdentityValidationExpression;
77 my $JwtConfiguration = $UpdateAuthorizerResponse->JwtConfiguration;
78 my $Name = $UpdateAuthorizerResponse->Name;
79  
80 # Returns a L<Paws::ApiGatewayV2::UpdateAuthorizerResponse> object.
81  
82 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
83 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/UpdateAuthorizer>
84  
85 =head1 ATTRIBUTES
86  
87  
88 =head2 B<REQUIRED> ApiId => Str
89  
90 The API identifier.
91  
92  
93  
94 =head2 AuthorizerCredentialsArn => Str
95  
96 Specifies the required credentials as an IAM role for API Gateway to
97 invoke the authorizer. To specify an IAM role for API Gateway to
98 assume, use the role's Amazon Resource Name (ARN). To use
99 resource-based permissions on the Lambda function, don't specify this
100 parameter.
101  
102  
103  
104 =head2 B<REQUIRED> AuthorizerId => Str
105  
106 The authorizer identifier.
107  
108  
109  
110 =head2 AuthorizerPayloadFormatVersion => Str
111  
112 Specifies the format of the payload sent to an HTTP API Lambda
113 authorizer. Required for HTTP API Lambda authorizers. Supported values
114 are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers
115 for HTTP APIs
116 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
117  
118  
119  
120 =head2 AuthorizerResultTtlInSeconds => Int
121  
122 The time to live (TTL) for cached authorizer results, in seconds. If it
123 equals 0, authorization caching is disabled. If it is greater than 0,
124 API Gateway caches authorizer responses. The maximum value is 3600, or
125 1 hour. Supported only for HTTP API Lambda authorizers.
126  
127  
128  
129 =head2 AuthorizerType => Str
130  
131 The authorizer type. Specify REQUEST for a Lambda function using
132 incoming request parameters. Specify JWT to use JSON Web Tokens
133 (supported only for HTTP APIs).
134  
135 Valid values are: C<"REQUEST">, C<"JWT">
136  
137 =head2 AuthorizerUri => Str
138  
139 The authorizer's Uniform Resource Identifier (URI). For REQUEST
140 authorizers, this must be a well-formed Lambda function URI, for
141 example,
142 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.
143 In general, the URI has this form:
144 arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region}
145 is the same as the region hosting the Lambda function, path indicates
146 that the remaining substring in the URI should be treated as the path
147 to the resource, including the initial /. For Lambda functions, this is
148 usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
149 Supported only for REQUEST authorizers.
150  
151  
152  
153 =head2 EnableSimpleResponses => Bool
154  
155 Specifies whether a Lambda authorizer returns a response in a simple
156 format. By default, a Lambda authorizer must return an IAM policy. If
157 enabled, the Lambda authorizer can return a boolean value instead of an
158 IAM policy. Supported only for HTTP APIs. To learn more, see Working
159 with AWS Lambda authorizers for HTTP APIs
160 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html)
161  
162  
163  
164 =head2 IdentitySource => ArrayRef[Str|Undef]
165  
166 The identity source for which authorization is requested.
167  
168 For a REQUEST authorizer, this is optional. The value is a set of one
169 or more mapping expressions of the specified request parameters. The
170 identity source can be headers, query string parameters, stage
171 variables, and context parameters. For example, if an Auth header and a
172 Name query string parameter are defined as identity sources, this value
173 is route.request.header.Auth, route.request.querystring.Name for
174 WebSocket APIs. For HTTP APIs, use selection expressions prefixed with
175 $, for example, $request.header.Auth, $request.querystring.Name. These
176 parameters are used to perform runtime validation for Lambda-based
177 authorizers by verifying all of the identity-related request parameters
178 are present in the request, not null, and non-empty. Only when this is
179 true does the authorizer invoke the authorizer Lambda function.
180 Otherwise, it returns a 401 Unauthorized response without calling the
181 Lambda function. For HTTP APIs, identity sources are also used as the
182 cache key when caching is enabled. To learn more, see Working with AWS
183 Lambda authorizers for HTTP APIs
184 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
185  
186 For JWT, a single entry that specifies where to extract the JSON Web
187 Token (JWT) from inbound requests. Currently only header-based and
188 query parameter-based selections are supported, for example
189 $request.header.Authorization.
190  
191  
192  
193 =head2 IdentityValidationExpression => Str
194  
195 This parameter is not used.
196  
197  
198  
199 =head2 JwtConfiguration => L<Paws::ApiGatewayV2::JWTConfiguration>
200  
201 Represents the configuration of a JWT authorizer. Required for the JWT
202 authorizer type. Supported only for HTTP APIs.
203  
204  
205  
206 =head2 Name => Str
207  
208 The name of the authorizer.
209  
210  
211  
212  
213 =head1 SEE ALSO
214  
215 This class forms part of L<Paws>, documenting arguments for method UpdateAuthorizer in L<Paws::ApiGatewayV2>
216  
217 =head1 BUGS and CONTRIBUTIONS
218  
219 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
220  
221 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
222  
223 =cut
224