aws_apigateway_base_path_mappings Resource
Use the aws_apigateway_base_path_mappings
InSpec audit resource to test properties of multiple AWS API Gateway base path mappings.
The AWS::ApiGateway::BasePathMapping
resource creates a base path that clients who call your API must use in the invocation URL.
For additional information, including details on parameters and properties, see the AWS documentation on AWS APIGateway BasePathMapping..
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 that the base path mappings exists.
describe aws_apigateway_base_path_mappings(domain_name: 'DOMAIN_NAME') do
it { should exist }
end
Parameters
domain_name
(required)The domain name of the BasePathMapping resource to be described.
Properties
base_paths
- The base path name that callers of the API must provide as part of the URL after the domain name.
Field:
base_path
rest_api_ids
- The string identifier of the associated RestApi.
Field:
rest_api_id
stages
- The name of the associated stage.
Field:
stage
Examples
Ensure a base path is available.
describe aws_apigateway_base_path_mappings(domain_name: 'DOMAIN_NAME') do
its('base_paths') { should include 'BASE_PATH')' }
end
Ensure that stage name is available.
describe aws_apigateway_base_path_mappings(domain_name: 'DOMAIN_NAME') do
its('stages') { should include 'STAGE_NAME' }
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_apigateway_base_path_mappings(domain_name: 'DOMAIN_NAME') do
it { should exist }
end
Use should_not
to test the entity does not exist.
describe aws_apigateway_base_path_mappings(domain_name: 'DOMAIN_NAME') do
it { should_not exist }
end
AWS Permissions
Your Principal will need the APIGateway:Client:BasePathMappings
action with Effect
set to Allow
.