view release on metacpan or  search on metacpan

lib/Paws/ApiGateway/Integration.pm  view on Meta::CPAN

templates defined in the integration request or no mapping template is
defined in the integration request.

=back



=head2 RequestParameters => L<Paws::ApiGateway::MapOfStringToString>

A key-value map specifying request parameters that are passed from the
method request to the back end. The key is an integration request
parameter name and the associated value is a method request parameter
value or static value that must be enclosed within single quotes and
pre-encoded as required by the back end. The method request parameter
value must match the pattern of C<method.request.{location}.{name}>,
where C<location> is C<querystring>, C<path>, or C<header> and C<name>
must be a valid and unique method request parameter name.


=head2 RequestTemplates => L<Paws::ApiGateway::MapOfStringToString>

Represents a map of Velocity templates that are applied on the request
payload based on the value of the Content-Type header sent by the
client. The content type value is the key in this map, and the template
(as a String) is the value.


=head2 TimeoutInMillis => Int

Custom timeout between 50 and 29,000 milliseconds. The default value is
29,000 milliseconds or 29 seconds.


=head2 TlsConfig => L<Paws::ApiGateway::TlsConfig>

Specifies the TLS configuration for an integration.


=head2 Type => Str

Specifies an API method integration type. The valid value is one of the
following:

=over

=item * C<AWS>: for integrating the API method request with an AWS
service action, including the Lambda function-invoking action. With the
Lambda function-invoking action, this is referred to as the Lambda
custom integration. With any other AWS service action, this is known as
AWS integration.

=item * C<AWS_PROXY>: for integrating the API method request with the
Lambda function-invoking action with the client request passed through
as-is. This integration is also referred to as the Lambda proxy
integration.

=item * C<HTTP>: for integrating the API method request with an HTTP
endpoint, including a private HTTP endpoint within a VPC. This
integration is also referred to as the HTTP custom integration.

=item * C<HTTP_PROXY>: for integrating the API method request with an
HTTP endpoint, including a private HTTP endpoint within a VPC, with the
client request passed through as-is. This is also referred to as the
HTTP proxy integration.

=item * C<MOCK>: for integrating the API method request with API
Gateway as a "loop-back" endpoint without invoking any backend.

=back

For the HTTP and HTTP proxy integrations, each integration can specify
a protocol (C<http/https>), port and path. Standard 80 and 443 ports
are supported as well as custom ports above 1024. An HTTP or HTTP proxy
integration with a C<connectionType> of C<VPC_LINK> is referred to as a
private integration and uses a VpcLink to connect API Gateway to a
network load balancer of a VPC.

Valid values are: C<"HTTP">, C<"AWS">, C<"MOCK">, C<"HTTP_PROXY">, C<"AWS_PROXY">
=head2 Uri => Str

Specifies Uniform Resource Identifier (URI) of the integration
endpoint.

=over

=item *

For C<HTTP> or C<HTTP_PROXY> integrations, the URI must be a fully
formed, encoded HTTP(S) URL according to the RFC-3986 specification
(https://en.wikipedia.org/wiki/Uniform_Resource_Identifier), for either
standard integration, where C<connectionType> is not C<VPC_LINK>, or
private integration, where C<connectionType> is C<VPC_LINK>. For a
private HTTP integration, the URI is not used for routing.

=item *

For C<AWS> or C<AWS_PROXY> integrations, the URI is of the form
C<arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}>.
Here, C<{Region}> is the API Gateway region (e.g., C<us-east-1>);
C<{service}> is the name of the integrated AWS service (e.g., C<s3>);
and C<{subdomain}> is a designated subdomain supported by certain AWS
service for fast host-name lookup. C<action> can be used for an AWS
service action-based API, using an
C<Action={name}&{p1}={v1}&p2={v2}...> query string. The ensuing
C<{service_api}> refers to a supported action C<{name}> plus any
required input parameters. Alternatively, C<path> can be used for an
AWS service path-based API. The ensuing C<service_api> refers to the
path to an AWS service resource, including the region of the integrated
AWS service, if applicable. For example, for integration with the S3
API of C<GetObject
(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html)>,
the C<uri> can be either
C<arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}>
or C<arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}>

=back



=head2 _request_id => Str


=cut