networkmonitor/aws.sdk.kotlin.services.networkmonitor

Package-level declarations

Types

interface NetworkMonitorClient : SdkClient

Amazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring service that identifies if a network issues exists within the Amazon Web Services network or your own company network. Within Network Monitor you'll choose the source VPCs and subnets from the Amazon Web Services network in which you operate and then you'll choose the destination IP addresses from your on-premises network. From these sources and destinations, Network Monitor creates a monitor containing all the possible source and destination combinations, each of which is called a probe, within a single monitor. These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createMonitor

inline suspend fun NetworkMonitorClient.createMonitor(crossinline block: CreateMonitorRequest.Builder.() -> Unit): CreateMonitorResponse

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.

createProbe

inline suspend fun NetworkMonitorClient.createProbe(crossinline block: CreateProbeRequest.Builder.() -> Unit): CreateProbeResponse

Create a probe within a monitor. Once you create a probe, and it begins monitoring your network traffic, you'll incur billing charges for that probe.

deleteMonitor

inline suspend fun NetworkMonitorClient.deleteMonitor(crossinline block: DeleteMonitorRequest.Builder.() -> Unit): DeleteMonitorResponse

Deletes a specified monitor.

deleteProbe

inline suspend fun NetworkMonitorClient.deleteProbe(crossinline block: DeleteProbeRequest.Builder.() -> Unit): DeleteProbeResponse

Deletes the specified monitor. Once a probe is deleted you'll no longer incur any billing fees for that probe.

getMonitor

inline suspend fun NetworkMonitorClient.getMonitor(crossinline block: GetMonitorRequest.Builder.() -> Unit): GetMonitorResponse

Returns details about a specific monitor.

getProbe

inline suspend fun NetworkMonitorClient.getProbe(crossinline block: GetProbeRequest.Builder.() -> Unit): GetProbeResponse

Returns the details about a probe. You'll need both the monitorName and probeId.

listMonitors

inline suspend fun NetworkMonitorClient.listMonitors(crossinline block: ListMonitorsRequest.Builder.() -> Unit): ListMonitorsResponse

Returns a list of all of your monitors.

listTagsForResource

inline suspend fun NetworkMonitorClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags assigned to this resource.

tagResource

inline suspend fun NetworkMonitorClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds key-value pairs to a monitor or probe.

untagResource

inline suspend fun NetworkMonitorClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes a key-value pair from a monitor or probe.

updateMonitor

inline suspend fun NetworkMonitorClient.updateMonitor(crossinline block: UpdateMonitorRequest.Builder.() -> Unit): UpdateMonitorResponse

Updates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of either 30 or 60 seconds.

updateProbe

inline suspend fun NetworkMonitorClient.updateProbe(crossinline block: UpdateProbeRequest.Builder.() -> Unit): UpdateProbeResponse

Updates a monitor probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.

withConfig

fun NetworkMonitorClient.withConfig(block: NetworkMonitorClient.Config.Builder.() -> Unit): NetworkMonitorClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.