Class: Aws::CloudWatchRUM::Types::CreateAppMonitorRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatchrum/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_monitor_configuration ⇒ Types::AppMonitorConfiguration

A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don’t include ‘AppMonitorConfiguration`, you must set up your own authorization method. For more information, see [Authorize your application to send data to Amazon Web Services].

If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html

Returns:



613
614
615
616
617
618
619
620
621
622
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 613

class CreateAppMonitorRequest < Struct.new(
  :app_monitor_configuration,
  :custom_events,
  :cw_log_enabled,
  :domain,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#custom_events ⇒ Types::CustomEvents

Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are ‘DISABLED`.

For more information about custom events, see [Send custom events].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html

Returns:



613
614
615
616
617
618
619
620
621
622
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 613

class CreateAppMonitorRequest < Struct.new(
  :app_monitor_configuration,
  :custom_events,
  :cw_log_enabled,
  :domain,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#cw_log_enabled ⇒ 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.

If you omit this parameter, the default is ‘false`.

Returns:

  • (Boolean) 


613
614
615
616
617
618
619
620
621
622
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 613

class CreateAppMonitorRequest < Struct.new(
  :app_monitor_configuration,
  :custom_events,
  :cw_log_enabled,
  :domain,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#domain ⇒ String

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

Returns:

  • (String) 


613
614
615
616
617
618
619
620
621
622
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 613

class CreateAppMonitorRequest < Struct.new(
  :app_monitor_configuration,
  :custom_events,
  :cw_log_enabled,
  :domain,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for the app monitor.

Returns:

  • (String) 


613
614
615
616
617
618
619
620
621
622
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 613

class CreateAppMonitorRequest < Struct.new(
  :app_monitor_configuration,
  :custom_events,
  :cw_log_enabled,
  :domain,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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].

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

  • (Hash<String,String>) 


613
614
615
616
617
618
619
620
621
622
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 613

class CreateAppMonitorRequest < Struct.new(
  :app_monitor_configuration,
  :custom_events,
  :cw_log_enabled,
  :domain,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end