You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::PutIntegrationRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutIntegrationRequest as input to an Aws::Client method, you can use a vanilla 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,
}

Sets up a method's integration.

Instance Attribute Summary collapse

Instance Attribute Details

#cache_key_parametersArray<String>

Specifies a put integration input\'s cache key parameters.

Returns:

  • (Array<String>)

    Specifies a put integration input\'s cache key parameters.

#cache_namespaceString

Specifies a put integration input\'s cache namespace.

Returns:

  • (String)

    Specifies a put integration input\'s cache namespace.

#connection_idString

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

Returns:

  • (String)

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

#connection_typeString

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.

Possible values:

  • INTERNET
  • VPC_LINK

Returns:

  • (String)

    The type of the network connection to the integration endpoint.

#content_handlingString

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.

Possible values:

  • CONVERT_TO_BINARY
  • CONVERT_TO_TEXT

Returns:

  • (String)

    Specifies how to handle request payload content type conversions.

#credentialsString

Specifies whether credentials are required for a put integration.

Returns:

  • (String)

    Specifies whether credentials are required for a put integration.

#http_methodString

Specifies a put integration request\'s HTTP method.

Returns:

  • (String)

    Specifies a put integration request\'s HTTP method.

#integration_http_methodString

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

Returns:

  • (String)

    Specifies a put integration HTTP method.

#passthrough_behaviorString

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.

Returns:

  • (String)

    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.

#request_parametersHash<String,String>

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.

Returns:

  • (Hash<String,String>)

    A key-value map specifying request parameters that are passed from the method request to the back end.

#request_templatesHash<String,String>

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.

Returns:

  • (Hash<String,String>)

    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.

#resource_idString

Specifies a put integration request\'s resource ID.

Returns:

  • (String)

    Specifies a put integration request\'s resource ID.

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)

    The string identifier of the associated RestApi.

#timeout_in_millisInteger

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

Returns:

  • (Integer)

    Custom timeout between 50 and 29,000 milliseconds.

#typeString

Specifies a put integration input\'s type.

Possible values:

  • HTTP
  • AWS
  • MOCK
  • HTTP_PROXY
  • AWS_PROXY

Returns:

  • (String)

    Specifies a put integration input\'s type.

#uriString

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 specificationtarget="_blank", 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}`

Returns:

  • (String)

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