NAME
Paws::ApiGateway::RestApi
ATTRIBUTES
ApiKeySource => Str
The source of the API key for metering requests according to a usage plan. Valid values are:
HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
Valid values are: "HEADER", "AUTHORIZER" =head2 BinaryMediaTypes => ArrayRef[Str|Undef]
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
CreatedDate => Str
The timestamp when the API was created.
Description => Str
The API's description.
DisableExecuteApiEndpoint => Bool
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.
EndpointConfiguration => Paws::ApiGateway::EndpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.
Id => Str
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
MinimumCompressionSize => Int
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 => Str
The API's name.
Policy => Str
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Tags => Paws::ApiGateway::MapOfStringToString
The collection of tags. Each tag element is associated with a given resource.
Version => Str
A version identifier for the API.
Warnings => ArrayRef[Str|Undef]
The warning messages reported when failonwarnings is turned on during API import.