aws_api_gateway_vpc_link resource

Use the aws_api_gateway_vpc_link InSpec audit resource to test the properties of a single specific AWS API Gateway VPC link.

For additional information, including parameters and properties, see the AWS documentation on AWS APIGateway VPCLink.

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.

Ensure that a VPC link exists.

describe aws_api_gateway_vpc_link(vpc_link_id: 'VPC_LINK_ID') do
  it { should exist }
end

id: The identifier of the VPC link used to integrate to reference this VPC link.
name: The name used to label and identify the VPC link.
description: The description of the VPC link.
target_arns: The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
status: The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. If the status is PENDING, the API deployment waits, and if the status is DELETING, the API deployment fails.
status_message: A description about the VPC link status.
tags: The collection of strings. Each tag element is associated with a given resource.

describe aws_api_gateway_vpc_link(vpc_link_id: 'VPC_LINK_ID') do
  its('id') { should eq 'VPC_LINK_ID' }
end

describe aws_api_gateway_vpc_link(vpc_link_id: 'VPC_LINK_ID') do
  its('name') { should eq 'VPC_LINK_NAME' }
end

describe aws_api_gateway_vpc_link(vpc_link_id: 'VPC_LINK_ID') do
  its('status') { should eq 'AVAILABLE' }
end

For a full list of available matchers, see our Universal Matchers page.

The control passes if the get method returns at least one result.

Use should to test that the entity exists.

describe aws_api_gateway_vpc_link(vpc_link_id: 'VPC_LINK_ID') do
  it { should exist }
end

Use should_not to test that the entity does not exist.

describe aws_api_gateway_vpc_link(vpc_link_id: 'VPC_LINK_ID') do
  it { should_not exist }
end

Your Principal will need the APIGateway:Client:VpcLink action with Effect set to Allow.