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

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

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 CreateIntegrationRequest 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_method: "StringWithLengthBetween1And64",
  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
  request_parameters: {
    "__string" => "StringWithLengthBetween1And512",
  },
  request_templates: {
    "__string" => "StringWithLengthBetween0And32K",
  },
  template_selection_expression: "SelectionExpression",
  timeout_in_millis: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#connection_idString

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

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#connection_typeString

Represents a connection type.

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#content_handling_strategyString

Specifies how to handle response payload content type conversions.

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#credentials_arnString

Represents an Amazon Resource Name (ARN).

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#integration_methodString

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

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#integration_typeString

Represents an API method integration type.

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#integration_uriString

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

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#passthrough_behaviorString

Represents passthrough behavior for an integration response.

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  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>)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  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>)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#template_selection_expressionString

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

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end

#timeout_in_millisInteger

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

Returns:

  • (Integer)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1192

class CreateIntegrationRequest < Struct.new(
  :api_id,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_method,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :request_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis)
  include Aws::Structure
end