View Source AWS.NetworkMonitor (aws-elixir v1.0.4)
Amazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring service that identifies if a network issues exists within the Amazon Web Services network or your own company network.
Within Network Monitor you'll choose the source VPCs and subnets from the Amazon Web Services network in which you operate and then you'll choose the destination IP addresses from your on-premises network. From these sources and destinations, Network Monitor creates a monitor containing all the possible source and destination combinations, each of which is called a probe, within a single monitor. These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.
Before you begin, ensure the Amazon Web Services CLI is configured in the Amazon Web Services Account where you will create the Network Monitor resource. Network Monitor doesn’t support creation on cross-account resources, but you can create a Network Monitor in any subnet belonging to a VPC owned by your Account.
For more information, see Using Amazon CloudWatch Network Monitor in the Amazon CloudWatch User Guide.
Link to this section Summary
Functions
Creates a monitor between a source subnet and destination IP address.
Create a probe within a monitor.
Deletes a specified monitor.
Deletes the specified probe.
Returns details about a specific monitor.
Returns the details about a probe.
Returns a list of all of your monitors.
Lists the tags assigned to this resource.
Adds key-value pairs to a monitor or probe.
Removes a key-value pair from a monitor or probe.
Updates the aggregationPeriod for a monitor.
Updates a monitor probe.
Link to this section Functions
Creates a monitor between a source subnet and destination IP address.
Within a monitor you'll create one or more probes that monitor network traffic between your source Amazon Web Services VPC subnets and your destination IP addresses. Each probe then aggregates and sends metrics to Amazon CloudWatch.
You can also create a monitor with probes using this command. For each probe, you define the following:
*
source—The subnet IDs where the probes will be created.
*
destination— The target destination IP address for the
probe.
*
destinationPort—Required only if the protocol is
TCP.
*
protocol—The communication protocol between the source and
destination. This will be either TCP or ICMP.
*
packetSize—The size of the packets. This must be a number between
56 and 8500.
*
(Optional) tags —Key-value pairs created and assigned to the
probe.
Create a probe within a monitor.
Once you create a probe, and it begins monitoring your
network traffic, you'll incur billing charges for that probe. This action
requires the
monitorName parameter. Run ListMonitors to get a list of
monitor names. Note the name of the monitorName you want to create the
probe for.
Deletes a specified monitor.
This action requires the monitorName parameter. Run
ListMonitors to get a list of monitor names.
delete_probe(client, monitor_name, probe_id, input, options \\ [])
View SourceDeletes the specified probe.
Once a probe is deleted you'll no longer incur any billing fees for that probe.
This action requires both the monitorName and probeId
parameters. Run ListMonitors to get a list of monitor names. Run
GetMonitor to get a list of probes and probe IDs. You can only delete a
single probe at a time using this action.
Returns details about a specific monitor.
This action requires the monitorName parameter. Run
ListMonitors to get a list of monitor names.
Returns the details about a probe.
This action requires both the
monitorName and probeId parameters. Run
ListMonitors to get a list of monitor names. Run
GetMonitor to get a list of probes and probe IDs.
list_monitors(client, max_results \\ nil, next_token \\ nil, state \\ nil, options \\ [])
View SourceReturns a list of all of your monitors.
Lists the tags assigned to this resource.
Adds key-value pairs to a monitor or probe.
Removes a key-value pair from a monitor or probe.
Updates the aggregationPeriod for a monitor.
Monitors support an
aggregationPeriod of either 30 or 60 seconds.
This action requires the monitorName and probeId parameter.
Run ListMonitors to get a list of monitor names.
update_probe(client, monitor_name, probe_id, input, options \\ [])
View SourceUpdates a monitor probe.
This action requires both the monitorName and probeId parameters. Run
ListMonitors to get a list of monitor names. Run GetMonitor to get a list of
probes and probe IDs.
You can update the following para create a monitor with probes using this command. For each probe, you define the following:
*
state—The state of the probe.
*
destination— The target destination IP address for the
probe.
*
destinationPort—Required only if the protocol is
TCP.
*
protocol—The communication protocol between the source and
destination. This will be either TCP or ICMP.
*
packetSize—The size of the packets. This must be a number between
56 and 8500.
*
(Optional) tags —Key-value pairs created and assigned to the
probe.