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

Class: Aws::APIGateway::Types::CreateRestApiRequest

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

Overview

Note:

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

{
  name: "String", # required
  description: "String",
  version: "String",
  clone_from: "String",
  binary_media_types: ["String"],
}

The POST Request to add a new RestApi resource to your collection.

Instance Attribute Summary collapse

Instance Attribute Details

#binary_media_typesArray<String>

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Returns:

  • (Array<String>)


988
989
990
991
992
993
994
995
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 988

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types)
  include Aws::Structure
end

#clone_fromString

The ID of the RestApi that you want to clone from.

Returns:

  • (String)


988
989
990
991
992
993
994
995
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 988

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types)
  include Aws::Structure
end

#descriptionString

The description of the RestApi.

Returns:

  • (String)


988
989
990
991
992
993
994
995
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 988

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types)
  include Aws::Structure
end

#nameString

The name of the RestApi.

Returns:

  • (String)


988
989
990
991
992
993
994
995
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 988

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types)
  include Aws::Structure
end

#versionString

A version identifier for the API.

Returns:

  • (String)


988
989
990
991
992
993
994
995
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 988

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types)
  include Aws::Structure
end