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

filter: Statementstmt 0.0% 0 / 43 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 44 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::Integration;
3 use Moose;
4 has ApiGatewayManaged => (is => 'ro', isa => 'Bool', request_name => 'apiGatewayManaged', traits => ['NameInRequest']);
5 has ConnectionId => (is => 'ro', isa => 'Str', request_name => 'connectionId', traits => ['NameInRequest']);
6 has ConnectionType => (is => 'ro', isa => 'Str', request_name => 'connectionType', traits => ['NameInRequest']);
7 has ContentHandlingStrategy => (is => 'ro', isa => 'Str', request_name => 'contentHandlingStrategy', traits => ['NameInRequest']);
8 has CredentialsArn => (is => 'ro', isa => 'Str', request_name => 'credentialsArn', traits => ['NameInRequest']);
9 has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']);
10 has IntegrationId => (is => 'ro', isa => 'Str', request_name => 'integrationId', traits => ['NameInRequest']);
11 has IntegrationMethod => (is => 'ro', isa => 'Str', request_name => 'integrationMethod', traits => ['NameInRequest']);
12 has IntegrationResponseSelectionExpression => (is => 'ro', isa => 'Str', request_name => 'integrationResponseSelectionExpression', traits => ['NameInRequest']);
13 has IntegrationSubtype => (is => 'ro', isa => 'Str', request_name => 'integrationSubtype', traits => ['NameInRequest']);
14 has IntegrationType => (is => 'ro', isa => 'Str', request_name => 'integrationType', traits => ['NameInRequest']);
15 has IntegrationUri => (is => 'ro', isa => 'Str', request_name => 'integrationUri', traits => ['NameInRequest']);
16 has PassthroughBehavior => (is => 'ro', isa => 'Str', request_name => 'passthroughBehavior', traits => ['NameInRequest']);
17 has PayloadFormatVersion => (is => 'ro', isa => 'Str', request_name => 'payloadFormatVersion', traits => ['NameInRequest']);
18 has RequestParameters => (is => 'ro', isa => 'Paws::ApiGatewayV2::IntegrationParameters', request_name => 'requestParameters', traits => ['NameInRequest']);
19 has RequestTemplates => (is => 'ro', isa => 'Paws::ApiGatewayV2::TemplateMap', request_name => 'requestTemplates', traits => ['NameInRequest']);
20 has ResponseParameters => (is => 'ro', isa => 'Paws::ApiGatewayV2::ResponseParameters', request_name => 'responseParameters', traits => ['NameInRequest']);
21 has TemplateSelectionExpression => (is => 'ro', isa => 'Str', request_name => 'templateSelectionExpression', traits => ['NameInRequest']);
22 has TimeoutInMillis => (is => 'ro', isa => 'Int', request_name => 'timeoutInMillis', traits => ['NameInRequest']);
23 has TlsConfig => (is => 'ro', isa => 'Paws::ApiGatewayV2::TlsConfig', request_name => 'tlsConfig', traits => ['NameInRequest']);
24  
25 1;
26  
27 ### main pod documentation begin ###
28  
29 =head1 NAME
30  
31 Paws::ApiGatewayV2::Integration
32  
33 =head1 USAGE
34  
35 This class represents one of two things:
36  
37 =head3 Arguments in a call to a service
38  
39 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
40 Each attribute should be used as a named argument in the calls that expect this type of object.
41  
42 As an example, if Att1 is expected to be a Paws::ApiGatewayV2::Integration object:
43  
44 $service_obj->Method(Att1 => { ApiGatewayManaged => $value, ..., TlsConfig => $value });
45  
46 =head3 Results returned from an API call
47  
48 Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::Integration object:
49  
50 $result = $service_obj->Method(...);
51 $result->Att1->ApiGatewayManaged
52  
53 =head1 DESCRIPTION
54  
55 Represents an integration.
56  
57 =head1 ATTRIBUTES
58  
59  
60 =head2 ApiGatewayManaged => Bool
61  
62 Specifies whether an integration is managed by API Gateway. If you
63 created an API using using quick create, the resulting integration is
64 managed by API Gateway. You can update a managed integration, but you
65 can't delete it.
66  
67  
68 =head2 ConnectionId => Str
69  
70 The ID of the VPC link for a private integration. Supported only for
71 HTTP APIs.
72  
73  
74 =head2 ConnectionType => Str
75  
76 The type of the network connection to the integration endpoint. Specify
77 INTERNET for connections through the public routable internet or
78 VPC_LINK for private connections between API Gateway and resources in a
79 VPC. The default value is INTERNET.
80  
81  
82 =head2 ContentHandlingStrategy => Str
83  
84 Supported only for WebSocket APIs. Specifies how to handle response
85 payload content type conversions. Supported values are
86 CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
87  
88 CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
89 string to the corresponding binary blob.
90  
91 CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
92 Base64-encoded string.
93  
94 If this property is not defined, the response payload will be passed
95 through from the integration response to the route response or method
96 response without modification.
97  
98  
99 =head2 CredentialsArn => Str
100  
101 Specifies the credentials required for the integration, if any. For AWS
102 integrations, three options are available. To specify an IAM Role for
103 API Gateway to assume, use the role's Amazon Resource Name (ARN). To
104 require that the caller's identity be passed through from the request,
105 specify the string arn:aws:iam::*:user/*. To use resource-based
106 permissions on supported AWS services, specify null.
107  
108  
109 =head2 Description => Str
110  
111 Represents the description of an integration.
112  
113  
114 =head2 IntegrationId => Str
115  
116 Represents the identifier of an integration.
117  
118  
119 =head2 IntegrationMethod => Str
120  
121 Specifies the integration's HTTP method type.
122  
123  
124 =head2 IntegrationResponseSelectionExpression => Str
125  
126 The integration response selection expression for the integration.
127 Supported only for WebSocket APIs. See Integration Response Selection
128 Expressions
129 (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions).
130  
131  
132 =head2 IntegrationSubtype => Str
133  
134 Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS
135 service action to invoke. To learn more, see Integration subtype
136 reference
137 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html).
138  
139  
140 =head2 IntegrationType => Str
141  
142 The integration type of an integration. One of the following:
143  
144 AWS: for integrating the route or method request with an AWS service
145 action, including the Lambda function-invoking action. With the Lambda
146 function-invoking action, this is referred to as the Lambda custom
147 integration. With any other AWS service action, this is known as AWS
148 integration. Supported only for WebSocket APIs.
149  
150 AWS_PROXY: for integrating the route or method request with a Lambda
151 function or other AWS service action. This integration is also referred
152 to as a Lambda proxy integration.
153  
154 HTTP: for integrating the route or method request with an HTTP
155 endpoint. This integration is also referred to as the HTTP custom
156 integration. Supported only for WebSocket APIs.
157  
158 HTTP_PROXY: for integrating the route or method request with an HTTP
159 endpoint, with the client request passed through as-is. This is also
160 referred to as HTTP proxy integration.
161  
162 MOCK: for integrating the route or method request with API Gateway as a
163 "loopback" endpoint without invoking any backend. Supported only for
164 WebSocket APIs.
165  
166  
167 =head2 IntegrationUri => Str
168  
169 For a Lambda integration, specify the URI of a Lambda function.
170  
171 For an HTTP integration, specify a fully-qualified URL.
172  
173 For an HTTP API private integration, specify the ARN of an Application
174 Load Balancer listener, Network Load Balancer listener, or AWS Cloud
175 Map service. If you specify the ARN of an AWS Cloud Map service, API
176 Gateway uses DiscoverInstances to identify resources. You can use query
177 parameters to target specific resources. To learn more, see
178 DiscoverInstances
179 (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html).
180 For private integrations, all resources must be owned by the same AWS
181 account.
182  
183  
184 =head2 PassthroughBehavior => Str
185  
186 Specifies the pass-through behavior for incoming requests based on the
187 Content-Type header in the request, and the available mapping templates
188 specified as the requestTemplates property on the Integration resource.
189 There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
190 NEVER. Supported only for WebSocket APIs.
191  
192 WHEN_NO_MATCH passes the request body for unmapped content types
193 through to the integration backend without transformation.
194  
195 NEVER rejects unmapped content types with an HTTP 415 Unsupported Media
196 Type response.
197  
198 WHEN_NO_TEMPLATES allows pass-through when the integration has no
199 content types mapped to templates. However, if there is at least one
200 content type defined, unmapped content types will be rejected with the
201 same HTTP 415 Unsupported Media Type response.
202  
203  
204 =head2 PayloadFormatVersion => Str
205  
206 Specifies the format of the payload sent to an integration. Required
207 for HTTP APIs.
208  
209  
210 =head2 RequestParameters => L<Paws::ApiGatewayV2::IntegrationParameters>
211  
212 For WebSocket APIs, a key-value map specifying request parameters that
213 are passed from the method request to the backend. The key is an
214 integration request parameter name and the associated value is a method
215 request parameter value or static value that must be enclosed within
216 single quotes and pre-encoded as required by the backend. The method
217 request parameter value must match the pattern of
218 method.request.{location}.{name} , where {location} is querystring,
219 path, or header; and {name} must be a valid and unique method request
220 parameter name.
221  
222 For HTTP API integrations with a specified integrationSubtype, request
223 parameters are a key-value map specifying parameters that are passed to
224 AWS_PROXY integrations. You can provide static values, or map request
225 data, stage variables, or context variables that are evaluated at
226 runtime. To learn more, see Working with AWS service integrations for
227 HTTP APIs
228 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html).
229  
230 For HTTP API itegrations, without a specified integrationSubtype
231 request parameters are a key-value map specifying how to transform HTTP
232 requests before sending them to backend integrations. The key should
233 follow the pattern
234 E<lt>actionE<gt>:E<lt>header|querystring|pathE<gt>.E<lt>locationE<gt>.
235 The action can be append, overwrite or remove. For values, you can
236 provide static values, or map request data, stage variables, or context
237 variables that are evaluated at runtime. To learn more, see
238 Transforming API requests and responses
239 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html).
240  
241  
242 =head2 RequestTemplates => L<Paws::ApiGatewayV2::TemplateMap>
243  
244 Represents a map of Velocity templates that are applied on the request
245 payload based on the value of the Content-Type header sent by the
246 client. The content type value is the key in this map, and the template
247 (as a String) is the value. Supported only for WebSocket APIs.
248  
249  
250 =head2 ResponseParameters => L<Paws::ApiGatewayV2::ResponseParameters>
251  
252 Supported only for HTTP APIs. You use response parameters to transform
253 the HTTP response from a backend integration before returning the
254 response to clients. Specify a key-value map from a selection key to
255 response parameters. The selection key must be a valid HTTP status code
256 within the range of 200-599. Response parameters are a key-value map.
257 The key must match pattern
258 E<lt>actionE<gt>:E<lt>headerE<gt>.E<lt>locationE<gt> or
259 overwrite.statuscode. The action can be append, overwrite or remove.
260 The value can be a static value, or map to response data, stage
261 variables, or context variables that are evaluated at runtime. To learn
262 more, see Transforming API requests and responses
263 (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html).
264  
265  
266 =head2 TemplateSelectionExpression => Str
267  
268 The template selection expression for the integration. Supported only
269 for WebSocket APIs.
270  
271  
272 =head2 TimeoutInMillis => Int
273  
274 Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs
275 and between 50 and 30,000 milliseconds for HTTP APIs. The default
276 timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
277  
278  
279 =head2 TlsConfig => L<Paws::ApiGatewayV2::TlsConfig>
280  
281 The TLS configuration for a private integration. If you specify a TLS
282 configuration, private integration traffic uses the HTTPS protocol.
283 Supported only for HTTP APIs.
284  
285  
286  
287 =head1 SEE ALSO
288  
289 This class forms part of L<Paws>, describing an object used in L<Paws::ApiGatewayV2>
290  
291 =head1 BUGS and CONTRIBUTIONS
292  
293 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
294  
295 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
296  
297 =cut
298