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

Inherits:

Struct

Object
Struct
Aws::APIGateway::Types::PutIntegrationRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-apigateway/types.rb

Overview

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",
  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
}

Sets up a method’s integration.

Instance Attribute Summary collapse

#cache_key_parameters ⇒ Array<String>

Specifies a put integration input’s cache key parameters.
#cache_namespace ⇒ String

Specifies a put integration input’s cache namespace.
#content_handling ⇒ String

Specifies how to handle request payload content type conversions.
#credentials ⇒ String

Specifies whether credentials are required for a put integration.
#http_method ⇒ String

Specifies a put integration request’s HTTP method.
#integration_http_method ⇒ String

Specifies a put integration HTTP method.
#passthrough_behavior ⇒ 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_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.
#resource_id ⇒ String

Specifies a put integration request’s resource ID.
#rest_api_id ⇒ String

The string identifier of the associated RestApi.
#type ⇒ String

Specifies a put integration input’s type.
#uri ⇒ String

Specifies the integration’s Uniform Resource Identifier (URI).

Instance Attribute Details

#cache_key_parameters ⇒ `Array<String>`

Specifies a put integration input’s cache key parameters.

Returns:

(Array<String>)

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

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  include Aws::Structure
end

#cache_namespace ⇒ `String`

Specifies a put integration input’s cache namespace.

Returns:

(String)

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

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  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 ‘passthroughBehaviors` is configured to support payload pass-through.

Returns:

(String)

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

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  include Aws::Structure
end

#credentials ⇒ `String`

Specifies whether credentials are required for a put integration.

Returns:

(String)

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

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  include Aws::Structure
end

#http_method ⇒ `String`

Specifies a put integration request’s HTTP method.

Returns:

(String)

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

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  include Aws::Structure
end

#integration_http_method ⇒ `String`

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

Returns:

(String)

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

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  include Aws::Structure
end

#passthrough_behavior ⇒ `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. 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)

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

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  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 4776

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  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 4776

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  include Aws::Structure
end

#resource_id ⇒ `String`

Specifies a put integration request’s resource ID.

Returns:

(String)

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

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  include Aws::Structure
end

#rest_api_id ⇒ `String`

The string identifier of the associated RestApi.

Returns:

(String)

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

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  include Aws::Structure
end

#type ⇒ `String`

Specifies a put integration input’s type.

Returns:

(String)

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

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  include Aws::Structure
end

#uri ⇒ `String`

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:Aws::APIGateway::Types::PutIntegrationRequest.subdomainsubdomain.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 `/`.

[1]: en.wikipedia.org/wiki/Uniform_Resource_Identifier

Returns:

(String)

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

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling)
  include Aws::Structure
end

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#cache_key_parameters ⇒ Array<String>

#cache_namespace ⇒ String

#content_handling ⇒ String

#credentials ⇒ String

#http_method ⇒ String

#integration_http_method ⇒ String

#passthrough_behavior ⇒ String

#request_parameters ⇒ Hash<String,String>

#request_templates ⇒ Hash<String,String>

#resource_id ⇒ String

#rest_api_id ⇒ String

#type ⇒ String

#uri ⇒ String

#cache_key_parameters ⇒ `Array<String>`

#cache_namespace ⇒ `String`

#content_handling ⇒ `String`

#credentials ⇒ `String`

#http_method ⇒ `String`

#integration_http_method ⇒ `String`

#passthrough_behavior ⇒ `String`

#request_parameters ⇒ `Hash<String,String>`

#request_templates ⇒ `Hash<String,String>`

#resource_id ⇒ `String`

#rest_api_id ⇒ `String`

#type ⇒ `String`

#uri ⇒ `String`