Probe - Network Synthetic Monitor
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

Probe

Describes information about a network monitor probe.

Contents

destination

The destination for the probe. This should be either an IPV4 or IPV6.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

protocol

The network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.

Type: String

Valid Values: TCP | ICMP

Required: Yes

sourceArn

The ARN of the probe source subnet.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:.*

Required: Yes

addressFamily

The IPv4 or IPv6 address for the probe.

Type: String

Valid Values: IPV4 | IPV6

Required: No

createdAt

The time and date the probe was created.

Type: Timestamp

Required: No

destinationPort

The destination port for the probe. This is required only if the protocol is TCP and must be a number between 1 and 65536.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 65536.

Required: No

modifiedAt

The time and date that the probe was last modified.

Type: Timestamp

Required: No

packetSize

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

Type: Integer

Valid Range: Minimum value of 56. Maximum value of 8500.

Required: No

probeArn

The ARN of the probe.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:.*

Required: No

probeId

The ID of the probe.

Type: String

Pattern: probe-[a-z0-9A-Z-]{21,64}

Required: No

state

The state of the probe.

Type: String

Valid Values: PENDING | ACTIVE | INACTIVE | ERROR | DELETING | DELETED

Required: No

tags

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

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

vpcId

The ID of the source VPC subnet.

Type: String

Pattern: vpc-[a-zA-Z0-9]{8,32}

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: