aws_vpn_gateways Resource

[edit on GitHub]

Use the aws_vpn_gateways InSpec audit resource to test the properties of all Amazon VPN gateways. To audit a single AWS VPN gateway, use the aws_vpn_gateway (singular) resource.

Installation

This resource is available in the Chef InSpec AWS resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your AWS environment for InSpec and creating an InSpec profile that uses the InSpec AWS resource pack.

Syntax

An aws_vpn_gateways resource block collects a group of AWS VPN descriptions and then tests that group.

describe aws_vpn_gateways
  it { should exist }
end

Parameters

This resource does not require any parameters.

Properties

vpn_gateway_ids

List of unique identifiers that identifies a AWS VPN gateway.

states

List of the current state of the VPN gateway. Possible values are: pending, available, deleting, deleted.

types

List of the types of VPN connection the VPN gateway supports.

availability_zones

List of Availability Zone where the virtual private gateway was created. If not applicable, this field will be be empty.

vpc_attachments

List of VPCs attached to the virtual private gateway. It has a collection of key-pairs of state and vpc_id.

amazon_side_asns

List of all the private Autonomous System Number (ASN) for the Amazon side of a BGP session.

tags

List of all tags that are associated with the VPN gateway.

Examples

Ensure that exactly three AWS VPN gateways exist.

describe aws_vpn_gateways do
  its('count') { should eq 3 }
end

Request the IDs of all AWS VPN gateways, then test in-depth using aws_vpn_gateway.

aws_vpn_gateways.vpn_gateway_ids.each do |vpn_gateway_id|
  describe aws_vpn_gateway(vpn_gateway_id) do
    it { should exists }
    it { should be_attached }
  end
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exist

The control will pass if the ‘describe’ method returns at least one result.

describe aws_vpn_gateways.where( <property>: <value>) do
  it { should exist }
end

Use should_not to test an entity that should not exist.

describe aws_vpn_gateways.where( <property>: <value>) do
  it { should_not exist }
end

AWS Permissions

Your Principal will need the EC2:Client:DescribeVpnGatewaysResult action with Effect set to Allow.

You can find detailed documentation at Actions, Resources, and Condition Keys for Amazon ElastiCache, and Actions, Resources, and Condition Keys for Identity And Access Management.