class Aws::APIGateway::Types::PutIntegrationRequest

Sets up a method's integration.

@note When making an API call, you may pass PutIntegrationRequest

data as a hash:

    {
      rest_api_id: "String", # required
      resource_id: "String", # required
      http_method: "String", # required
      type: "HTTP", # required, accepts HTTP, AWS, MOCK, HTTP_PROXY, AWS_PROXY
      integration_http_method: "String",
      uri: "String",
      connection_type: "INTERNET", # accepts INTERNET, VPC_LINK
      connection_id: "String",
      credentials: "String",
      request_parameters: {
        "String" => "String",
      },
      request_templates: {
        "String" => "String",
      },
      passthrough_behavior: "String",
      cache_namespace: "String",
      cache_key_parameters: ["String"],
      content_handling: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
      timeout_in_millis: 1,
      tls_config: {
        insecure_skip_verification: false,
      },
    }

@!attribute [rw] rest_api_id

\[Required\] The string identifier of the associated RestApi.
@return [String]

@!attribute [rw] resource_id

\[Required\] Specifies a put integration request's resource ID.
@return [String]

@!attribute [rw] http_method

\[Required\] Specifies a put integration request's HTTP method.
@return [String]

@!attribute [rw] type

\[Required\] Specifies a put integration input's type.
@return [String]

@!attribute [rw] integration_http_method

Specifies a put integration HTTP method. When the integration type
is HTTP or AWS, this field is required.
@return [String]

@!attribute [rw] uri

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

* For `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully
  formed, encoded HTTP(S) URL according to the [RFC-3986
  specification][1], for either standard integration, where
  `connectionType` is not `VPC_LINK`, or private integration, where
  `connectionType` is `VPC_LINK`. For a private HTTP integration,
  the URI is not used for routing.

* For `AWS` or `AWS_PROXY` integrations, the URI is of the form
  `arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api\}`.
  Here, `\{Region\}` is the API Gateway region (e.g., `us-east-1`);
  `\{service\}` is the name of the integrated AWS service (e.g.,
  `s3`); and `\{subdomain\}` is a designated subdomain supported by
  certain AWS service for fast host-name lookup. `action` can be
  used for an AWS service action-based API, using an
  `Action=\{name\}&\{p1\}=\{v1\}&p2=\{v2\}...` query string. The
  ensuing `\{service_api\}` refers to a supported action `\{name\}`
  plus any required input parameters. Alternatively, `path` can be
  used for an AWS service path-based API. The ensuing `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 `GetObject`, the `uri` can be
  either
  `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}`
  or `arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}`

[1]: https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
@return [String]

@!attribute [rw] connection_type

The type of the network connection to the integration endpoint. The
valid value is `INTERNET` for connections through the public
routable internet or `VPC_LINK` for private connections between API
Gateway and a network load balancer in a VPC. The default value is
`INTERNET`.
@return [String]

@!attribute [rw] connection_id

The ([`id`][1]) of the VpcLink used for the integration when
`connectionType=VPC_LINK` and undefined, otherwise.

[1]: https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id
@return [String]

@!attribute [rw] credentials

Specifies whether credentials are required for a put integration.
@return [String]

@!attribute [rw] request_parameters

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.
@return [Hash<String,String>]

@!attribute [rw] request_templates

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.
@return [Hash<String,String>]

@!attribute [rw] passthrough_behavior

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.
@return [String]

@!attribute [rw] cache_namespace

Specifies a group of related cached parameters. By default, API
Gateway uses the resource ID as the `cacheNamespace`. You can
specify the same `cacheNamespace` across resources to return the
same cached data for requests to different resources.
@return [String]

@!attribute [rw] cache_key_parameters

A list of request parameters whose values API Gateway caches. To be
valid values for `cacheKeyParameters`, these parameters must also be
specified for Method `requestParameters`.
@return [Array<String>]

@!attribute [rw] content_handling

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 `passthroughBehavior` is configured
to support payload pass-through.
@return [String]

@!attribute [rw] timeout_in_millis

Custom timeout between 50 and 29,000 milliseconds. The default value
is 29,000 milliseconds or 29 seconds.
@return [Integer]

@!attribute [rw] tls_config

@return [Types::TlsConfig]

Constants

SENSITIVE