AWS.Tools.NetworkMonitor.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.NetworkMonitor</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CWNM.AddCWNMResourceTagCmdlet"> <summary> Adds key-value pairs to a monitor or probe. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.AddCWNMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the monitor or probe to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.AddCWNMResourceTagCmdlet.Tag"> <summary> <para> <para>The list of key-value pairs assigned to the monitor or probe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.AddCWNMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkMonitor.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.AddCWNMResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMMonitorCmdlet"> <summary> Returns details about a specific monitor. <para> This action requires the <c>monitorName</c> parameter. Run <c>ListMonitors</c> to get a list of monitor names. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMMonitorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor that details are returned for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMMonitorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkMonitor.Model.GetMonitorResponse). Specifying the name of a property of type Amazon.NetworkMonitor.Model.GetMonitorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMMonitorListCmdlet"> <summary> Returns a list of all of your monitors. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMMonitorListCmdlet.State"> <summary> <para> <para>The list of all monitors and their states.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMMonitorListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <c>nextToken</c> value.</para><para>If <c>MaxResults</c> is given a value larger than 100, only 100 results are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMMonitorListCmdlet.NextToken"> <summary> <para> <para>The token for the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMMonitorListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Monitors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkMonitor.Model.ListMonitorsResponse). Specifying the name of a property of type Amazon.NetworkMonitor.Model.ListMonitorsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMProbeCmdlet"> <summary> Returns the details about a probe. This action requires both the <c>monitorName</c> and <c>probeId</c> parameters. Run <c>ListMonitors</c> to get a list of monitor names. Run <c>GetMonitor</c> to get a list of probes and probe IDs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMProbeCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor associated with the probe. Run <c>ListMonitors</c> to get a list of monitor names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMProbeCmdlet.ProbeId"> <summary> <para> <para>The ID of the probe to get information about. Run <c>GetMonitor</c> action to get a list of probes and probe IDs for the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMProbeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkMonitor.Model.GetProbeResponse). Specifying the name of a property of type Amazon.NetworkMonitor.Model.GetProbeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMResourceTagCmdlet"> <summary> Lists the tags assigned to this resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.GetCWNMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkMonitor.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.NetworkMonitor.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMMonitorCmdlet"> <summary> 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. <para> You can also create a monitor with probes using this command. For each probe, you define the following: </para><ul><li><para><c>source</c>—The subnet IDs where the probes will be created. </para></li><li><para><c>destination</c>— The target destination IP address for the probe. </para></li><li><para><c>destinationPort</c>—Required only if the protocol is <c>TCP</c>. </para></li><li><para><c>protocol</c>—The communication protocol between the source and destination. This will be either <c>TCP</c> or <c>ICMP</c>. </para></li><li><para><c>packetSize</c>—The size of the packets. This must be a number between <c>56</c> and <c>8500</c>. </para></li><li><para> (Optional) <c>tags</c> —Key-value pairs created and assigned to the probe. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMMonitorCmdlet.AggregationPeriod"> <summary> <para> <para>The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either <c>30</c> or <c>60</c>. <c>60</c> is the default if no period is chosen.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMMonitorCmdlet.MonitorName"> <summary> <para> <para>The name identifying the monitor. It can contain only letters, underscores (_), or dashes (-), and can be up to 200 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMMonitorCmdlet.Probe"> <summary> <para> <para>Displays a list of all of the probes created for a monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMMonitorCmdlet.Tag"> <summary> <para> <para>The list of key-value pairs created and assigned to the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMMonitorCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMMonitorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkMonitor.Model.CreateMonitorResponse). Specifying the name of a property of type Amazon.NetworkMonitor.Model.CreateMonitorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMMonitorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMProbeCmdlet"> <summary> 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. This action requires the <c>monitorName</c> parameter. Run <c>ListMonitors</c> to get a list of monitor names. Note the name of the <c>monitorName</c> you want to create the probe for. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMProbeCmdlet.Probe_Destination"> <summary> <para> <para>The destination IP address. This must be either <c>IPV4</c> or <c>IPV6</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMProbeCmdlet.Probe_DestinationPort"> <summary> <para> <para>The port associated with the <c>destination</c>. This is required only if the <c>protocol</c> is <c>TCP</c> and must be a number between <c>1</c> and <c>65536</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMProbeCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor to associated with the probe. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMProbeCmdlet.Probe_PacketSize"> <summary> <para> <para>The size of the packets sent between the source and destination. This must be a number between <c>56</c> and <c>8500</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMProbeCmdlet.Probe_Protocol"> <summary> <para> <para>The protocol used for the network traffic between the <c>source</c> and <c>destination</c>. This must be either <c>TCP</c> or <c>ICMP</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMProbeCmdlet.Probe_SourceArn"> <summary> <para> <para>The ARN of the subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMProbeCmdlet.Probe_Tag"> <summary> <para> <para>The list of key-value pairs created and assigned to the monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMProbeCmdlet.Tag"> <summary> <para> <para>The list of key-value pairs created and assigned to the probe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMProbeCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMProbeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkMonitor.Model.CreateProbeResponse). Specifying the name of a property of type Amazon.NetworkMonitor.Model.CreateProbeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.NewCWNMProbeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMMonitorCmdlet"> <summary> Deletes a specified monitor. <para> This action requires the <c>monitorName</c> parameter. Run <c>ListMonitors</c> to get a list of monitor names. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMMonitorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMMonitorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkMonitor.Model.DeleteMonitorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMMonitorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMProbeCmdlet"> <summary> Deletes the specified probe. Once a probe is deleted you'll no longer incur any billing fees for that probe. <para> This action requires both the <c>monitorName</c> and <c>probeId</c> parameters. Run <c>ListMonitors</c> to get a list of monitor names. Run <c>GetMonitor</c> to get a list of probes and probe IDs. You can only delete a single probe at a time using this action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMProbeCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMProbeCmdlet.ProbeId"> <summary> <para> <para>The ID of the probe to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMProbeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkMonitor.Model.DeleteProbeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMProbeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMResourceTagCmdlet"> <summary> Removes a key-value pair from a monitor or probe. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the monitor or probe that the tag should be removed from. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMResourceTagCmdlet.TagKey"> <summary> <para> <para>The key-value pa</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkMonitor.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.RemoveCWNMResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMMonitorCmdlet"> <summary> Updates the <c>aggregationPeriod</c> for a monitor. Monitors support an <c>aggregationPeriod</c> of either <c>30</c> or <c>60</c> seconds. This action requires the <c>monitorName</c> and <c>probeId</c> parameter. Run <c>ListMonitors</c> to get a list of monitor names. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMMonitorCmdlet.AggregationPeriod"> <summary> <para> <para>The aggregation time, in seconds, to change to. This must be either <c>30</c> or <c>60</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMMonitorCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMMonitorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkMonitor.Model.UpdateMonitorResponse). Specifying the name of a property of type Amazon.NetworkMonitor.Model.UpdateMonitorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMMonitorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMProbeCmdlet"> <summary> Updates a monitor probe. This action requires both the <c>monitorName</c> and <c>probeId</c> parameters. Run <c>ListMonitors</c> to get a list of monitor names. Run <c>GetMonitor</c> to get a list of probes and probe IDs. <para> You can update the following para create a monitor with probes using this command. For each probe, you define the following: </para><ul><li><para><c>state</c>—The state of the probe. </para></li><li><para><c>destination</c>— The target destination IP address for the probe. </para></li><li><para><c>destinationPort</c>—Required only if the protocol is <c>TCP</c>. </para></li><li><para><c>protocol</c>—The communication protocol between the source and destination. This will be either <c>TCP</c> or <c>ICMP</c>. </para></li><li><para><c>packetSize</c>—The size of the packets. This must be a number between <c>56</c> and <c>8500</c>. </para></li><li><para> (Optional) <c>tags</c> —Key-value pairs created and assigned to the probe. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMProbeCmdlet.Destination"> <summary> <para> <para>The updated IP address for the probe destination. This must be either an IPv4 or IPv6 address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMProbeCmdlet.DestinationPort"> <summary> <para> <para>The updated port for the probe destination. This is required only if the <c>protocol</c> is <c>TCP</c> and must be a number between <c>1</c> and <c>65536</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMProbeCmdlet.MonitorName"> <summary> <para> <para>The name of the monitor that the probe was updated for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMProbeCmdlet.PacketSize"> <summary> <para> <para>he updated packets size for network traffic between the source and destination. This must be a number between <c>56</c> and <c>8500</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMProbeCmdlet.ProbeId"> <summary> <para> <para>The ID of the probe to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMProbeCmdlet.Protocol"> <summary> <para> <para>The updated network protocol for the destination. This can be either <c>TCP</c> or <c>ICMP</c>. If the protocol is <c>TCP</c>, then <c>port</c> is also required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMProbeCmdlet.State"> <summary> <para> <para>The state of the probe update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMProbeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkMonitor.Model.UpdateProbeResponse). Specifying the name of a property of type Amazon.NetworkMonitor.Model.UpdateProbeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWNM.UpdateCWNMProbeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |