AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

getAppMonitor

Resource Type definition for AWS::RUM::AppMonitor

Using getAppMonitor

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAppMonitor(args: GetAppMonitorArgs, opts?: InvokeOptions): Promise<GetAppMonitorResult>
function getAppMonitorOutput(args: GetAppMonitorOutputArgs, opts?: InvokeOptions): Output<GetAppMonitorResult>
def get_app_monitor(name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAppMonitorResult
def get_app_monitor_output(name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAppMonitorResult]
func LookupAppMonitor(ctx *Context, args *LookupAppMonitorArgs, opts ...InvokeOption) (*LookupAppMonitorResult, error)
func LookupAppMonitorOutput(ctx *Context, args *LookupAppMonitorOutputArgs, opts ...InvokeOption) LookupAppMonitorResultOutput

> Note: This function is named LookupAppMonitor in the Go SDK.

public static class GetAppMonitor 
{
    public static Task<GetAppMonitorResult> InvokeAsync(GetAppMonitorArgs args, InvokeOptions? opts = null)
    public static Output<GetAppMonitorResult> Invoke(GetAppMonitorInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAppMonitorResult> getAppMonitor(GetAppMonitorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:rum:getAppMonitor
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string

A name for the app monitor

Name string

A name for the app monitor

name String

A name for the app monitor

name string

A name for the app monitor

name str

A name for the app monitor

name String

A name for the app monitor

getAppMonitor Result

The following output properties are available:

AppMonitorConfiguration Pulumi.AwsNative.RUM.Outputs.AppMonitorConfiguration
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 CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false

Domain string

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

Tags List<Pulumi.AwsNative.RUM.Outputs.AppMonitorTag>
AppMonitorConfiguration AppMonitorConfiguration
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 CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false

Domain string

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

Tags []AppMonitorTag
appMonitorConfiguration AppMonitorConfiguration
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 CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false

domain String

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

tags List<AppMonitorTag>
appMonitorConfiguration AppMonitorConfiguration
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 CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false

domain string

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

tags AppMonitorTag[]
app_monitor_configuration AppMonitorConfiguration
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 CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false

domain str

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

tags Sequence[AppMonitorTag]
appMonitorConfiguration Property Map
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 CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false

domain String

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

tags List<Property Map>

Supporting Types

AppMonitorConfiguration

AllowCookies bool

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.

EnableXRay bool

If you set this to true, RUM enables xray tracing for the user sessions that RUM samples. RUM adds an xray trace header to allowed HTTP requests. It also records an xray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the xray console and the CW ServiceLens console.

ExcludedPages List<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.

FavoritePages List<string>

A list of pages in the 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 identity pool that is used to authorize the sending of data to RUM.

IdentityPoolId string

The ID of the 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. You can't include both ExcludedPages and IncludedPages in the same operation.

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

Telemetries List<Pulumi.AwsNative.RUM.AppMonitorTelemetry>

An array that lists the types of telemetry data that this app monitor is to collect.

AllowCookies bool

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.

EnableXRay bool

If you set this to true, RUM enables xray tracing for the user sessions that RUM samples. RUM adds an xray trace header to allowed HTTP requests. It also records an xray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the xray console and the CW ServiceLens console.

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

FavoritePages []string

A list of pages in the 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 identity pool that is used to authorize the sending of data to RUM.

IdentityPoolId string

The ID of the 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. You can't include both ExcludedPages and IncludedPages in the same operation.

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

Telemetries []AppMonitorTelemetry

An array that lists the types of telemetry data that this app monitor is to collect.

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

enableXRay Boolean

If you set this to true, RUM enables xray tracing for the user sessions that RUM samples. RUM adds an xray trace header to allowed HTTP requests. It also records an xray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the xray console and the CW ServiceLens console.

excludedPages List<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.

favoritePages List<String>

A list of pages in the 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 identity pool that is used to authorize the sending of data to RUM.

identityPoolId String

The ID of the 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. You can't include both ExcludedPages and IncludedPages in the same operation.

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

telemetries List<AppMonitorTelemetry>

An array that lists the types of telemetry data that this app monitor is to collect.

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

enableXRay boolean

If you set this to true, RUM enables xray tracing for the user sessions that RUM samples. RUM adds an xray trace header to allowed HTTP requests. It also records an xray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the xray console and the CW ServiceLens console.

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

favoritePages string[]

A list of pages in the 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 identity pool that is used to authorize the sending of data to RUM.

identityPoolId string

The ID of the 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. You can't include both ExcludedPages and IncludedPages in the same operation.

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

telemetries AppMonitorTelemetry[]

An array that lists the types of telemetry data that this app monitor is to collect.

allow_cookies bool

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.

enable_x_ray bool

If you set this to true, RUM enables xray tracing for the user sessions that RUM samples. RUM adds an xray trace header to allowed HTTP requests. It also records an xray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the xray console and the CW ServiceLens console.

excluded_pages Sequence[str]

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.

favorite_pages Sequence[str]

A list of pages in the 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 identity pool that is used to authorize the sending of data to RUM.

identity_pool_id str

The ID of the 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. You can't include both ExcludedPages and IncludedPages in the same operation.

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

telemetries Sequence[AppMonitorTelemetry]

An array that lists the types of telemetry data that this app monitor is to collect.

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

enableXRay Boolean

If you set this to true, RUM enables xray tracing for the user sessions that RUM samples. RUM adds an xray trace header to allowed HTTP requests. It also records an xray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the xray console and the CW ServiceLens console.

excludedPages List<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.

favoritePages List<String>

A list of pages in the 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 identity pool that is used to authorize the sending of data to RUM.

identityPoolId String

The ID of the 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. You can't include both ExcludedPages and IncludedPages in the same operation.

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

telemetries List<"errors" | "performance" | "http">

An array that lists the types of telemetry data that this app monitor is to collect.

AppMonitorTag

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value str

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

AppMonitorTelemetry

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0