Skip to content
v2.276.0

CfnProbeProps Struct Added in v2.276.0 ​

Properties for defining a CfnProbe.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_networkmonitor as networkmonitor } from 'aws-cdk-lib';
const cfnProbeProps: networkmonitor.CfnProbeProps = {
  destination: 'destination',
  monitorName: 'monitorName',
  protocol: 'protocol',
  sourceArn: 'sourceArn',

  // the properties below are optional
  destinationPort: 123,
  packetSize: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_networkmonitor as networkmonitor

cfn_probe_props = networkmonitor.CfnProbeProps(
    destination="destination",
    monitor_name="monitorName",
    protocol="protocol",
    source_arn="sourceArn",

    # the properties below are optional
    destination_port=123,
    packet_size=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.networkmonitor.*;

CfnProbeProps cfnProbeProps = CfnProbeProps.builder()
        .destination("destination")
        .monitorName("monitorName")
        .protocol("protocol")
        .sourceArn("sourceArn")

        // the properties below are optional
        .destinationPort(123)
        .packetSize(123)
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.NetworkMonitor;

var cfnProbeProps = new CfnProbeProps {
    Destination = "destination",
    MonitorName = "monitorName",
    Protocol = "protocol",
    SourceArn = "sourceArn",

    // the properties below are optional
    DestinationPort = 123,
    PacketSize = 123,
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnProbeProps := &CfnProbeProps{
	Destination: jsii.String("destination"),
	MonitorName: jsii.String("monitorName"),
	Protocol: jsii.String("protocol"),
	SourceArn: jsii.String("sourceArn"),

	// the properties below are optional
	DestinationPort: jsii.Number(123),
	PacketSize: jsii.Number(123),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

destinationstringdestinationstrdestinationStringDestinationstringDestination*stringrequired#
The literal IPv4 or IPv6 address the probe sends traffic to.

The service rejects a domain name and a CIDR block.

destinationPortoptionalnumberdestination_portoptionalint | floatdestinationPortoptionalNumberDestinationPortoptionaldoubleDestinationPortoptional*float64#
The port the probe sends traffic to.

Applies to the TCP protocol only.

monitorNamestringmonitor_namestrmonitorNameStringMonitorNamestringMonitorName*stringrequired#
The name of the monitor the probe belongs to.
packetSizeoptionalnumberpacket_sizeoptionalint | floatpacketSizeoptionalNumberPacketSizeoptionaldoublePacketSizeoptional*float64#
The size, in bytes, of the packets the probe sends.
protocolstringprotocolstrprotocolStringProtocolstringProtocol*stringrequired#
The protocol the probe uses.
sourceArnstringsource_arnstrsourceArnStringSourceArnstringSourceArn*stringrequired#
The ARN of the subnet the probe sends traffic from.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags for the probe.