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

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

Overview

Sets up a method’s integration.

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


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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

#connection_id ⇒ String

The ID of the VpcLink used for the integration. Specify this value only if you specify ‘VPC_LINK` as the connection type.

Returns:

  • (String) 


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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

#credentials ⇒ String

Specifies whether credentials are required for a put integration.

Returns:

  • (String) 


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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

#http_method ⇒ String

Specifies the HTTP method for the integration.

Returns:

  • (String) 


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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

#integration_http_method ⇒ String

The HTTP method for the integration.

Returns:

  • (String) 


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

class PutIntegrationRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :type,
  :integration_http_method,
  :uri,
  :connection_type,
  :connection_id,
  :credentials,
  :request_parameters,
  :request_templates,
  :passthrough_behavior,
  :cache_namespace,
  :cache_key_parameters,
  :content_handling,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  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`.

Returns:

  • (String) 


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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

#resource_id ⇒ String

Specifies a put integration request’s resource ID.

Returns:

  • (String) 


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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

#rest_api_id ⇒ String

The string identifier of the associated RestApi.

Returns:

  • (String) 


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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

#tls_config ⇒ Types::TlsConfig

Specifies the TLS configuration for an integration.

Returns:



4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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

#type ⇒ String

Specifies a put integration input’s type.

Returns:

  • (String) 


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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


4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4284

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