/ 
Paws-0.35
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ApiGateway::PutIntegration

NAME

Paws::ApiGateway::PutIntegration - Arguments for method PutIntegration on Paws::ApiGateway

DESCRIPTION

This class represents the parameters used for calling the method PutIntegration on the Amazon API Gateway service. Use the attributes of this class as arguments to method PutIntegration.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutIntegration.

As an example:

$service_obj->PutIntegration(Att1 => $value1, Att2 => $value2, ...);

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.

ATTRIBUTES

CacheKeyParameters => ArrayRef[Str|Undef]

Specifies a put integration input's cache key parameters.

CacheNamespace => Str

Specifies a put integration input's cache namespace.

ContentHandling => Str

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

Valid values are: "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Credentials => Str

Specifies whether credentials are required for a put integration.

REQUIRED HttpMethod => Str

Specifies a put integration request's HTTP method.

IntegrationHttpMethod => Str

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

PassthroughBehavior => Str

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

RequestParameters => 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 method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

RequestTemplates => 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.

REQUIRED ResourceId => Str

Specifies a put integration request's resource ID.

REQUIRED RestApiId => Str

The string identifier of the associated RestApi.

REQUIRED Type => Str

Specifies a put integration input's type.

Valid values are: "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"

Uri => Str

Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /.

SEE ALSO

This class forms part of Paws, documenting arguments for method PutIntegration in Paws::ApiGateway

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues