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
- Struct
- Aws::APIGateway::Types::RestApi
- Defined in:
- (unknown)
Overview
Represents a REST API.
Returned by:
Instance Attribute Summary collapse
-
#api_key_source ⇒ String
The source of the API key for metering 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.
-
#disable_execute_api_endpoint ⇒ Boolean
Specifies whether clients can invoke your API by using the default
execute-api
endpoint. -
#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 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.
-
#name ⇒ String
The API\'s name.
-
#policy ⇒ String
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
-
#tags ⇒ Hash<String,String>
The collection of tags.
-
#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 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
#binary_media_types ⇒ Array<String>
#created_date ⇒ Time
The timestamp when the API was created.
#description ⇒ String
The API\'s description.
#disable_execute_api_endpoint ⇒ Boolean
Specifies 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.
#endpoint_configuration ⇒ Types::EndpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.
#id ⇒ String
The API\'s identifier. This identifier is unique across all of your APIs in API Gateway.
#minimum_compression_size ⇒ 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. 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.
#name ⇒ String
The API\'s name.
#policy ⇒ String
A 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 ⇒ String
A version identifier for the API.
#warnings ⇒ Array<String>
The warning messages reported when failonwarnings
is turned on during
API import.