You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::RestApiThe source of the API key for metering requests according to a usage plan.
The list of binary media types supported by the RestApi.
The timestamp when the API was created.
The API\'s description.
Specifies whether clients can invoke your API by using the default execute-api
endpoint.
The endpoint configuration of this RestApi showing the endpoint types of the API.
The API\'s identifier.
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.
The API\'s name.
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
The collection of tags.
A version identifier for the API.
The warning messages reported when failonwarnings
is turned on during API import.
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:
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
#created_date ⇒ TimeThe timestamp when the API was created.
#disable_execute_api_endpoint ⇒ BooleanSpecifies whether clients can invoke your API by using the default execute-api
endpoint. By default, clients can invoke your API with the default https://`{api_id" target="_parent" title="api_id">https://`{api_id</a>">api_id">https://`{api_id.execute-api.region`.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
The API\'s identifier. This identifier is unique across all of your APIs in API Gateway.
#minimum_compression_size ⇒ IntegerA 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.
#policy ⇒ StringA stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
#tags ⇒ Hash<String,String>The collection of tags. Each tag element is associated with a given resource.
#version ⇒ StringA version identifier for the API.
#warnings ⇒ Array<String>The warning messages reported when failonwarnings
is turned on during API import.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4