aws_network_manager_global_network Resource
Use the aws_network_manager_global_network
InSpec audit resource to test properties of a 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.
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 Global Network ID exists.
describe aws_network_manager_global_network(global_network_id: 'GLOBAL_NETWORK_ID') do
it { should exist }
end
Parameters
global_network_id
(required)The ID of the global network.
Properties
global_network_id
- The ID of the global network.
global_network_arn
- The Amazon Resource Name (ARN) of the global network.
description
- The description of the global network.
created_at
- The date and time that the global network was created.
state
- The state of the global network.
tags
- The tags for the global network.
Examples
Ensure a global network ID is available.
describe aws_network_manager_global_network(global_network_id: 'GLOBAL_NETWORK_ID') do
its('global_network_id') { should eq 'GLOBAL_NETWORK_ID' }
end
Ensure that the state is AVAILABLE
.
describe aws_network_manager_global_network(global_network_id: 'GLOBAL_NETWORK_ID') do
its('state') { should eq 'AVAILABLE' }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exist
Use should
to test that the entity exists.
describe aws_network_manager_global_network(global_network_id: 'GLOBAL_NETWORK_ID') do
it { should exist }
end
Use should_not
to test the entity does not exist.
describe aws_network_manager_global_network(global_network_id: 'GLOBAL_NETWORK_ID') do
it { should_not exist }
end
be_available
Use should
to check if the entity is available.
describe aws_network_manager_global_network(global_network_id: 'GLOBAL_NETWORK_ID') do
it { should be_available }
end
AWS Permissions
Your Principal will need the NetworkManager:Client:DescribeGlobalNetworksResponse
action with Effect
set to Allow
.