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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#api_key_sourceString

The source of the API key for metering 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.

Possible values:

  • HEADER
  • AUTHORIZER

Returns:

  • (String)

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

#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>)

    The list of binary media types supported by the RestApi.

#created_dateTime

The timestamp when the API was created.

Returns:

  • (Time)

    The timestamp when the API was created.

#descriptionString

The API\'s description.

Returns:

  • (String)

    The API\'s description.

#endpoint_configurationTypes::EndpointConfiguration

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

Returns:

#idString

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

Returns:

  • (String)

    The API\'s identifier.

#minimum_compression_sizeInteger

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is 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)

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

#nameString

The API\'s name.

Returns:

  • (String)

    The API\'s name.

#policyString

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Returns:

  • (String)

    A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

#tagsHash<String,String>

The collection of tags. Each tag element is associated with a given resource.

Returns:

  • (Hash<String,String>)

    The collection of tags.

#versionString

A version identifier for the API.

Returns:

  • (String)

    A version identifier for the API.

#warningsArray<String>

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

Returns:

  • (Array<String>)

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