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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::Integration

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cache_key_parameters ⇒ Array<String>

  A list of request parameters whose values API Gateway caches.

• #cache_namespace ⇒ String

  Specifies a group of related cached parameters.

• #connection_id ⇒ String

  The ID of the VpcLink used for the integration when ‘connectionType=VPC_LINK` and undefined, otherwise.

• #connection_type ⇒ String

  The type of the network connection to the integration endpoint.

• #content_handling ⇒ String

  Specifies how to handle request payload content type conversions.

• #credentials ⇒ String

  Specifies the credentials required for the integration, if any.

• #http_method ⇒ String

  Specifies the integration’s HTTP method type.

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

  Specifies the integration’s responses.

• #passthrough_behavior ⇒ String

  Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation.

• #request_parameters ⇒ Hash<String,String>

  A key-value map specifying request parameters that are passed from the method request to the back 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.

• #timeout_in_millis ⇒ Integer

  Custom timeout between 50 and 29,000 milliseconds.

• #tls_config ⇒ Types::TlsConfig

  Specifies the TLS configuration for an integration.

• #type ⇒ String

  Specifies an API method integration type.

• #uri ⇒ String

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

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>)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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:

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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 Amazon Web Services services, specify null.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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. For the Type property, if you specify ‘MOCK`, this property is optional. For Lambda integrations, you must set the integration method to `POST`. For all other types, you must specify this property.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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.

Returns:

• (Hash<String,Types::IntegrationResponse>)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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

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.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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>)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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>)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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:

• (Types::TlsConfig)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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:

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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 standard integrations. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name. 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 Amazon Web Services service (e.g., s3); and subdomain is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action=name&amp;p1=v1&amp;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 Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services 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)

# File 'lib/aws-sdk-apigateway/types.rb', line 3605

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