You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ApiGatewayV2::Types::Integration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Represents an integration.

Instance Attribute Summary collapse

Instance Attribute Details

#api_gateway_managedBoolean

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

Returns:

  • (Boolean)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#connection_idString

The connection ID.

Returns:

  • (String)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#connection_typeString

The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.

Returns:

  • (String)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#content_handling_strategyString

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Returns:

  • (String)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#credentials_arnString

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)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#descriptionString

Represents the description of an integration.

Returns:

  • (String)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#integration_idString

Represents the identifier of an integration.

Returns:

  • (String)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#integration_methodString

Specifies the integration's HTTP method type.

Returns:

  • (String)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#integration_response_selection_expressionString

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

Returns:

  • (String)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#integration_typeString

The integration type of an integration. One of the following:

AWS: for integrating the route or 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. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

Returns:

  • (String)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#integration_uriString

For a Lambda proxy integration, this is the URI of the Lambda function.

Returns:

  • (String)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#passthrough_behaviorString

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. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.

Returns:

  • (String)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#payload_format_versionString

Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.

Returns:

  • (String)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#request_parametersHash<String,String>

A key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. 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. Supported only for WebSocket APIs.

Returns:

  • (Hash<String,String>)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#request_templatesHash<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. Supported only for WebSocket APIs.

Returns:

  • (Hash<String,String>)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#template_selection_expressionString

The template selection expression for the integration. Supported only for WebSocket APIs.

Returns:

  • (String)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#timeout_in_millisInteger

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.

Returns:

  • (Integer)


4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4593

class Integration < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end