API Gateway API

This table represents the API Gateway API resource from Amazon Web Services.

aws.apigateway_api

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
api_arncorestring
api_key_sourcecorestringThe source of the API key for metering requests according to a usage plan. Valid values are: &gt;<code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. <code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.
binary_media_typescorearray<string>The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
created_datecoretimestampThe timestamp when the API was created.
descriptioncorestringThe API's description.
disable_execute_api_endpointcoreboolSpecifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint. By default, clients can invoke your API with the default <code>https://{api_id}.execute-api.{region}.amazonaws.com</code> endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
endpoint_configurationcorejsonThe endpoint configuration of this RestApi showing the endpoint types of the API.
idcorestringThe API's identifier. This identifier is unique across all of your APIs in API Gateway.
minimum_compression_sizecoreint64A 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.
namecorestringThe API's name.
policycorestringA stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
root_resource_idcorestringThe API's root resource ID.
tagscorehstore
versioncorestringA version identifier for the API.
warningscorearray<string>The warning messages reported when <code>failonwarnings</code> is turned on during API import.