aws_ec2_eip Resource
Use the aws_ec2_eip
InSpec audit resource to test properties of a single specific Elastic IP (EIP).
An Elastic IP (EIP) is uniquely identified by the public IPv4 address, for example 192.0.2.0
.
For additional information, including details on parameters and properties, see the AWS documentation on Elastic IP (EIP).
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 a Public IP exists.
describe aws_ec2_eip(public_ip: '192.0.2.0') do
it { should exist }
end
Parameters
public_ip
(required)
Properties
public_ip
- The Elastic IP address, or the carrier IP address.
instance_id
- The ID of the instance the address is associated with, if any.
allocation_id
- The allocation ID for the address.
association_id
- The association ID for the address.
domain
- Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).
network_interface_id
- The ID of the network interface that the address is associated with, if any.
network_interface_owner_id
- The AWS account ID of the owner.
private_ip_address
- The private IP address associated with the Elastic IP address.
public_ipv_4_pool
- The Elastic IPV4 pool address.
network_border_group
- A unique set of Availability Zones, Local Zones, or Wavelength Zones from where AWS advertises IP addresses.
Examples
Ensure a Public IP is available.
describe aws_ec2_eip(public_ip: '192.0.2.0') do
its('public_ip') { should eq '192.0.2.0' }
end
Ensure that the domain is vpc
or standard
.
describe aws_ec2_eip(public_ip: '192.0.2.0') do
its('domain') { should eq 'vpc' }
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_eip(public_ip: '192.0.2.0') do
it { should exist }
end
Use should_not
to test the entity does not exist.
describe aws_vpc_endpoint(public_ip: '192.0.2.0') do
it { should_not exist }
end
be_available
Check if the IP address is available.
describe aws_ec2_eip(public_ip: '192.0.2.0') do
it { should be_available }
end
Use should_not
to test an IP address that should not exist.
describe aws_ec2_eip(public_ip: '192.0.2.0') do
it { should_not be_available }
end
AWS Permissions
Your Principal will need the EC2:Client:DescribeAddressesResult
action with Effect
set to Allow
.
See the Actions, Resources, and Condition Keys for Amazon EC2 documentation for additional information.