Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . networkmonitor ]

create-monitor

Description

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.

See also: AWS API Documentation

Synopsis

  create-monitor
--monitor-name <value>
[--probes <value>]
[--aggregation-period <value>]
[--client-token <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--monitor-name (string)

The name identifying the monitor. It can contain only letters, underscores (_), or dashes (-), and can be up to 200 characters.

--probes (list)

Displays a list of all of the probes created for a monitor.

(structure)

Creates a monitor probe.

sourceArn -> (string)

The ARN of the subnet.

destination -> (string)

The destination IP address. This must be either IPV4 or IPV6 .

destinationPort -> (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 .

protocol -> (string)

The protocol used for the network traffic between the source and destination . This must be either TCP or ICMP .

packetSize -> (integer)

The size of the packets sent between the source and destination. This must be a number between 56 and 8500 .

probeTags -> (map)

The list of key-value pairs created and assigned to the monitor.

key -> (string)

value -> (string)

Shorthand Syntax:

sourceArn=string,destination=string,destinationPort=integer,protocol=string,packetSize=integer,probeTags={KeyName1=string,KeyName2=string} ...

JSON Syntax:

[
  {
    "sourceArn": "string",
    "destination": "string",
    "destinationPort": integer,
    "protocol": "TCP"|"ICMP",
    "packetSize": integer,
    "probeTags": {"string": "string"
      ...}
  }
  ...
]

--aggregation-period (long)

The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60 . 60 is the default if no period is chosen.

--client-token (string)

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

--tags (map)

The list of key-value pairs created and assigned to the monitor.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

monitorArn -> (string)

The ARN of the monitor.

monitorName -> (string)

The name of the monitor.

state -> (string)

The state of the monitor.

aggregationPeriod -> (long)

The number of seconds that metrics are aggregated by and sent to Amazon CloudWatch. This will be either 30 or 60 .

tags -> (map)

The list of key-value pairs assigned to the monitor.

key -> (string)

value -> (string)