probes

Creates, updates, deletes, gets or lists a probes resource.

Overview

Name	`probes`
Type	Resource
Id	`aws.networkmonitor.probes`

Fields

The following fields are returned by SELECT queries:

get_probe

Name	Datatype	Description
`address_family`	`string`	Indicates whether the IP address is IPV4 or IPV6. (IPV4, IPV6)
`created_at`	`string (date-time)`	The time and date that the probe was created.
`destination`	`string`	The destination IP address for the monitor. This must be either an IPv4 or IPv6 address.
`destination_port`	`integer`	The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
`modified_at`	`string (date-time)`	The time and date that the probe was last modified.
`packet_size`	`integer`	The size of the packets sent between the source and destination. This must be a number between 56 and 8500.
`probe_arn`	`string`	The ARN of the probe. (pattern: <code>arn:.*</code>)
`probe_id`	`string`	The ID of the probe for which details are returned. (pattern: <code>probe-[a-z0-9A-Z-]{21,64}</code>)
`protocol`	`string`	The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP. (TCP, ICMP)
`source_arn`	`string`	The ARN of the probe. (pattern: <code>arn:.*</code>)
`state`	`string`	The state of the probe. (PENDING, ACTIVE, INACTIVE, ERROR, DELETING, DELETED)
`tags`	`object`	The list of key-value pairs assigned to the probe.
`vpc_id`	`string`	The ID of the source VPC or subnet. (pattern: <code>vpc-[a-zA-Z0-9]{8,32}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`get_probe`	`select`	`monitor_name`, `probe_id`, `region`	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.
`create_probe`	`insert`	`monitor_name`, `region`, `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.
`update_probe`	`update`	`monitor_name`, `probe_id`, `region`	Updates 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.
`delete_probe`	`delete`	`monitor_name`, `probe_id`, `region`	Deletes 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`monitor_name`	`string`	The name of the monitor to delete.
`probe_id`	`string`	The ID of the probe to delete.
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

get_probe

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.

SELECT
address_family,
created_at,
destination,
destination_port,
modified_at,
packet_size,
probe_arn,
probe_id,
protocol,
source_arn,
state,
tags,
vpc_id
FROM aws.networkmonitor.probes
WHERE monitor_name = '{{ monitor_name }}' -- required
AND probe_id = '{{ probe_id }}' -- required
AND region = '{{ region }}' -- required
;

`INSERT` examples

create_probe
Manifest

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.

INSERT INTO aws.networkmonitor.probes (
probe,
clientToken,
tags,
monitor_name,
region
)
SELECT 
'{{ probe }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ monitor_name }}',
'{{ region }}'
RETURNING
address_family,
created_at,
destination,
destination_port,
modified_at,
packet_size,
probe_arn,
probe_id,
protocol,
source_arn,
state,
tags,
vpc_id
;

# Description fields are for documentation purposes
- name: probes
props:
  - name: monitor_name
    value: "{{ monitor_name }}"
    description: Required parameter for the probes resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the probes resource.
  - name: probe
    description: |
      Defines a probe when creating a probe or monitor.
    value:
      sourceArn: "{{ sourceArn }}"
      destination: "{{ destination }}"
      destinationPort: {{ destinationPort }}
      protocol: "{{ protocol }}"
      packetSize: {{ packetSize }}
      tags: "{{ tags }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"

`UPDATE` examples

update_probe

Updates 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.

UPDATE aws.networkmonitor.probes
SET 
state = '{{ state }}',
destination = '{{ destination }}',
destinationPort = {{ destinationPort }},
protocol = '{{ protocol }}',
packetSize = {{ packetSize }}
WHERE 
monitor_name = '{{ monitor_name }}' --required
AND probe_id = '{{ probe_id }}' --required
AND region = '{{ region }}' --required
RETURNING
address_family,
created_at,
destination,
destination_port,
modified_at,
packet_size,
probe_arn,
probe_id,
protocol,
source_arn,
state,
tags,
vpc_id;

`DELETE` examples

delete_probe

Deletes 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.

DELETE FROM aws.networkmonitor.probes
WHERE monitor_name = '{{ monitor_name }}' --required
AND probe_id = '{{ probe_id }}' --required
AND region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​