Skip to main content

rest_apis

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

Overview​

Namerest_apis
TypeResource
DescriptionThe ``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.
Idawscc.apigateway.rest_apis

Fields​

NameDatatypeDescription
policyobjectA 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_locationobjectThe 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.
descriptionstring
minimum_compression_sizeinteger
parametersobject
clone_fromstring
modestringThis property applies only when you use OpenAPI to define your REST API. The &#96;&#96;Mode&#96;&#96; determines how API Gateway handles resource updates.<br />Valid values are &#96;&#96;overwrite&#96;&#96; or &#96;&#96;merge&#96;&#96;. <br />For &#96;&#96;overwrite&#96;&#96;, the new API definition replaces the existing one. The existing API identifier remains unchanged.<br />For &#96;&#96;merge&#96;&#96;, 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 &#96;&#96;overwrite&#96;&#96;. 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 &#96;&#96;RestApi&#96;&#96; properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
rest_api_idstring
disable_execute_api_endpointboolean
fail_on_warningsboolean
binary_media_typesarray
namestringThe name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
root_resource_idstring
api_key_source_typestring
▶endpoint_configurationobjectA 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 &#96;&#96;Parameters&#96;&#96; property.
bodyobjectAn OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
▶tagsarray
regionstringAWS region.

For more information, see AWS::ApiGateway::RestApi.

Methods​

NameResourceAccessible byRequired Params
create_resourcerest_apisINSERTregion
delete_resourcerest_apisDELETEIdentifier, region
update_resourcerest_apisUPDATEIdentifier, PatchDocument, region
list_resourcesrest_apis_list_onlySELECTregion
get_resourcerest_apisSELECTIdentifier, region

SELECT examples​

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 awscc.apigateway.rest_apis
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ rest_api_id }}';

INSERT example​

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

/*+ create */
INSERT INTO awscc.apigateway.rest_apis (
  Policy,
  BodyS3Location,
  Description,
  MinimumCompressionSize,
  Parameters,
  CloneFrom,
  Mode,
  DisableExecuteApiEndpoint,
  FailOnWarnings,
  BinaryMediaTypes,
  Name,
  ApiKeySourceType,
  EndpointConfiguration,
  Body,
  Tags,
  region
)
SELECT
  '{{ policy }}',
  '{{ body_s3_location }}',
  '{{ description }}',
  '{{ minimum_compression_size }}',
  '{{ parameters }}',
  '{{ clone_from }}',
  '{{ mode }}',
  '{{ disable_execute_api_endpoint }}',
  '{{ fail_on_warnings }}',
  '{{ binary_media_types }}',
  '{{ name }}',
  '{{ api_key_source_type }}',
  '{{ endpoint_configuration }}',
  '{{ body }}',
  '{{ tags }}',
  '{{ region }}';

UPDATE example​

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

/*+ update */
UPDATE awscc.apigateway.rest_apis
SET PatchDocument = string('{{ {
    "Policy": policy,
    "BodyS3Location": body_s3_location,
    "Description": description,
    "MinimumCompressionSize": minimum_compression_size,
    "Parameters": parameters,
    "CloneFrom": clone_from,
    "Mode": mode,
    "DisableExecuteApiEndpoint": disable_execute_api_endpoint,
    "FailOnWarnings": fail_on_warnings,
    "BinaryMediaTypes": binary_media_types,
    "Name": name,
    "ApiKeySourceType": api_key_source_type,
    "EndpointConfiguration": endpoint_configuration,
    "Body": body,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ rest_api_id }}';

DELETE example​

/*+ delete */
DELETE FROM awscc.apigateway.rest_apis
WHERE
  Identifier = '{{ rest_api_id }}' AND
  region = 'us-east-1';

Permissions​

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

apigateway:GET