rest_apis

Creates, updates, deletes or gets a rest_api resource or lists rest_apis in a region

Overview

Name	`rest_apis`
Type	Resource
Description	The `AWS::ApiGateway::RestApi` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the Amazon API Gateway REST API Reference. On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.
Id	`aws.apigateway.rest_apis`

Fields

Name	Datatype	Description
`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 `"*"`.
`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.
`description`	`string`	The description of the RestApi.
`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.
`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'`.
`clone_from`	`string`	The ID of the RestApi that you want to clone from.
`mode`	`string`	This property applies only when you use OpenAPI to define your REST API. The `Mode` determines how API Gateway handles resource updates. Valid values are `overwrite` or `merge`. For `overwrite`, the new API definition replaces the existing one. The existing API identifier remains unchanged. For `merge`, the new API definition is merged with the existing API. 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. 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.
`rest_api_id`	`string`
`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`.
`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.
`name`	`string`	The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
`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.
`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.
`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.
`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

Name	Accessible by	Required Params
`create_resource`	`INSERT`	`region`
`delete_resource`	`DELETE`	`data__Identifier, region`
`update_resource`	`UPDATE`	`data__Identifier, data__PatchDocument, region`
`list_resources`	`SELECT`	`region`
`get_resource`	`SELECT`	`data__Identifier, region`

`SELECT` examples

Gets all rest_apis in a region.

SELECT
region,
policy,
body_s3_location,
description,
minimum_compression_size,
parameters,
clone_from,
mode,
rest_api_id,
disable_execute_api_endpoint,
fail_on_warnings,
binary_media_types,
name,
root_resource_id,
api_key_source_type,
endpoint_configuration,
body,
tags
FROM aws.apigateway.rest_apis
WHERE region = 'us-east-1';

Gets all properties from an individual rest_api.

SELECT
region,
policy,
body_s3_location,
description,
minimum_compression_size,
parameters,
clone_from,
mode,
rest_api_id,
disable_execute_api_endpoint,
fail_on_warnings,
binary_media_types,
name,
root_resource_id,
api_key_source_type,
endpoint_configuration,
body,
tags
FROM aws.apigateway.rest_apis
WHERE region = 'us-east-1' AND data__Identifier = '<RestApiId>';

`INSERT` example

Use the following StackQL query and manifest file to create a new rest_api resource, using stack-deploy.

Required Properties
All Properties
Manifest

/*+ create */
INSERT INTO aws.apigateway.rest_apis (
 Policy,
 BodyS3Location,
 Description,
 MinimumCompressionSize,
 Parameters,
 CloneFrom,
 Mode,
 DisableExecuteApiEndpoint,
 FailOnWarnings,
 BinaryMediaTypes,
 Name,
 ApiKeySourceType,
 EndpointConfiguration,
 Body,
 Tags,
 region
)
SELECT 
'{{ Policy }}',
 '{{ BodyS3Location }}',
 '{{ Description }}',
 '{{ MinimumCompressionSize }}',
 '{{ Parameters }}',
 '{{ CloneFrom }}',
 '{{ Mode }}',
 '{{ DisableExecuteApiEndpoint }}',
 '{{ FailOnWarnings }}',
 '{{ BinaryMediaTypes }}',
 '{{ Name }}',
 '{{ ApiKeySourceType }}',
 '{{ EndpointConfiguration }}',
 '{{ Body }}',
 '{{ Tags }}',
'{{ region }}';

/*+ create */
INSERT INTO aws.apigateway.rest_apis (
 Policy,
 BodyS3Location,
 Description,
 MinimumCompressionSize,
 Parameters,
 CloneFrom,
 Mode,
 DisableExecuteApiEndpoint,
 FailOnWarnings,
 BinaryMediaTypes,
 Name,
 ApiKeySourceType,
 EndpointConfiguration,
 Body,
 Tags,
 region
)
SELECT 
 '{{ Policy }}',
 '{{ BodyS3Location }}',
 '{{ Description }}',
 '{{ MinimumCompressionSize }}',
 '{{ Parameters }}',
 '{{ CloneFrom }}',
 '{{ Mode }}',
 '{{ DisableExecuteApiEndpoint }}',
 '{{ FailOnWarnings }}',
 '{{ BinaryMediaTypes }}',
 '{{ Name }}',
 '{{ ApiKeySourceType }}',
 '{{ EndpointConfiguration }}',
 '{{ Body }}',
 '{{ Tags }}',
 '{{ region }}';

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: rest_api
    props:
      - name: Policy
        value: {}
      - name: BodyS3Location
        value:
          Bucket: '{{ Bucket }}'
          ETag: '{{ ETag }}'
          Version: '{{ Version }}'
          Key: '{{ Key }}'
      - name: Description
        value: '{{ Description }}'
      - name: MinimumCompressionSize
        value: '{{ MinimumCompressionSize }}'
      - name: Parameters
        value: {}
      - name: CloneFrom
        value: '{{ CloneFrom }}'
      - name: Mode
        value: '{{ Mode }}'
      - name: DisableExecuteApiEndpoint
        value: '{{ DisableExecuteApiEndpoint }}'
      - name: FailOnWarnings
        value: '{{ FailOnWarnings }}'
      - name: BinaryMediaTypes
        value:
          - '{{ BinaryMediaTypes[0] }}'
      - name: Name
        value: '{{ Name }}'
      - name: ApiKeySourceType
        value: '{{ ApiKeySourceType }}'
      - name: EndpointConfiguration
        value:
          Types:
            - '{{ Types[0] }}'
          VpcEndpointIds:
            - '{{ VpcEndpointIds[0] }}'
      - name: Body
        value: {}
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

`DELETE` example

/*+ delete */
DELETE FROM aws.apigateway.rest_apis
WHERE data__Identifier = '<RestApiId>'
AND region = 'us-east-1';

Permissions

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

Read

apigateway:GET

Create

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

Update

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

List

apigateway:GET

Delete

apigateway:DELETE

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

DELETE example​

Permissions​

Read​

Create​

Update​

List​

Delete​