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

Class: Aws::ApiGatewayV2::Types::UpdateApiRequest

Inherits:

Struct

• Object
• Struct
• Aws::ApiGatewayV2::Types::UpdateApiRequest

Defined in:

gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Note:

When making an API call, you may pass UpdateApiRequest data as a hash:

{
  api_id: "__string", # required
  api_key_selection_expression: "SelectionExpression",
  description: "StringWithLengthBetween0And1024",
  disable_schema_validation: false,
  name: "StringWithLengthBetween1And128",
  route_selection_expression: "SelectionExpression",
  version: "StringWithLengthBetween1And64",
}

Instance Attribute Summary

• #api_id ⇒ String
• #api_key_selection_expression ⇒ String

  An expression used to extract information at runtime.

• #description ⇒ String

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

• #disable_schema_validation ⇒ Boolean
• #name ⇒ String

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

• #route_selection_expression ⇒ String

  An expression used to extract information at runtime.

• #version ⇒ String

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

Instance Attribute Details

#api_id ⇒ String

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4801

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

#api_key_selection_expression ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4801

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

#description ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4801

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

#disable_schema_validation ⇒ Boolean

Returns:

• (Boolean)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4801

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

#name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4801

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

#route_selection_expression ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4801

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

#version ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4801

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