Method: Aws::APIGateway::Types::Integration#uri

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

#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