networkmonitor

package
v7.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 7, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Monitor 

type Monitor struct {
	pulumi.CustomResourceState

	// The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60.
	AggregationPeriod pulumi.IntOutput `pulumi:"aggregationPeriod"`
	// The ARN of the monitor.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The name of the monitor.
	//
	// The following arguments are optional:
	MonitorName pulumi.StringOutput `pulumi:"monitorName"`
	// Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
	Region pulumi.StringOutput `pulumi:"region"`
	// Key-value tags for the monitor. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

Resource for managing an AWS Network Monitor Monitor.

## Example Usage

### Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/networkmonitor"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkmonitor.NewMonitor(ctx, "example", &networkmonitor.MonitorArgs{
			AggregationPeriod: pulumi.Int(30),
			MonitorName:       pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import `aws_networkmonitor_monitor` using the monitor name. For example:

```sh $ pulumi import aws:networkmonitor/monitor:Monitor example monitor-7786087912324693644 ```

func GetMonitor 

func GetMonitor(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *MonitorState, opts ...pulumi.ResourceOption) (*Monitor, error)

GetMonitor gets an existing Monitor resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewMonitor 

func NewMonitor(ctx *pulumi.Context,
	name string, args *MonitorArgs, opts ...pulumi.ResourceOption) (*Monitor, error)

NewMonitor registers a new resource with the given unique name, arguments, and options.

func (*Monitor) ElementType 

func (*Monitor) ElementType() reflect.Type

func (*Monitor) ToMonitorOutput 

func (i *Monitor) ToMonitorOutput() MonitorOutput

func (*Monitor) ToMonitorOutputWithContext 

func (i *Monitor) ToMonitorOutputWithContext(ctx context.Context) MonitorOutput

type MonitorArgs 

type MonitorArgs struct {
	// The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60.
	AggregationPeriod pulumi.IntPtrInput
	// The name of the monitor.
	//
	// The following arguments are optional:
	MonitorName pulumi.StringInput
	// Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
	Region pulumi.StringPtrInput
	// Key-value tags for the monitor. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Monitor resource.

func (MonitorArgs) ElementType 

func (MonitorArgs) ElementType() reflect.Type

type MonitorArray 

type MonitorArray []MonitorInput

func (MonitorArray) ElementType 

func (MonitorArray) ElementType() reflect.Type

func (MonitorArray) ToMonitorArrayOutput 

func (i MonitorArray) ToMonitorArrayOutput() MonitorArrayOutput

func (MonitorArray) ToMonitorArrayOutputWithContext 

func (i MonitorArray) ToMonitorArrayOutputWithContext(ctx context.Context) MonitorArrayOutput

type MonitorArrayInput 

type MonitorArrayInput interface {
	pulumi.Input

	ToMonitorArrayOutput() MonitorArrayOutput
	ToMonitorArrayOutputWithContext(context.Context) MonitorArrayOutput
}

MonitorArrayInput is an input type that accepts MonitorArray and MonitorArrayOutput values. You can construct a concrete instance of `MonitorArrayInput` via: 

MonitorArray{ MonitorArgs{...} }

type MonitorArrayOutput 

type MonitorArrayOutput struct{ *pulumi.OutputState }

func (MonitorArrayOutput) ElementType 

func (MonitorArrayOutput) ElementType() reflect.Type

func (MonitorArrayOutput) Index 

func (o MonitorArrayOutput) Index(i pulumi.IntInput) MonitorOutput

func (MonitorArrayOutput) ToMonitorArrayOutput 

func (o MonitorArrayOutput) ToMonitorArrayOutput() MonitorArrayOutput

func (MonitorArrayOutput) ToMonitorArrayOutputWithContext 

func (o MonitorArrayOutput) ToMonitorArrayOutputWithContext(ctx context.Context) MonitorArrayOutput

type MonitorInput 

type MonitorInput interface {
	pulumi.Input

	ToMonitorOutput() MonitorOutput
	ToMonitorOutputWithContext(ctx context.Context) MonitorOutput
}

type MonitorMap 

type MonitorMap map[string]MonitorInput

func (MonitorMap) ElementType 

func (MonitorMap) ElementType() reflect.Type

func (MonitorMap) ToMonitorMapOutput 

func (i MonitorMap) ToMonitorMapOutput() MonitorMapOutput

func (MonitorMap) ToMonitorMapOutputWithContext 

func (i MonitorMap) ToMonitorMapOutputWithContext(ctx context.Context) MonitorMapOutput

type MonitorMapInput 

type MonitorMapInput interface {
	pulumi.Input

	ToMonitorMapOutput() MonitorMapOutput
	ToMonitorMapOutputWithContext(context.Context) MonitorMapOutput
}

MonitorMapInput is an input type that accepts MonitorMap and MonitorMapOutput values. You can construct a concrete instance of `MonitorMapInput` via: 

MonitorMap{ "key": MonitorArgs{...} }

type MonitorMapOutput 

type MonitorMapOutput struct{ *pulumi.OutputState }

func (MonitorMapOutput) ElementType 

func (MonitorMapOutput) ElementType() reflect.Type

func (MonitorMapOutput) MapIndex 

func (o MonitorMapOutput) MapIndex(k pulumi.StringInput) MonitorOutput

func (MonitorMapOutput) ToMonitorMapOutput 

func (o MonitorMapOutput) ToMonitorMapOutput() MonitorMapOutput

func (MonitorMapOutput) ToMonitorMapOutputWithContext 

func (o MonitorMapOutput) ToMonitorMapOutputWithContext(ctx context.Context) MonitorMapOutput

type MonitorOutput 

type MonitorOutput struct{ *pulumi.OutputState }

func (MonitorOutput) AggregationPeriod 

func (o MonitorOutput) AggregationPeriod() pulumi.IntOutput

The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60.

func (MonitorOutput) Arn 

func (o MonitorOutput) Arn() pulumi.StringOutput

The ARN of the monitor.

func (MonitorOutput) ElementType 

func (MonitorOutput) ElementType() reflect.Type

func (MonitorOutput) MonitorName 

func (o MonitorOutput) MonitorName() pulumi.StringOutput

The name of the monitor.

The following arguments are optional:

func (MonitorOutput) Region 

func (o MonitorOutput) Region() pulumi.StringOutput

Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

func (MonitorOutput) Tags 

func (o MonitorOutput) Tags() pulumi.StringMapOutput

Key-value tags for the monitor. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

func (MonitorOutput) TagsAll 

func (o MonitorOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

func (MonitorOutput) ToMonitorOutput 

func (o MonitorOutput) ToMonitorOutput() MonitorOutput

func (MonitorOutput) ToMonitorOutputWithContext 

func (o MonitorOutput) ToMonitorOutputWithContext(ctx context.Context) MonitorOutput

type MonitorState 

type MonitorState struct {
	// The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60.
	AggregationPeriod pulumi.IntPtrInput
	// The ARN of the monitor.
	Arn pulumi.StringPtrInput
	// The name of the monitor.
	//
	// The following arguments are optional:
	MonitorName pulumi.StringPtrInput
	// Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
	Region pulumi.StringPtrInput
	// Key-value tags for the monitor. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll pulumi.StringMapInput
}

func (MonitorState) ElementType 

func (MonitorState) ElementType() reflect.Type

type Probe 

type Probe struct {
	pulumi.CustomResourceState

	AddressFamily pulumi.StringOutput `pulumi:"addressFamily"`
	// The ARN of the attachment.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The destination IP address. This must be either IPV4 or IPV6.
	Destination pulumi.StringOutput `pulumi:"destination"`
	// The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
	DestinationPort pulumi.IntPtrOutput `pulumi:"destinationPort"`
	// The name of the monitor.
	MonitorName pulumi.StringOutput `pulumi:"monitorName"`
	// The size of the packets sent between the source and destination. This must be a number between 56 and 8500.
	PacketSize pulumi.IntOutput    `pulumi:"packetSize"`
	ProbeId    pulumi.StringOutput `pulumi:"probeId"`
	// The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.
	Protocol pulumi.StringOutput `pulumi:"protocol"`
	// Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
	Region pulumi.StringOutput `pulumi:"region"`
	// The ARN of the subnet.
	SourceArn pulumi.StringOutput `pulumi:"sourceArn"`
	// Key-value tags for the monitor. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
	VpcId   pulumi.StringOutput    `pulumi:"vpcId"`
}

Resource for managing an AWS Network Monitor Probe.

## Example Usage

### Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/networkmonitor"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := networkmonitor.NewMonitor(ctx, "example", &networkmonitor.MonitorArgs{
			AggregationPeriod: pulumi.Int(30),
			MonitorName:       pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = networkmonitor.NewProbe(ctx, "example", &networkmonitor.ProbeArgs{
			MonitorName:     example.MonitorName,
			Destination:     pulumi.String("127.0.0.1"),
			DestinationPort: pulumi.Int(80),
			Protocol:        pulumi.String("TCP"),
			SourceArn:       pulumi.Any(exampleAwsSubnet.Arn),
			PacketSize:      pulumi.Int(200),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import `aws_networkmonitor_probe` using the monitor name and probe id. For example:

```sh $ pulumi import aws:networkmonitor/probe:Probe example monitor-7786087912324693644,probe-3qm8p693i4fi1h8lqylzkbp42e ```

func GetProbe 

func GetProbe(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ProbeState, opts ...pulumi.ResourceOption) (*Probe, error)

GetProbe gets an existing Probe resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewProbe 

func NewProbe(ctx *pulumi.Context,
	name string, args *ProbeArgs, opts ...pulumi.ResourceOption) (*Probe, error)

NewProbe registers a new resource with the given unique name, arguments, and options.

func (*Probe) ElementType 

func (*Probe) ElementType() reflect.Type

func (*Probe) ToProbeOutput 

func (i *Probe) ToProbeOutput() ProbeOutput

func (*Probe) ToProbeOutputWithContext 

func (i *Probe) ToProbeOutputWithContext(ctx context.Context) ProbeOutput

type ProbeArgs 

type ProbeArgs struct {
	// The destination IP address. This must be either IPV4 or IPV6.
	Destination pulumi.StringInput
	// The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
	DestinationPort pulumi.IntPtrInput
	// The name of the monitor.
	MonitorName pulumi.StringInput
	// The size of the packets sent between the source and destination. This must be a number between 56 and 8500.
	PacketSize pulumi.IntPtrInput
	// The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.
	Protocol pulumi.StringInput
	// Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
	Region pulumi.StringPtrInput
	// The ARN of the subnet.
	SourceArn pulumi.StringInput
	// Key-value tags for the monitor. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Probe resource.

func (ProbeArgs) ElementType 

func (ProbeArgs) ElementType() reflect.Type

type ProbeArray 

type ProbeArray []ProbeInput

func (ProbeArray) ElementType 

func (ProbeArray) ElementType() reflect.Type

func (ProbeArray) ToProbeArrayOutput 

func (i ProbeArray) ToProbeArrayOutput() ProbeArrayOutput

func (ProbeArray) ToProbeArrayOutputWithContext 

func (i ProbeArray) ToProbeArrayOutputWithContext(ctx context.Context) ProbeArrayOutput

type ProbeArrayInput 

type ProbeArrayInput interface {
	pulumi.Input

	ToProbeArrayOutput() ProbeArrayOutput
	ToProbeArrayOutputWithContext(context.Context) ProbeArrayOutput
}

ProbeArrayInput is an input type that accepts ProbeArray and ProbeArrayOutput values. You can construct a concrete instance of `ProbeArrayInput` via: 

ProbeArray{ ProbeArgs{...} }

type ProbeArrayOutput 

type ProbeArrayOutput struct{ *pulumi.OutputState }

func (ProbeArrayOutput) ElementType 

func (ProbeArrayOutput) ElementType() reflect.Type

func (ProbeArrayOutput) Index 

func (o ProbeArrayOutput) Index(i pulumi.IntInput) ProbeOutput

func (ProbeArrayOutput) ToProbeArrayOutput 

func (o ProbeArrayOutput) ToProbeArrayOutput() ProbeArrayOutput

func (ProbeArrayOutput) ToProbeArrayOutputWithContext 

func (o ProbeArrayOutput) ToProbeArrayOutputWithContext(ctx context.Context) ProbeArrayOutput

type ProbeInput 

type ProbeInput interface {
	pulumi.Input

	ToProbeOutput() ProbeOutput
	ToProbeOutputWithContext(ctx context.Context) ProbeOutput
}

type ProbeMap 

type ProbeMap map[string]ProbeInput

func (ProbeMap) ElementType 

func (ProbeMap) ElementType() reflect.Type

func (ProbeMap) ToProbeMapOutput 

func (i ProbeMap) ToProbeMapOutput() ProbeMapOutput

func (ProbeMap) ToProbeMapOutputWithContext 

func (i ProbeMap) ToProbeMapOutputWithContext(ctx context.Context) ProbeMapOutput

type ProbeMapInput 

type ProbeMapInput interface {
	pulumi.Input

	ToProbeMapOutput() ProbeMapOutput
	ToProbeMapOutputWithContext(context.Context) ProbeMapOutput
}

ProbeMapInput is an input type that accepts ProbeMap and ProbeMapOutput values. You can construct a concrete instance of `ProbeMapInput` via: 

ProbeMap{ "key": ProbeArgs{...} }

type ProbeMapOutput 

type ProbeMapOutput struct{ *pulumi.OutputState }

func (ProbeMapOutput) ElementType 

func (ProbeMapOutput) ElementType() reflect.Type

func (ProbeMapOutput) MapIndex 

func (o ProbeMapOutput) MapIndex(k pulumi.StringInput) ProbeOutput

func (ProbeMapOutput) ToProbeMapOutput 

func (o ProbeMapOutput) ToProbeMapOutput() ProbeMapOutput

func (ProbeMapOutput) ToProbeMapOutputWithContext 

func (o ProbeMapOutput) ToProbeMapOutputWithContext(ctx context.Context) ProbeMapOutput

type ProbeOutput 

type ProbeOutput struct{ *pulumi.OutputState }

func (ProbeOutput) AddressFamily 

func (o ProbeOutput) AddressFamily() pulumi.StringOutput

func (ProbeOutput) Arn 

func (o ProbeOutput) Arn() pulumi.StringOutput

The ARN of the attachment.

func (ProbeOutput) Destination 

func (o ProbeOutput) Destination() pulumi.StringOutput

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

func (ProbeOutput) DestinationPort 

func (o ProbeOutput) DestinationPort() pulumi.IntPtrOutput

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

func (ProbeOutput) ElementType 

func (ProbeOutput) ElementType() reflect.Type

func (ProbeOutput) MonitorName 

func (o ProbeOutput) MonitorName() pulumi.StringOutput

The name of the monitor.

func (ProbeOutput) PacketSize 

func (o ProbeOutput) PacketSize() pulumi.IntOutput

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

func (ProbeOutput) ProbeId 

func (o ProbeOutput) ProbeId() pulumi.StringOutput

func (ProbeOutput) Protocol 

func (o ProbeOutput) Protocol() pulumi.StringOutput

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

func (ProbeOutput) Region 

func (o ProbeOutput) Region() pulumi.StringOutput

Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

func (ProbeOutput) SourceArn 

func (o ProbeOutput) SourceArn() pulumi.StringOutput

The ARN of the subnet.

func (ProbeOutput) Tags 

func (o ProbeOutput) Tags() pulumi.StringMapOutput

Key-value tags for the monitor. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

func (ProbeOutput) TagsAll 

func (o ProbeOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

func (ProbeOutput) ToProbeOutput 

func (o ProbeOutput) ToProbeOutput() ProbeOutput

func (ProbeOutput) ToProbeOutputWithContext 

func (o ProbeOutput) ToProbeOutputWithContext(ctx context.Context) ProbeOutput

func (ProbeOutput) VpcId 

func (o ProbeOutput) VpcId() pulumi.StringOutput

type ProbeState 

type ProbeState struct {
	AddressFamily pulumi.StringPtrInput
	// The ARN of the attachment.
	Arn pulumi.StringPtrInput
	// The destination IP address. This must be either IPV4 or IPV6.
	Destination pulumi.StringPtrInput
	// The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
	DestinationPort pulumi.IntPtrInput
	// The name of the monitor.
	MonitorName pulumi.StringPtrInput
	// The size of the packets sent between the source and destination. This must be a number between 56 and 8500.
	PacketSize pulumi.IntPtrInput
	ProbeId    pulumi.StringPtrInput
	// The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.
	Protocol pulumi.StringPtrInput
	// Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
	Region pulumi.StringPtrInput
	// The ARN of the subnet.
	SourceArn pulumi.StringPtrInput
	// Key-value tags for the monitor. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll pulumi.StringMapInput
	VpcId   pulumi.StringPtrInput
}

func (ProbeState) ElementType 

func (ProbeState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.