aws_network_manager_global_networks Resource

[edit on GitHub]

Use the aws_network_manager_global_networks InSpec audit resource to test properties of a single specific AWS Network Manager global network.

The AWS::NetworkManager::GlobalNetwork resource describes one or more global networks.

For additional information, including details on parameters and properties, see the AWS documentation on AWS Network Manager Global Network.

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

Ensure that Global Network ID exists.

describe aws_network_manager_global_networks do
  it { should exist }
end

Parameters

This resource does not require any parameters.

Properties

global_network_ids

global_network_id.

global_network_arns

global_network_arn.

descriptions

description.

created_at

created_at.

states

state.

tags

tags.

Examples

Ensure a Global Network ID is available.

describe aws_network_manager_global_networks do
  its('global_network_ids') { should include 'GLOBAL_NETWORK_ID' }
end

Ensure that the state is AVAILABLE.

describe aws_network_manager_global_networks do
    its('states') { should include 'AVAILABLE' }
end

Matchers

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

The controls will pass if the get method returns at least one result.

exist

Use should to test that the entity exists.

describe aws_network_manager_global_networks do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_network_manager_global_networks do
  it { should_not exist }
end

AWS Permissions

Your Principal will need the NetworkManager:Client:DescribeGlobalNetworksResponse action with Effect set to Allow.