Class: Aws::APIGateway::Types::RestApi

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::RestApi

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Represents a REST API.

<div class=“seeAlso”>

Create an API][1

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html

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.

• #created_date ⇒ Time

  The timestamp when the API was created.

• #description ⇒ String

  The API’s description.

• #endpoint_configuration ⇒ Types::EndpointConfiguration

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

• #id ⇒ String

  The API’s identifier.

• #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 API’s name.

• #version ⇒ String

  A version identifier for the API.

• #warnings ⇒ Array<String>

  The warning messages reported when ‘failonwarnings` is turned on during API import.

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 5954

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :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 5954

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration)
  include Aws::Structure
end

#created_date ⇒ Time

The timestamp when the API was created.

Returns:

• (Time)

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

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration)
  include Aws::Structure
end

#description ⇒ String

The API’s description.

Returns:

• (String)

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

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :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 5954

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration)
  include Aws::Structure
end

#id ⇒ String

The API’s identifier. This identifier is unique across all of your APIs in API Gateway.

Returns:

• (String)

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

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :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 5954

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration)
  include Aws::Structure
end

#name ⇒ String

The API’s name.

Returns:

• (String)

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

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :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 5954

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration)
  include Aws::Structure
end

#warnings ⇒ Array<String>

The warning messages reported when ‘failonwarnings` is turned on during API import.

Returns:

• (Array<String>)

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

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration)
  include Aws::Structure
end