[ aws . networkflowmonitor ]

create-performance-monitor

Description

Create a performance monitor to monitor the traffic of the Amazon Virtual Private Clouds (VPCs) that you specify as targets, to determine whether the Amazon Web Services network is causing issues for your workloads. With a performance monitor, you can identify network degradation across paths between Availability Zones and across Amazon Web Services Regions.

See also: AWS API Documentation

Synopsis

  create-performance-monitor
--monitor-name <value>
[--scope-arn <value>]
--targets <value>
[--client-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--monitor-name (string) [required]

The name of the performance monitor.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9_.-]+

--scope-arn (string)

The Amazon Resource Name (ARN) of the scope for the performance monitor.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:.*

--targets (list) [required]

The resources to monitor. Each target identifies a resource, currently a VPC, for which you can track network performance. For a VPC, specify the VPC ARN.

Constraints:

  • min: 1
  • max: 100

(structure)

A resource that a performance monitor tracks network performance for.

type -> (string) [required]

The type of the resource that you want Network Flow Monitor to track network performance for. Specify AWS::EC2::VPC .

Possible values:

  • AWS::EC2::VPC

identifier -> (string) [required]

The Amazon Resource Name (ARN) of the resource that you want Network Flow Monitor to track network performance for.

Constraints:

  • min: 20
  • max: 128
  • pattern: arn:.*

Shorthand Syntax:

type=string,identifier=string ...

JSON Syntax:

[
  {
    "type": "AWS::EC2::VPC",
    "identifier": "string"
  }
  ...
]

--client-token (string)

A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. If the token matches a previous request, the service ignores the request without returning an error. Don’t reuse the same client token for other API requests.

Constraints:

  • min: 36
  • max: 36
  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

--tags (map)

The tags for a performance monitor. You can add a maximum of 200 tags.

Constraints:

  • min: 0
  • max: 200

key -> (string)

Constraints:

  • min: 1
  • max: 128

value -> (string)

Constraints:

  • min: 0
  • max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

monitorArn -> (string)

The Amazon Resource Name (ARN) of the performance monitor.

Constraints:

  • min: 20
  • max: 512
  • pattern: arn:.*

monitorName -> (string)

The name of the performance monitor.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9_.-]+

monitorStatus -> (string)

The status of a performance monitor. The status can be one of the following

  • PENDING : The performance monitor is in the process of being created.
  • ACTIVE : The performance monitor is active.
  • INACTIVE : The performance monitor is inactive.
  • ERROR : The performance monitor can’t be created or updated.
  • DELETING : The performance monitor is in the process of being deleted.

Possible values:

  • PENDING
  • ACTIVE
  • INACTIVE
  • ERROR
  • DELETING

monitorType -> (string)

The type of resource that you monitor determines the type of the performance monitor.

Possible values:

  • VPC

targets -> (list)

The resources that the performance monitor tracks network performance for.

(structure)

A resource that a performance monitor tracks network performance for.

type -> (string) [required]

The type of the resource that you want Network Flow Monitor to track network performance for. Specify AWS::EC2::VPC .

Possible values:

  • AWS::EC2::VPC

identifier -> (string) [required]

The Amazon Resource Name (ARN) of the resource that you want Network Flow Monitor to track network performance for.

Constraints:

  • min: 20
  • max: 128
  • pattern: arn:.*

createdAt -> (timestamp)

The date and time when the performance monitor was created.

modifiedAt -> (timestamp)

The date and time when the performance monitor was last modified.

tags -> (map)

The tags for a performance monitor.

Constraints:

  • min: 0
  • max: 200

key -> (string)

Constraints:

  • min: 1
  • max: 128

value -> (string)

Constraints:

  • min: 0
  • max: 256