aws_vpc_endpoint_service_permissions Resource

[edit on GitHub]

Use the aws_vpc_endpoint_service_permissions InSpec audit resource to test the properties of all Amazon VPC endpoint service permissions. To audit a single AWS VPC Endpoint service, use the aws_vpc_endpoint_service_permission (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_vpc_endpoint_service_permissions resource block collects a group of AWS VPC endpoint service permissions descriptions and then tests that group.

describe aws_vpc_endpoint_service_permissions(service_id: 'VPC_SERVICE_ID')
  it { should exist }
end

Parameters

The AWS VPC endpoint service ID is required.

service_id (required)

The ID of the VPC endpoint service:

• must contain between 1 and 50 alphanumeric characters or hyphens
• should start with vpce-svc-
• cannot end with a hyphen or contain two consecutive hyphens

For example, vpce-svc-04deb776dc2b8e67f.

It can be passed as a service_id: 'value' key-value entry in a hash.

Properties

principal_types

List of types of principal.

Field: principal_type

principals

List of the Amazon Resource Name (ARN) of the principal.

Field: principal

Examples

Ensure that exactly three AWS VPC endpoint service permissions exist.

describe aws_vpc_endpoint_service_permissions(service_id: 'VPC_SERVICE_ID') do
  its('count') { should eq 3 }
end

Request the principals of all AWS VPC endpoint service permissions, then test in-depth using aws_vpc_endpoint_service_permission.

aws_vpc_endpoint_service_permissions(service_id: 'VPC_SERVICE_ID').principals.each do |principal|
  describe aws_vpc_endpoint_service_permission(service_id: 'VPC_SERVICE_ID', principal: 'PRINCIPAL_ARN') do
    it { should exists }
    it { should be_principal_type_user }
  end
end

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_vpc_endpoint_service_permissions(service_id: 'VPC_SERVICE_ID').where( PROPERTY: VALUE) do
  it { should exist }
end

Use should_not to test an entity that should not exist.

describe aws_vpc_endpoint_service_permissions(service_id: 'VPC_SERVICE_ID').where( PROPERTY: VALUE) do
  it { should_not exist }
end

AWS Permissions

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

You can find detailed documentation at Actions, Resources, and Condition Keys for Amazon VPC endpoint service permissions, and Actions, Resources, and Condition Keys for Identity And Access Management.