aws_ec2_carrier_gateways Resource
Use the aws_ec2_carrier_gateways
InSpec audit resource to test properties of the plural resource of AWS EC2 carrier gateway.
The AWS::EC2::CarrierGateway resource creates a carrier gateway.
For additional information, including details on parameters and properties, see the AWS documentation on AWS EC2 Carrier Gateway.
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 carrier gateway exists.
describe aws_ec2_carrier_gateways do
it { should exist }
end
Parameters
This resource does not require any parameters.
Properties
carrier_gateway_ids
- The ID of the carrier gateway.
Field:
carrier_gateway_id
vpc_ids
- The ID of the VPC (Virtual Private Cloud) associated with the carrier gateway.
Field:
vpc_id
states
- The state of the carrier gateway.
Field:
state
owner_ids
- The Amazon Web Services account ID of the owner of the carrier gateway.
Field:
owner_id
tags
- The tags assigned to the carrier gateway.
Field:
tags
Examples
Ensure a carrier gateway ID is available.
describe aws_ec2_carrier_gateways do
its('carrier_gateway_ids') { should include 'GATEWAY_ID' }
end
Ensure that the state is available
.
describe aws_ec2_carrier_gateways do
its('states') { should include 'available' }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.The controls will pass if the describe
method returns at least one result.
exist
Use should
to test that the entity exists.
describe aws_ec2_carrier_gateways do
it { should exist }
end
Use should_not
to test the entity does not exist.
describe aws_ec2_carrier_gateways do
it { should_not exist }
end
AWS Permissions
Your Principal will need the EC2:Client:DescribeCarrierGatewaysResult
action with Effect
set to Allow
.