Class: Aws::ApiGatewayV2::Types::CreateIntegrationResult
- Inherits:
-
Struct
- Object
- Struct
- Aws::ApiGatewayV2::Types::CreateIntegrationResult
- Defined in:
- gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_gateway_managed ⇒ Boolean
-
#connection_id ⇒ String
A string with a length between [1-1024].
-
#connection_type ⇒ String
Represents a connection type.
-
#content_handling_strategy ⇒ String
Specifies how to handle response payload content type conversions.
-
#credentials_arn ⇒ String
Represents an Amazon Resource Name (ARN).
-
#description ⇒ String
A string with a length between [0-1024].
-
#integration_id ⇒ String
The identifier.
-
#integration_method ⇒ String
A string with a length between [1-64].
-
#integration_response_selection_expression ⇒ String
An expression used to extract information at runtime.
-
#integration_subtype ⇒ String
A string with a length between [1-128].
-
#integration_type ⇒ String
Represents an API method integration type.
-
#integration_uri ⇒ String
A string representation of a URI with a length between [1-2048].
-
#passthrough_behavior ⇒ String
Represents passthrough behavior for an integration response.
-
#payload_format_version ⇒ String
A string with a length between [1-64].
-
#request_parameters ⇒ Hash<String,String>
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
-
#request_templates ⇒ Hash<String,String>
A mapping of identifier keys to templates.
-
#response_parameters ⇒ Hash<String,Hash<String,String>>
Supported only for HTTP APIs.
-
#template_selection_expression ⇒ String
An expression used to extract information at runtime.
-
#timeout_in_millis ⇒ Integer
An integer with a value between [50-30000].
-
#tls_config ⇒ Types::TlsConfig
The TLS configuration for a private integration.
Instance Attribute Details
#api_gateway_managed ⇒ Boolean
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#connection_id ⇒ String
A string with a length between [1-1024].
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#connection_type ⇒ String
Represents a connection type.
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#content_handling_strategy ⇒ String
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#credentials_arn ⇒ String
Represents an Amazon Resource Name (ARN).
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A string with a length between [0-1024].
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#integration_id ⇒ String
The identifier.
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#integration_method ⇒ String
A string with a length between [1-64].
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#integration_response_selection_expression ⇒ String
An expression used to extract information at runtime. See Selection Expressions for more information.
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#integration_subtype ⇒ String
A string with a length between [1-128].
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#integration_type ⇒ String
Represents an API method integration type.
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#integration_uri ⇒ String
A string representation of a URI with a length between [1-2048].
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#passthrough_behavior ⇒ String
Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#payload_format_version ⇒ String
A string with a length between [1-64].
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#request_parameters ⇒ Hash<String,String>
For WebSocket APIs, 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.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#request_templates ⇒ Hash<String,String>
A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#response_parameters ⇒ Hash<String,Hash<String,String>>
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#template_selection_expression ⇒ String
An expression used to extract information at runtime. See Selection Expressions for more information.
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#timeout_in_millis ⇒ Integer
An integer with a value between [50-30000].
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |
#tls_config ⇒ Types::TlsConfig
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1730 class CreateIntegrationResult < Struct.new( :api_gateway_managed, :connection_id, :connection_type, :content_handling_strategy, :credentials_arn, :description, :integration_id, :integration_method, :integration_response_selection_expression, :integration_subtype, :integration_type, :integration_uri, :passthrough_behavior, :payload_format_version, :request_parameters, :response_parameters, :request_templates, :template_selection_expression, :timeout_in_millis, :tls_config) SENSITIVE = [] include Aws::Structure end |