class Aws::APIGateway::Types::RestApi

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

@!attribute [rw] id

The API's identifier. This identifier is unique across all of your
APIs in API Gateway.
@return [String]

@!attribute [rw] name

The API's name.
@return [String]

@!attribute [rw] description

The API's description.
@return [String]

@!attribute [rw] created_date

The timestamp when the API was created.
@return [Time]

@!attribute [rw] version

A version identifier for the API.
@return [String]

@!attribute [rw] warnings

The warning messages reported when `failonwarnings` is turned on
during API import.
@return [Array<String>]

@!attribute [rw] binary_media_types

The list of binary media types supported by the RestApi. By default,
the RestApi supports only UTF-8-encoded text payloads.
@return [Array<String>]

@!attribute [rw] minimum_compression_size

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.
@return [Integer]

@!attribute [rw] api_key_source

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.
@return [String]

@!attribute [rw] endpoint_configuration

The endpoint configuration of this RestApi showing the endpoint
types of the API.
@return [Types::EndpointConfiguration]

@!attribute [rw] policy

A stringified JSON policy document that applies to this RestApi
regardless of the caller and Method configuration.
@return [String]

@!attribute [rw] tags

The collection of tags. Each tag element is associated with a given
resource.
@return [Hash<String,String>]

@!attribute [rw] disable_execute_api_endpoint

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.
@return [Boolean]

Constants

SENSITIVE