Class: Aws::APIGateway::Types::Integration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

<div class=“remarks”> In the API Gateway console, the built-in Lambda integration is an AWS integration. </div>

<div class=“seeAlso” markdown=“1”>

Creating an API][1

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_key_parameters ⇒ Array<String>

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`.

Returns:

  • (Array<String>) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#cache_namespace ⇒ String

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.

Returns:

  • (String) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#connection_id ⇒ String

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

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

Returns:

  • (String) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#connection_type ⇒ String

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`.

Returns:

  • (String) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#content_handling ⇒ String

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.

Returns:

  • (String) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#credentials ⇒ String

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To require that the caller’s identity be passed through from the request, specify the string ‘arn:aws:iam:::user/`. To use resource-based permissions on supported AWS services, specify null.

Returns:

  • (String) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#http_method ⇒ String

Specifies the integration’s HTTP method type.

Returns:

  • (String) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#integration_responses ⇒ Hash<String,Types::IntegrationResponse>

Specifies the integration’s responses.

<div class=“remarks” markdown=“1”>

#### Example: Get integration responses of a method

##### Request

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential=\{access_key_ID\}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=\{sig4_hash\}

##### Response

The successful response returns ‘200 OK` status and a payload as follows:

\{ "_links": \{ "curies": \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-\{rel\}.html", "name": "integrationresponse", "templated": true \}, "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" \}, "integrationresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \}, "integrationresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \} \}, "responseParameters": \{ "method.response.header.Content-Type": "'application/xml'" \}, "responseTemplates": \{ "application/json": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E")\n" \}, "statusCode": "200" \}

</div>

<div class=“seeAlso” markdown=“1”>

Creating an API][1

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html

Returns:



4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#passthrough_behavior ⇒ String

<div markdown=“1”> Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in ‘requestTemplates`. The valid value is one of the following:

  • ‘WHEN_NO_MATCH`: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.

  • ‘WHEN_NO_TEMPLATES`: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP `415 Unsupported Media Type` response.

  • ‘NEVER`: rejects the method request with an HTTP `415 Unsupported Media Type` response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

</div>

Returns:

  • (String) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#request_parameters ⇒ Hash<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>) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#request_templates ⇒ 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. The content type value is the key in this map, and the template (as a String) is the value.

Returns:

  • (Hash<String,String>) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_millis ⇒ Integer

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

Returns:

  • (Integer) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#tls_config ⇒ Types::TlsConfig

Specifies the TLS configuration for an integration.

Returns:



4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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

  • ‘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.

  • ‘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.

  • ‘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.

  • ‘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.

  • ‘MOCK`: for integrating the API method request with API Gateway as a “loop-back” endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (‘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 `connectionType` of `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.

Returns:

  • (String) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#uri ⇒ String

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], 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:Aws::APIGateway::Types::Integration.subdomainsubdomain.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]: en.wikipedia.org/wiki/Uniform_Resource_Identifier

Returns:

  • (String) 


4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4864

class Integration < Struct.new(
  :type,
  :http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :content_handling,
  :timeout_in_millis,
  :cache_namespace,
  :cache_key_parameters,
  :integration_responses,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end