AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon CloudWatch Internet Monitor UpdateMonitor API operation.

Syntax

Update-CWIMMonitor
-MonitorName <String>
-HealthEventsConfig_AvailabilityScoreThreshold <Double>
-S3Config_BucketName <String>
-S3Config_BucketPrefix <String>
-AvailabilityLocalHealthEventsConfig_HealthScoreThreshold <Double>
-PerformanceLocalHealthEventsConfig_HealthScoreThreshold <Double>
-S3Config_LogDeliveryStatus <LogDeliveryStatus>
-MaxCityNetworksToMonitor <Int32>
-AvailabilityLocalHealthEventsConfig_MinTrafficImpact <Double>
-PerformanceLocalHealthEventsConfig_MinTrafficImpact <Double>
-HealthEventsConfig_PerformanceScoreThreshold <Double>
-ResourcesToAdd <String[]>
-ResourcesToRemove <String[]>
-AvailabilityLocalHealthEventsConfig_Status <LocalHealthEventsConfigStatus>
-PerformanceLocalHealthEventsConfig_Status <LocalHealthEventsConfigStatus>
-Status <MonitorConfigState>
-TrafficPercentageToMonitor <Int32>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonInternetMonitorConfig>

Description

Updates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks (locations and ASNs), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor. The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.

Parameters

-AvailabilityLocalHealthEventsConfig_HealthScoreThreshold <Double>
The health event threshold percentage set for a local health score.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHealthEventsConfig_AvailabilityLocalHealthEventsConfig_HealthScoreThreshold
-AvailabilityLocalHealthEventsConfig_MinTrafficImpact <Double>
The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.If you don't set a minimum traffic impact threshold, the default value is 0.1%.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHealthEventsConfig_AvailabilityLocalHealthEventsConfig_MinTrafficImpact
-AvailabilityLocalHealthEventsConfig_Status <LocalHealthEventsConfigStatus>
The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHealthEventsConfig_AvailabilityLocalHealthEventsConfig_Status
-ClientConfig <AmazonInternetMonitorConfig>
Amazon.PowerShell.Cmdlets.CWIM.AmazonInternetMonitorClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. You should not reuse the same client token for other API requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HealthEventsConfig_AvailabilityScoreThreshold <Double>
The health event threshold percentage set for availability scores.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HealthEventsConfig_PerformanceScoreThreshold <Double>
The health event threshold percentage set for performance scores.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxCityNetworksToMonitor <Int32>
The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MonitorName <String>
The name of the monitor.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PerformanceLocalHealthEventsConfig_HealthScoreThreshold <Double>
The health event threshold percentage set for a local health score.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHealthEventsConfig_PerformanceLocalHealthEventsConfig_HealthScoreThreshold
-PerformanceLocalHealthEventsConfig_MinTrafficImpact <Double>
The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.If you don't set a minimum traffic impact threshold, the default value is 0.1%.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHealthEventsConfig_PerformanceLocalHealthEventsConfig_MinTrafficImpact
-PerformanceLocalHealthEventsConfig_Status <LocalHealthEventsConfigStatus>
The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHealthEventsConfig_PerformanceLocalHealthEventsConfig_Status
-ResourcesToAdd <String[]>
The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.If you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourcesToRemove <String[]>
The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs). Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Config_BucketName <String>
The Amazon S3 bucket name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInternetMeasurementsLogDelivery_S3Config_BucketName
-S3Config_BucketPrefix <String>
The Amazon S3 bucket prefix.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInternetMeasurementsLogDelivery_S3Config_BucketPrefix
-S3Config_LogDeliveryStatus <LogDeliveryStatus>
The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInternetMeasurementsLogDelivery_S3Config_LogDeliveryStatus
-Select <String>
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.InternetMonitor.Model.UpdateMonitorResponse). Specifying the name of a property of type Amazon.InternetMonitor.Model.UpdateMonitorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Status <MonitorConfigState>
The status for a monitor. The accepted values for Status with the UpdateMonitor API call are the following: ACTIVE and INACTIVE. The following values are not accepted: PENDING, and ERROR.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TrafficPercentageToMonitor <Int32>
The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.InternetMonitor.Model.UpdateMonitorResponse
This cmdlet returns an Amazon.InternetMonitor.Model.UpdateMonitorResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z