New-CWRUMAppMonitor Cmdlet

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.

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?

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.

A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.

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.

The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

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.

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.

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.

Amazon.PowerShell.Cmdlets.CWRUM.AmazonCloudWatchRUMClientCmdlet.ClientConfig

Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.

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.If you omit this parameter, the default is false.

The top-level internet domain name for which your application has administrative authority.

This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.

A name for the app monitor.

Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.

Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchRUM.Model.CreateAppMonitorResponse). Specifying the name of a property of type Amazon.CloudWatchRUM.Model.CreateAppMonitorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.

Assigns one or more tags (key-value pairs) to the app monitor.Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.You can associate as many as 50 tags with an app monitor.For more information, see Tagging Amazon Web Services resources.

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.

An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.

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.

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.

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.

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.

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.

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.

The session token if the access and secret keys are temporary session-based credentials.