1. Packages
  2. AWS Classic
  3. API Docs
  4. rum
  5. AppMonitor

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.rum.AppMonitor

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Provides a CloudWatch RUM App Monitor resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.rum.AppMonitor("example", {
        name: "example",
        domain: "localhost",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.rum.AppMonitor("example",
        name="example",
        domain="localhost")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rum"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := rum.NewAppMonitor(ctx, "example", &rum.AppMonitorArgs{
    			Name:   pulumi.String("example"),
    			Domain: pulumi.String("localhost"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Rum.AppMonitor("example", new()
        {
            Name = "example",
            Domain = "localhost",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.rum.AppMonitor;
    import com.pulumi.aws.rum.AppMonitorArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new AppMonitor("example", AppMonitorArgs.builder()
                .name("example")
                .domain("localhost")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:rum:AppMonitor
        properties:
          name: example
          domain: localhost
    

    Create AppMonitor Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AppMonitor(name: string, args: AppMonitorArgs, opts?: CustomResourceOptions);
    @overload
    def AppMonitor(resource_name: str,
                   args: AppMonitorArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def AppMonitor(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   domain: Optional[str] = None,
                   app_monitor_configuration: Optional[AppMonitorAppMonitorConfigurationArgs] = None,
                   custom_events: Optional[AppMonitorCustomEventsArgs] = None,
                   cw_log_enabled: Optional[bool] = None,
                   name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewAppMonitor(ctx *Context, name string, args AppMonitorArgs, opts ...ResourceOption) (*AppMonitor, error)
    public AppMonitor(string name, AppMonitorArgs args, CustomResourceOptions? opts = null)
    public AppMonitor(String name, AppMonitorArgs args)
    public AppMonitor(String name, AppMonitorArgs args, CustomResourceOptions options)
    
    type: aws:rum:AppMonitor
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AppMonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AppMonitorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AppMonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppMonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppMonitorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var appMonitorResource = new Aws.Rum.AppMonitor("appMonitorResource", new()
    {
        Domain = "string",
        AppMonitorConfiguration = new Aws.Rum.Inputs.AppMonitorAppMonitorConfigurationArgs
        {
            AllowCookies = false,
            EnableXray = false,
            ExcludedPages = new[]
            {
                "string",
            },
            FavoritePages = new[]
            {
                "string",
            },
            GuestRoleArn = "string",
            IdentityPoolId = "string",
            IncludedPages = new[]
            {
                "string",
            },
            SessionSampleRate = 0,
            Telemetries = new[]
            {
                "string",
            },
        },
        CustomEvents = new Aws.Rum.Inputs.AppMonitorCustomEventsArgs
        {
            Status = "string",
        },
        CwLogEnabled = false,
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := rum.NewAppMonitor(ctx, "appMonitorResource", &rum.AppMonitorArgs{
    	Domain: pulumi.String("string"),
    	AppMonitorConfiguration: &rum.AppMonitorAppMonitorConfigurationArgs{
    		AllowCookies: pulumi.Bool(false),
    		EnableXray:   pulumi.Bool(false),
    		ExcludedPages: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		FavoritePages: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		GuestRoleArn:   pulumi.String("string"),
    		IdentityPoolId: pulumi.String("string"),
    		IncludedPages: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		SessionSampleRate: pulumi.Float64(0),
    		Telemetries: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	CustomEvents: &rum.AppMonitorCustomEventsArgs{
    		Status: pulumi.String("string"),
    	},
    	CwLogEnabled: pulumi.Bool(false),
    	Name:         pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var appMonitorResource = new AppMonitor("appMonitorResource", AppMonitorArgs.builder()
        .domain("string")
        .appMonitorConfiguration(AppMonitorAppMonitorConfigurationArgs.builder()
            .allowCookies(false)
            .enableXray(false)
            .excludedPages("string")
            .favoritePages("string")
            .guestRoleArn("string")
            .identityPoolId("string")
            .includedPages("string")
            .sessionSampleRate(0)
            .telemetries("string")
            .build())
        .customEvents(AppMonitorCustomEventsArgs.builder()
            .status("string")
            .build())
        .cwLogEnabled(false)
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    app_monitor_resource = aws.rum.AppMonitor("appMonitorResource",
        domain="string",
        app_monitor_configuration=aws.rum.AppMonitorAppMonitorConfigurationArgs(
            allow_cookies=False,
            enable_xray=False,
            excluded_pages=["string"],
            favorite_pages=["string"],
            guest_role_arn="string",
            identity_pool_id="string",
            included_pages=["string"],
            session_sample_rate=0,
            telemetries=["string"],
        ),
        custom_events=aws.rum.AppMonitorCustomEventsArgs(
            status="string",
        ),
        cw_log_enabled=False,
        name="string",
        tags={
            "string": "string",
        })
    
    const appMonitorResource = new aws.rum.AppMonitor("appMonitorResource", {
        domain: "string",
        appMonitorConfiguration: {
            allowCookies: false,
            enableXray: false,
            excludedPages: ["string"],
            favoritePages: ["string"],
            guestRoleArn: "string",
            identityPoolId: "string",
            includedPages: ["string"],
            sessionSampleRate: 0,
            telemetries: ["string"],
        },
        customEvents: {
            status: "string",
        },
        cwLogEnabled: false,
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:rum:AppMonitor
    properties:
        appMonitorConfiguration:
            allowCookies: false
            enableXray: false
            excludedPages:
                - string
            favoritePages:
                - string
            guestRoleArn: string
            identityPoolId: string
            includedPages:
                - string
            sessionSampleRate: 0
            telemetries:
                - string
        customEvents:
            status: string
        cwLogEnabled: false
        domain: string
        name: string
        tags:
            string: string
    

    AppMonitor Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AppMonitor resource accepts the following input properties:

    Domain string
    The top-level internet domain name for which your application has administrative authority.
    AppMonitorConfiguration AppMonitorAppMonitorConfiguration
    configuration data for the app monitor. See app_monitor_configuration below.
    CustomEvents AppMonitorCustomEvents
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED. See custom_events below.
    CwLogEnabled bool
    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. Default value is false.
    Name string
    The name of the log stream.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Domain string
    The top-level internet domain name for which your application has administrative authority.
    AppMonitorConfiguration AppMonitorAppMonitorConfigurationArgs
    configuration data for the app monitor. See app_monitor_configuration below.
    CustomEvents AppMonitorCustomEventsArgs
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED. See custom_events below.
    CwLogEnabled bool
    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. Default value is false.
    Name string
    The name of the log stream.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    domain String
    The top-level internet domain name for which your application has administrative authority.
    appMonitorConfiguration AppMonitorAppMonitorConfiguration
    configuration data for the app monitor. See app_monitor_configuration below.
    customEvents AppMonitorCustomEvents
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED. See custom_events below.
    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. Default value is false.
    name String
    The name of the log stream.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    domain string
    The top-level internet domain name for which your application has administrative authority.
    appMonitorConfiguration AppMonitorAppMonitorConfiguration
    configuration data for the app monitor. See app_monitor_configuration below.
    customEvents AppMonitorCustomEvents
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED. See custom_events below.
    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. Default value is false.
    name string
    The name of the log stream.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    domain str
    The top-level internet domain name for which your application has administrative authority.
    app_monitor_configuration AppMonitorAppMonitorConfigurationArgs
    configuration data for the app monitor. See app_monitor_configuration below.
    custom_events AppMonitorCustomEventsArgs
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED. See custom_events below.
    cw_log_enabled bool
    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. Default value is false.
    name str
    The name of the log stream.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    domain String
    The top-level internet domain name for which your application has administrative authority.
    appMonitorConfiguration Property Map
    configuration data for the app monitor. See app_monitor_configuration below.
    customEvents Property Map
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED. See custom_events below.
    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. Default value is false.
    name String
    The name of the log stream.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AppMonitor resource produces the following output properties:

    AppMonitorId string
    The unique ID of the app monitor. Useful for JS templates.
    Arn string
    The Amazon Resource Name (ARN) specifying the app monitor.
    CwLogGroup string
    The name of the log group where the copies are stored.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    AppMonitorId string
    The unique ID of the app monitor. Useful for JS templates.
    Arn string
    The Amazon Resource Name (ARN) specifying the app monitor.
    CwLogGroup string
    The name of the log group where the copies are stored.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    appMonitorId String
    The unique ID of the app monitor. Useful for JS templates.
    arn String
    The Amazon Resource Name (ARN) specifying the app monitor.
    cwLogGroup String
    The name of the log group where the copies are stored.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    appMonitorId string
    The unique ID of the app monitor. Useful for JS templates.
    arn string
    The Amazon Resource Name (ARN) specifying the app monitor.
    cwLogGroup string
    The name of the log group where the copies are stored.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    app_monitor_id str
    The unique ID of the app monitor. Useful for JS templates.
    arn str
    The Amazon Resource Name (ARN) specifying the app monitor.
    cw_log_group str
    The name of the log group where the copies are stored.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    appMonitorId String
    The unique ID of the app monitor. Useful for JS templates.
    arn String
    The Amazon Resource Name (ARN) specifying the app monitor.
    cwLogGroup String
    The name of the log group where the copies are stored.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing AppMonitor Resource

    Get an existing AppMonitor resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AppMonitorState, opts?: CustomResourceOptions): AppMonitor
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app_monitor_configuration: Optional[AppMonitorAppMonitorConfigurationArgs] = None,
            app_monitor_id: Optional[str] = None,
            arn: Optional[str] = None,
            custom_events: Optional[AppMonitorCustomEventsArgs] = None,
            cw_log_enabled: Optional[bool] = None,
            cw_log_group: Optional[str] = None,
            domain: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> AppMonitor
    func GetAppMonitor(ctx *Context, name string, id IDInput, state *AppMonitorState, opts ...ResourceOption) (*AppMonitor, error)
    public static AppMonitor Get(string name, Input<string> id, AppMonitorState? state, CustomResourceOptions? opts = null)
    public static AppMonitor get(String name, Output<String> id, AppMonitorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppMonitorConfiguration AppMonitorAppMonitorConfiguration
    configuration data for the app monitor. See app_monitor_configuration below.
    AppMonitorId string
    The unique ID of the app monitor. Useful for JS templates.
    Arn string
    The Amazon Resource Name (ARN) specifying the app monitor.
    CustomEvents AppMonitorCustomEvents
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED. See custom_events below.
    CwLogEnabled bool
    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. Default value is false.
    CwLogGroup string
    The name of the log group where the copies are stored.
    Domain string
    The top-level internet domain name for which your application has administrative authority.
    Name string
    The name of the log stream.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    AppMonitorConfiguration AppMonitorAppMonitorConfigurationArgs
    configuration data for the app monitor. See app_monitor_configuration below.
    AppMonitorId string
    The unique ID of the app monitor. Useful for JS templates.
    Arn string
    The Amazon Resource Name (ARN) specifying the app monitor.
    CustomEvents AppMonitorCustomEventsArgs
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED. See custom_events below.
    CwLogEnabled bool
    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. Default value is false.
    CwLogGroup string
    The name of the log group where the copies are stored.
    Domain string
    The top-level internet domain name for which your application has administrative authority.
    Name string
    The name of the log stream.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    appMonitorConfiguration AppMonitorAppMonitorConfiguration
    configuration data for the app monitor. See app_monitor_configuration below.
    appMonitorId String
    The unique ID of the app monitor. Useful for JS templates.
    arn String
    The Amazon Resource Name (ARN) specifying the app monitor.
    customEvents AppMonitorCustomEvents
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED. See custom_events below.
    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. Default value is false.
    cwLogGroup String
    The name of the log group where the copies are stored.
    domain String
    The top-level internet domain name for which your application has administrative authority.
    name String
    The name of the log stream.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    appMonitorConfiguration AppMonitorAppMonitorConfiguration
    configuration data for the app monitor. See app_monitor_configuration below.
    appMonitorId string
    The unique ID of the app monitor. Useful for JS templates.
    arn string
    The Amazon Resource Name (ARN) specifying the app monitor.
    customEvents AppMonitorCustomEvents
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED. See custom_events below.
    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. Default value is false.
    cwLogGroup string
    The name of the log group where the copies are stored.
    domain string
    The top-level internet domain name for which your application has administrative authority.
    name string
    The name of the log stream.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    app_monitor_configuration AppMonitorAppMonitorConfigurationArgs
    configuration data for the app monitor. See app_monitor_configuration below.
    app_monitor_id str
    The unique ID of the app monitor. Useful for JS templates.
    arn str
    The Amazon Resource Name (ARN) specifying the app monitor.
    custom_events AppMonitorCustomEventsArgs
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED. See custom_events below.
    cw_log_enabled bool
    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. Default value is false.
    cw_log_group str
    The name of the log group where the copies are stored.
    domain str
    The top-level internet domain name for which your application has administrative authority.
    name str
    The name of the log stream.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    appMonitorConfiguration Property Map
    configuration data for the app monitor. See app_monitor_configuration below.
    appMonitorId String
    The unique ID of the app monitor. Useful for JS templates.
    arn String
    The Amazon Resource Name (ARN) specifying the app monitor.
    customEvents Property Map
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED. See custom_events below.
    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. Default value is false.
    cwLogGroup String
    The name of the log group where the copies are stored.
    domain String
    The top-level internet domain name for which your application has administrative authority.
    name String
    The name of the log stream.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    AppMonitorAppMonitorConfiguration, AppMonitorAppMonitorConfigurationArgs

    AllowCookies bool
    If you set this to true, 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.
    EnableXray bool
    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.
    ExcludedPages List<string>
    A list of URLs in your website or application to exclude from RUM data collection.
    FavoritePages List<string>
    A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
    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.
    IdentityPoolId string
    The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
    IncludedPages List<string>
    If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
    SessionSampleRate double
    Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. Default value is 0.1.
    Telemetries List<string>
    An array that lists the types of telemetry data that this app monitor is to collect. Valid values are errors, performance, and http.
    AllowCookies bool
    If you set this to true, 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.
    EnableXray bool
    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.
    ExcludedPages []string
    A list of URLs in your website or application to exclude from RUM data collection.
    FavoritePages []string
    A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
    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.
    IdentityPoolId string
    The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
    IncludedPages []string
    If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
    SessionSampleRate float64
    Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. Default value is 0.1.
    Telemetries []string
    An array that lists the types of telemetry data that this app monitor is to collect. Valid values are errors, performance, and http.
    allowCookies Boolean
    If you set this to true, 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.
    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.
    excludedPages List<String>
    A list of URLs in your website or application to exclude from RUM data collection.
    favoritePages List<String>
    A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
    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.
    identityPoolId String
    The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
    includedPages List<String>
    If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
    sessionSampleRate Double
    Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. Default value is 0.1.
    telemetries List<String>
    An array that lists the types of telemetry data that this app monitor is to collect. Valid values are errors, performance, and http.
    allowCookies boolean
    If you set this to true, 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.
    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.
    excludedPages string[]
    A list of URLs in your website or application to exclude from RUM data collection.
    favoritePages string[]
    A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
    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.
    identityPoolId string
    The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
    includedPages string[]
    If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
    sessionSampleRate number
    Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. Default value is 0.1.
    telemetries string[]
    An array that lists the types of telemetry data that this app monitor is to collect. Valid values are errors, performance, and http.
    allow_cookies bool
    If you set this to true, 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.
    enable_xray bool
    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.
    excluded_pages Sequence[str]
    A list of URLs in your website or application to exclude from RUM data collection.
    favorite_pages Sequence[str]
    A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
    guest_role_arn str
    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.
    identity_pool_id str
    The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
    included_pages Sequence[str]
    If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
    session_sample_rate float
    Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. Default value is 0.1.
    telemetries Sequence[str]
    An array that lists the types of telemetry data that this app monitor is to collect. Valid values are errors, performance, and http.
    allowCookies Boolean
    If you set this to true, 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.
    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.
    excludedPages List<String>
    A list of URLs in your website or application to exclude from RUM data collection.
    favoritePages List<String>
    A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
    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.
    identityPoolId String
    The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
    includedPages List<String>
    If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
    sessionSampleRate Number
    Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. Default value is 0.1.
    telemetries List<String>
    An array that lists the types of telemetry data that this app monitor is to collect. Valid values are errors, performance, and http.

    AppMonitorCustomEvents, AppMonitorCustomEventsArgs

    Status string
    Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED. Valid values are DISABLED and ENABLED.
    Status string
    Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED. Valid values are DISABLED and ENABLED.
    status String
    Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED. Valid values are DISABLED and ENABLED.
    status string
    Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED. Valid values are DISABLED and ENABLED.
    status str
    Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED. Valid values are DISABLED and ENABLED.
    status String
    Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED. Valid values are DISABLED and ENABLED.

    Import

    Using pulumi import, import Cloudwatch RUM App Monitor using the name. For example:

    $ pulumi import aws:rum/appMonitor:AppMonitor example example
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi