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” markdown=“1”>
- Create an API][1
-
</div>
[1]: docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
Constant Summary collapse
- SENSITIVE =
[]
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.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] 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.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#created_date ⇒ Time
The timestamp when the API was created.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The API’s description.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#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\}.execute-api.{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#endpoint_configuration ⇒ Types::EndpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
The API’s identifier. This identifier is unique across all of your APIs in API Gateway.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#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.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The API’s name.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#policy ⇒ String
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
The collection of tags. Each tag element is associated with a given resource.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#version ⇒ String
A version identifier for the API.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#warnings ⇒ Array<String>
The warning messages reported when ‘failonwarnings` is turned on during API import.
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 |
# File 'lib/aws-sdk-apigateway/types.rb', line 6428 class RestApi < Struct.new( :id, :name, :description, :created_date, :version, :warnings, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |