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 CloudWatch RUM UpdateAppMonitor API operation.

Syntax

Update-CWRUMAppMonitor
-Name <String>
-AppMonitorConfiguration_AllowCookie <Boolean>
-CwLogEnabled <Boolean>
-Domain <String>
-DomainList <String[]>
-AppMonitorConfiguration_EnableXRay <Boolean>
-AppMonitorConfiguration_ExcludedPage <String[]>
-AppMonitorConfiguration_FavoritePage <String[]>
-AppMonitorConfiguration_GuestRoleArn <String>
-AppMonitorConfiguration_IdentityPoolId <String>
-AppMonitorConfiguration_IncludedPage <String[]>
-JavaScriptSourceMaps_S3Uri <String>
-AppMonitorConfiguration_SessionSampleRate <Double>
-CustomEvents_Status <CustomEventsStatus>
-JavaScriptSourceMaps_Status <DeobfuscationStatus>
-AppMonitorConfiguration_Telemetry <String[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCloudWatchRUMConfig>

Description

Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor configuration that you specify in this operation are changed. For any parameters that you omit, the existing values are kept. You can't use this operation to change the tags of an existing app monitor. To change the tags of an existing app monitor, use TagResource. To create a new app monitor, use CreateAppMonitor. After you update an app monitor, sign in to the CloudWatch RUM console to get the updated JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated?

Parameters

-AppMonitorConfiguration_AllowCookie <Boolean>
If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAppMonitorConfiguration_AllowCookies
-AppMonitorConfiguration_EnableXRay <Boolean>
If you set this to true, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console. For more information, see What is X-Ray?
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AppMonitorConfiguration_ExcludedPage <String[]>
A list of URLs in your website or application to exclude from RUM data collection.You can't include both ExcludedPages and IncludedPages in the same operation. 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)
AliasesAppMonitorConfiguration_ExcludedPages
-AppMonitorConfiguration_FavoritePage <String[]>
A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console. 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)
AliasesAppMonitorConfiguration_FavoritePages
-AppMonitorConfiguration_GuestRoleArn <String>
The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.It is possible that an app monitor does not have a value for GuestRoleArn. For example, this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to create a new identity pool for Authorization. In this case, GuestRoleArn is not present in the GetAppMonitor response because it is not stored by the service.If this issue affects you, you can take one of the following steps:
  • Use the Cloud Development Kit (CDK) to create an identity pool and the associated IAM role, and use that for your app monitor.
  • Make a separate GetIdentityPoolRoles call to Amazon Cognito to retrieve the GuestRoleArn.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AppMonitorConfiguration_IdentityPoolId <String>
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AppMonitorConfiguration_IncludedPage <String[]>
If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. You can't include both ExcludedPages and IncludedPages in the same operation. 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)
AliasesAppMonitorConfiguration_IncludedPages
-AppMonitorConfiguration_SessionSampleRate <Double>
Specifies the portion of user sessions to use for RUM data collection. Choosing a higher portion gives you more data but also incurs more costs.The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0.1 means that 10% of user sessions are sampled.If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AppMonitorConfiguration_Telemetry <String[]>
An array that lists the types of telemetry data that this app monitor is to collect.
  • errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.
  • performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.
  • http indicates that RUM collects data about HTTP errors thrown by your application.
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)
AliasesAppMonitorConfiguration_Telemetries
-ClientConfig <AmazonCloudWatchRUMConfig>
Amazon.PowerShell.Cmdlets.CWRUM.AmazonCloudWatchRUMClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomEvents_Status <CustomEventsStatus>
Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CwLogEnabled <Boolean>
Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Domain <String>
The top-level internet domain name for which your application has administrative authority.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainList <String[]>
List the domain names for which your application has administrative authority. The UpdateAppMonitor allows either the domain or the domain list. 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)
-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)
-JavaScriptSourceMaps_S3Uri <String>
The S3Uri of the bucket or folder that stores the source map files. It is required if status is ENABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeobfuscationConfiguration_JavaScriptSourceMaps_S3Uri
-JavaScriptSourceMaps_Status <DeobfuscationStatus>
Specifies whether JavaScript error stack traces should be unminified for this app monitor. The default is for JavaScript error stack trace unminification to be DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeobfuscationConfiguration_JavaScriptSourceMaps_Status
-Name <String>
The name of the app monitor to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Select <String>
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.CloudWatchRUM.Model.UpdateAppMonitorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
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

None or Amazon.CloudWatchRUM.Model.UpdateAppMonitorResponse
This cmdlet does not generate any output.The service response (type Amazon.CloudWatchRUM.Model.UpdateAppMonitorResponse) be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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