rest_api

Gets an individual rest_api resource

Overview

Name	rest_api
Type	Resource
Description	rest_api
Id	awscc.apigateway.rest_api

Fields

Name	Datatype	Description
rest_api_id	string
root_resource_id	string
api_key_source_type	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.
binary_media_types	array	The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
body	object	An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
body_s3_location	object	The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
clone_from	string	The ID of the RestApi that you want to clone from.
endpoint_configuration	object	A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property.
description	string	The description of the RestApi.
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
fail_on_warnings	boolean	A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``.
name	string	The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
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.
mode	string	This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates.<br/> Valid values are ``overwrite`` or ``merge``. <br/> For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged.<br/> For ``merge``, the new API definition is merged with the existing API.<br/> If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. <br/> Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
policy	object	A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``""`` as delimiter and values of ``"execute-api:/"`` and ``"*"``.
parameters	object	Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``.
tags	array	The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
rest_api_id,
root_resource_id,
api_key_source_type,
binary_media_types,
body,
body_s3_location,
clone_from,
endpoint_configuration,
description,
disable_execute_api_endpoint,
fail_on_warnings,
name,
minimum_compression_size,
mode,
policy,
parameters,
tags
FROM awscc.apigateway.rest_api
WHERE data__Identifier = '<RestApiId>';

Permissions

To operate on the rest_api resource, the following permissions are required:

Read

apigateway:GET

Update

apigateway:GET,
apigateway:DELETE,
apigateway:PATCH,
apigateway:PUT,
apigateway:UpdateRestApiPolicy,
s3:GetObject,
iam:PassRole

Delete

apigateway:DELETE