Class: Aws::ApiGatewayV2::Types::UpdateIntegrationRequest

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

Overview

Note:

When making an API call, you may pass UpdateIntegrationRequest data as a 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_id: "__string", # required
  integration_method: "StringWithLengthBetween1And64",
  integration_type: "AWS", # 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",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#connection_idString

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

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#connection_typeString

Represents a connection type.

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#content_handling_strategyString

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

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#credentials_arnString

Represents an Amazon Resource Name (ARN).

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#integration_idString

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#integration_methodString

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

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#integration_typeString

Represents an API method integration type.

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#integration_uriString

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

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#passthrough_behaviorString

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

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#payload_format_versionString

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

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

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


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

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


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#template_selection_expressionString

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

Returns:

  • (String)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_millisInteger

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

Returns:

  • (Integer)


6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

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



6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6980

class UpdateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end