Package software.amazon.awscdk.services.rum

Class CfnAppMonitor.Builder

java.lang.Object
software.amazon.awscdk.services.rum.CfnAppMonitor.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAppMonitor>
Enclosing class:
CfnAppMonitor
@Stability(Stable) public static final class CfnAppMonitor.Builder extends Object implements software.amazon.jsii.Builder<CfnAppMonitor>
A fluent builder for CfnAppMonitor.

  • Method Details

    • create

      @Stability(Stable) public static CfnAppMonitor.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnAppMonitor.Builder.

    • domain

      @Stability(Stable) public CfnAppMonitor.Builder domain(String domain)
      The top-level internet domain name for which your application has administrative authority.

      This parameter is required.

      Parameters:
      domain - The top-level internet domain name for which your application has administrative authority. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnAppMonitor.Builder name(String name)
      A name for the app monitor.

      This parameter is required.

      Parameters:
      name - A name for the app monitor. This parameter is required.
      Returns:
      this

    • appMonitorConfiguration

      @Stability(Stable) public CfnAppMonitor.Builder appMonitorConfiguration(CfnAppMonitor.AppMonitorConfigurationProperty 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 AWS .

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

      Parameters:
      appMonitorConfiguration - A structure that contains much of the configuration data for the app monitor. This parameter is required.
      Returns:
      this

    • appMonitorConfiguration

      @Stability(Stable) public CfnAppMonitor.Builder appMonitorConfiguration(IResolvable 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 AWS .

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

      Parameters:
      appMonitorConfiguration - A structure that contains much of the configuration data for the app monitor. This parameter is required.
      Returns:
      this

    • customEvents

      @Stability(Stable) public CfnAppMonitor.Builder customEvents(IResolvable 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 .

      Parameters:
      customEvents - Specifies whether this app monitor allows the web client to define and send custom events. This parameter is required.
      Returns:
      this

    • customEvents

      @Stability(Stable) public CfnAppMonitor.Builder customEvents(CfnAppMonitor.CustomEventsProperty 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 .

      Parameters:
      customEvents - Specifies whether this app monitor allows the web client to define and send custom events. This parameter is required.
      Returns:
      this

    • cwLogEnabled

      @Stability(Stable) public CfnAppMonitor.Builder cwLogEnabled(Boolean cwLogEnabled)
      Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.

      This parameter specifies whether CloudWatch 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 .

      Parameters:
      cwLogEnabled - Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted. This parameter is required.
      Returns:
      this

    • cwLogEnabled

      @Stability(Stable) public CfnAppMonitor.Builder cwLogEnabled(IResolvable cwLogEnabled)
      Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.

      This parameter specifies whether CloudWatch 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 .

      Parameters:
      cwLogEnabled - Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnAppMonitor.Builder tags(List<? extends CfnTag> tags)
      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 AWS 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 AWS resources .

      Parameters:
      tags - Assigns one or more tags (key-value pairs) to the app monitor. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnAppMonitor build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnAppMonitor>
      Returns:
      a newly built instance of CfnAppMonitor.