aws_api_gateway_restapi Resource
Use the aws_api_gateway_restapi
InSpec audit resource to test properties of a single AWS API Gateway REST API.
The AWS::ApiGateway::RestApi resource creates a REST API.
For additional information, including details on parameters and properties, see the AWS API Gateway REST API documentation.
Install
This resource is available in the Chef InSpec AWS resource pack.
For information on configuring your AWS environment for Chef InSpec and creating an InSpec profile that uses the InSpec AWS resource pack, see the Chef InSpec documentation on the AWS cloud platform.
Syntax
Ensure the rest api exists.
describe aws_api_gateway_restapi(rest_api_id: "REST_API_ID") do
it { should exist }
end
Parameters
rest_api_id
(required)
Properties
id
- The API’s identifier. This identifier is unique across all of your APIs in API Gateway.
name
- The API’s name.
description
- The API’s description.
created_date
- The timestamp when the API was created.
version
- A version identifier for the API.
warnings
- The warning messages reported when
failonwarnings
is turned on during API import. binary_media_types
- The list of binary media types supported by the REST API. By default, the REST API supports only UTF-8-encoded text payloads.
minimum_compression_size
- 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.
api_key_source
- The source of the API key for metering requests according to a usage plan. Valid values are
HEADER
andAUTHORIZER
. endpoint_configuration (types)
- A list of endpoint types of an API or its custom domain name. For an edge-optimized API and its custom domain name, the endpoint type is
EDGE
. For a regional API and its custom domain name, the endpoint type isREGIONAL
. For a private API, the endpoint type isPRIVATE
. endpoint_configuration (vpc_endpoint_ids)
- A list of
VpcEndpointIds
of an API against which to create Route53 aliases. It is only supported forPRIVATE
endpoint type. policy
- A stringified JSON policy document that applies to this REST API regardless of the caller and method configuration.
tags
- The collection of tags. Each tag element is associated with a given resource.
disable_execute_api_endpoint
- Specifies whether clients can invoke your API by using the default execute-api endpoint.
Examples
Ensure the REST API exists.
describe aws_api_gateway_restapi(rest_api_id: "REST_API_ID") do
its('name') { should eq 'API_NAME' }
end
Ensure that the source of the API key is HEADER
.
describe aws_api_gateway_restapi(rest_api_id: "REST_API_ID") do
its('api_key_source') { should eq 'HEADER' }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exist
Use should
to test that the entity exists.
describe aws_api_gateway_restapi(rest_api_id: "REST_API_ID") do
it { should exist }
end
Use should_not
to test the entity does not exist.
describe aws_api_gateway_restapi(rest_api_id: "REST_API_ID") do
it { should_not exist }
end
be_available
Use should
to check if the work_group name is available.
describe aws_api_gateway_restapi(rest_api_id: "REST_API_ID") do
it { should be_available }
end
AWS Permissions
Your Principal will need the APIGateway:Client:RestApi
action with Effect
set to Allow
.