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

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