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

Class: Aws::ApiGatewayV2::Types::CreateIntegrationRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateIntegrationRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  api_id: "__string", # required
  connection_id: "StringWithLengthBetween1And1024",
  connection_type: "INTERNET", # accepts INTERNET, VPC_LINK
  content_handling_strategy: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
  credentials_arn: "Arn",
  description: "StringWithLengthBetween0And1024",
  integration_method: "StringWithLengthBetween1And64",
  integration_subtype: "StringWithLengthBetween1And128",
  integration_type: "AWS", # required, accepts AWS, HTTP, MOCK, HTTP_PROXY, AWS_PROXY
  integration_uri: "UriWithLengthBetween1And2048",
  passthrough_behavior: "WHEN_NO_MATCH", # accepts WHEN_NO_MATCH, NEVER, WHEN_NO_TEMPLATES
  payload_format_version: "StringWithLengthBetween1And64",
  request_parameters: {
    "__string" => "StringWithLengthBetween1And512",
  },
  request_templates: {
    "__string" => "StringWithLengthBetween0And32K",
  },
  template_selection_expression: "SelectionExpression",
  timeout_in_millis: 1,
  tls_config: {
    server_name_to_verify: "StringWithLengthBetween1And512",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_id ⇒ String

Returns:

  • (String)

#connection_id ⇒ String

A string with a length between [1-1024].

Returns:

  • (String) —

    A string with a length between [1-1024].

    .

#connection_type ⇒ String

Represents a connection type.

Possible values:

  • INTERNET
  • VPC_LINK

Returns:

  • (String) —

    Represents a connection type.

    .

#content_handling_strategy ⇒ String

Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.

Possible values:

  • CONVERT_TO_BINARY
  • CONVERT_TO_TEXT

Returns:

  • (String) —

    Specifies how to handle response payload content type conversions.

#credentials_arn ⇒ String

Represents an Amazon Resource Name (ARN).

Returns:

  • (String) —

    Represents an Amazon Resource Name (ARN).

    .

#description ⇒ String

A string with a length between [0-1024].

Returns:

  • (String) —

    A string with a length between [0-1024].

    .

#integration_method ⇒ String

A string with a length between [1-64].

Returns:

  • (String) —

    A string with a length between [1-64].

    .

#integration_subtype ⇒ String

A string with a length between [1-128].

Returns:

  • (String) —

    A string with a length between [1-128].

    .

#integration_type ⇒ String

Represents an API method integration type.

Possible values:

  • AWS
  • HTTP
  • MOCK
  • HTTP_PROXY
  • AWS_PROXY

Returns:

  • (String) —

    Represents an API method integration type.

    .

#integration_uri ⇒ String

A string representation of a URI with a length between [1-2048].

Returns:

  • (String) —

    A string representation of a URI with a length between [1-2048].

    .

#passthrough_behavior ⇒ String

Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.

Possible values:

  • WHEN_NO_MATCH
  • NEVER
  • WHEN_NO_TEMPLATES

Returns:

  • (String) —

    Represents passthrough behavior for an integration response.

#payload_format_version ⇒ String

A string with a length between [1-64].

Returns:

  • (String) —

    A string with a length between [1-64].

    .

#request_parameters ⇒ Hash<String,String>

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.`name`, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.`name` or integration.response.body.`JSON-expression`, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

Returns:

  • (Hash<String,String>) —

    A key-value map specifying response parameters that are passed to the method response from the backend.

#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.

Returns:

  • (Hash<String,String>) —

    A mapping of identifier keys to templates.

#template_selection_expression ⇒ String

An expression used to extract information at runtime. See Selection Expressions for more information.

Returns:

  • (String) —

    An expression used to extract information at runtime.

#timeout_in_millis ⇒ Integer

An integer with a value between [50-30000].

Returns:

  • (Integer) —

    An integer with a value between [50-30000].

    .

#tls_config ⇒ Types::TlsConfigInput

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.

Returns: