blib/lib/Paws/ApiGatewayV2/UpdateApi.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::UpdateApi;
3 use Moose;
4 has ApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'apiId', required => 1);
5 has ApiKeySelectionExpression => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'apiKeySelectionExpression');
6 has CorsConfiguration => (is => 'ro', isa => 'Paws::ApiGatewayV2::Cors', traits => ['NameInRequest'], request_name => 'corsConfiguration');
7 has CredentialsArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'credentialsArn');
8 has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description');
9 has DisableExecuteApiEndpoint => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'disableExecuteApiEndpoint');
10 has DisableSchemaValidation => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'disableSchemaValidation');
11 has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name');
12 has RouteKey => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'routeKey');
13 has RouteSelectionExpression => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'routeSelectionExpression');
14 has Target => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'target');
15 has Version => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'version');
16  
17 use MooseX::ClassAttribute;
18  
19 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateApi');
20 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/apis/{apiId}');
21 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH');
22 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGatewayV2::UpdateApiResponse');
23 1;
24  
25 ### main pod documentation begin ###
26  
27 =head1 NAME
28  
29 Paws::ApiGatewayV2::UpdateApi - Arguments for method UpdateApi on L<Paws::ApiGatewayV2>
30  
31 =head1 DESCRIPTION
32  
33 This class represents the parameters used for calling the method UpdateApi on the
34 L<AmazonApiGatewayV2|Paws::ApiGatewayV2> service. Use the attributes of this class
35 as arguments to method UpdateApi.
36  
37 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateApi.
38  
39 =head1 SYNOPSIS
40  
41 my $apigateway = Paws->service('ApiGatewayV2');
42 my $UpdateApiResponse = $apigateway->UpdateApi(
43 ApiId => 'My__string',
44 ApiKeySelectionExpression => 'MySelectionExpression', # OPTIONAL
45 CorsConfiguration => {
46 AllowCredentials => 1, # OPTIONAL
47 AllowHeaders => [ 'My__string', ... ], # OPTIONAL
48 AllowMethods => [ 'MyStringWithLengthBetween1And64', ... ], # OPTIONAL
49 AllowOrigins => [ 'My__string', ... ], # OPTIONAL
50 ExposeHeaders => [ 'My__string', ... ], # OPTIONAL
51 MaxAge => 1, # min: -1, max: 86400; OPTIONAL
52 }, # OPTIONAL
53 CredentialsArn => 'MyArn', # OPTIONAL
54 Description => 'MyStringWithLengthBetween0And1024', # OPTIONAL
55 DisableExecuteApiEndpoint => 1, # OPTIONAL
56 DisableSchemaValidation => 1, # OPTIONAL
57 Name => 'MyStringWithLengthBetween1And128', # OPTIONAL
58 RouteKey => 'MySelectionKey', # OPTIONAL
59 RouteSelectionExpression => 'MySelectionExpression', # OPTIONAL
60 Target => 'MyUriWithLengthBetween1And2048', # OPTIONAL
61 Version => 'MyStringWithLengthBetween1And64', # OPTIONAL
62 );
63  
64 # Results:
65 my $ApiEndpoint = $UpdateApiResponse->ApiEndpoint;
66 my $ApiGatewayManaged = $UpdateApiResponse->ApiGatewayManaged;
67 my $ApiId = $UpdateApiResponse->ApiId;
68 my $ApiKeySelectionExpression =
69 $UpdateApiResponse->ApiKeySelectionExpression;
70 my $CorsConfiguration = $UpdateApiResponse->CorsConfiguration;
71 my $CreatedDate = $UpdateApiResponse->CreatedDate;
72 my $Description = $UpdateApiResponse->Description;
73 my $DisableExecuteApiEndpoint =
74 $UpdateApiResponse->DisableExecuteApiEndpoint;
75 my $DisableSchemaValidation = $UpdateApiResponse->DisableSchemaValidation;
76 my $ImportInfo = $UpdateApiResponse->ImportInfo;
77 my $Name = $UpdateApiResponse->Name;
78 my $ProtocolType = $UpdateApiResponse->ProtocolType;
79 my $RouteSelectionExpression = $UpdateApiResponse->RouteSelectionExpression;
80 my $Tags = $UpdateApiResponse->Tags;
81 my $Version = $UpdateApiResponse->Version;
82 my $Warnings = $UpdateApiResponse->Warnings;
83  
84 # Returns a L<Paws::ApiGatewayV2::UpdateApiResponse> object.
85  
86 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.
87 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/UpdateApi>
88  
89 =head1 ATTRIBUTES
90  
91  
92 =head2 B<REQUIRED> ApiId => Str
93  
94 The API identifier.
95  
96  
97  
98 =head2 ApiKeySelectionExpression => Str
99  
100 An API key selection expression. Supported only for WebSocket APIs. See
101 API Key Selection Expressions
102 (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
103  
104  
105  
106 =head2 CorsConfiguration => L<Paws::ApiGatewayV2::Cors>
107  
108 A CORS configuration. Supported only for HTTP APIs.
109  
110  
111  
112 =head2 CredentialsArn => Str
113  
114 This property is part of quick create. It specifies the credentials
115 required for the integration, if any. For a Lambda integration, three
116 options are available. To specify an IAM Role for API Gateway to
117 assume, use the role's Amazon Resource Name (ARN). To require that the
118 caller's identity be passed through from the request, specify
119 arn:aws:iam::*:user/*. To use resource-based permissions on supported
120 AWS services, don't specify this parameter. Currently, this property is
121 not used for HTTP integrations. If provided, this value replaces the
122 credentials associated with the quick create integration. Supported
123 only for HTTP APIs.
124  
125  
126  
127 =head2 Description => Str
128  
129 The description of the API.
130  
131  
132  
133 =head2 DisableExecuteApiEndpoint => Bool
134  
135 Specifies whether clients can invoke your API by using the default
136 execute-api endpoint. By default, clients can invoke your API with the
137 default https://{api_id}.execute-api.{region}.amazonaws.com endpoint.
138 To require that clients use a custom domain name to invoke your API,
139 disable the default endpoint.
140  
141  
142  
143 =head2 DisableSchemaValidation => Bool
144  
145 Avoid validating models when creating a deployment. Supported only for
146 WebSocket APIs.
147  
148  
149  
150 =head2 Name => Str
151  
152 The name of the API.
153  
154  
155  
156 =head2 RouteKey => Str
157  
158 This property is part of quick create. If not specified, the route
159 created using quick create is kept. Otherwise, this value replaces the
160 route key of the quick create route. Additional routes may still be
161 added after the API is updated. Supported only for HTTP APIs.
162  
163  
164  
165 =head2 RouteSelectionExpression => Str
166  
167 The route selection expression for the API. For HTTP APIs, the
168 routeSelectionExpression must be ${request.method} ${request.path}. If
169 not provided, this will be the default for HTTP APIs. This property is
170 required for WebSocket APIs.
171  
172  
173  
174 =head2 Target => Str
175  
176 This property is part of quick create. For HTTP integrations, specify a
177 fully qualified URL. For Lambda integrations, specify a function ARN.
178 The type of the integration will be HTTP_PROXY or AWS_PROXY,
179 respectively. The value provided updates the integration URI and
180 integration type. You can update a quick-created target, but you can't
181 remove it from an API. Supported only for HTTP APIs.
182  
183  
184  
185 =head2 Version => Str
186  
187 A version identifier for the API.
188  
189  
190  
191  
192 =head1 SEE ALSO
193  
194 This class forms part of L<Paws>, documenting arguments for method UpdateApi in L<Paws::ApiGatewayV2>
195  
196 =head1 BUGS and CONTRIBUTIONS
197  
198 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
199  
200 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
201  
202 =cut
203