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

Class: Aws::ApiGatewayV2::Types::CreateApiRequest

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 CreateApiRequest data as a hash:

{
  api_key_selection_expression: "SelectionExpression",
  description: "StringWithLengthBetween0And1024",
  disable_schema_validation: false,
  name: "StringWithLengthBetween1And128", # required
  protocol_type: "WEBSOCKET", # required, accepts WEBSOCKET
  route_selection_expression: "SelectionExpression", # required
  version: "StringWithLengthBetween1And64",
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_key_selection_expressionString

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

Returns:

  • (String)


491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 491

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_selection_expression,
  :version)
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 491

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_selection_expression,
  :version)
  include Aws::Structure
end

#disable_schema_validationBoolean

Returns:

  • (Boolean)


491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 491

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_selection_expression,
  :version)
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 491

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_selection_expression,
  :version)
  include Aws::Structure
end

#protocol_typeString

Returns:

  • (String)


491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 491

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_selection_expression,
  :version)
  include Aws::Structure
end

#route_selection_expressionString

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

Returns:

  • (String)


491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 491

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_selection_expression,
  :version)
  include Aws::Structure
end

#versionString

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

Returns:

  • (String)


491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 491

class CreateApiRequest < Struct.new(
  :api_key_selection_expression,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_selection_expression,
  :version)
  include Aws::Structure
end