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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::CreateRestApiRequest

Includes:

Structure

Defined in:

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"],
  minimum_compression_size: 1,
  api_key_source: "HEADER", # accepts HEADER, AUTHORIZER
  endpoint_configuration: {
    types: ["REGIONAL"], # accepts REGIONAL, EDGE
  },
}

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

Instance Attribute Summary

• #api_key_source ⇒ String

  The source of the API key for metring requests according to a usage plan.

• #binary_media_types ⇒ Array<String>

  The list of binary media types supported by the RestApi.

• #clone_from ⇒ String

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

• #description ⇒ String

  The description of the RestApi.

• #endpoint_configuration ⇒ Types::EndpointConfiguration

  The endpoint configuration of this RestApi showing the endpoint types of the API.

• #minimum_compression_size ⇒ Integer

  A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API.

• #name ⇒ String

  The name of the RestApi.

• #version ⇒ String

  A version identifier for the API.

Instance Attribute Details

#api_key_source ⇒ String

The source of the API key for metring requests according to a usage plan. Valid values are * ‘HEADER` to read the API key from the `X-API-Key` header of a

request.

• ‘AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 1190

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

#binary_media_types ⇒ Array<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>)

# File 'lib/aws-sdk-apigateway/types.rb', line 1190

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

#clone_from ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 1190

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

#description ⇒ String

The description of the RestApi.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 1190

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

#endpoint_configuration ⇒ Types::EndpointConfiguration

The endpoint configuration of this RestApi showing the endpoint types of the API.

Returns:

• (Types::EndpointConfiguration)

# File 'lib/aws-sdk-apigateway/types.rb', line 1190

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

#minimum_compression_size ⇒ Integer

A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API. When compression is enabled, compression or decompression are not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Returns:

• (Integer)

# File 'lib/aws-sdk-apigateway/types.rb', line 1190

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

#name ⇒ String

The name of the RestApi.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 1190

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

#version ⇒ String

A version identifier for the API.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 1190

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