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

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