awsrum

Documentation

Index

• func CfnAppMonitor_CFN_RESOURCE_TYPE_NAME() *string
• func CfnAppMonitor_IsCfnElement(x interface{}) *bool
• func CfnAppMonitor_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnAppMonitor_IsConstruct(x interface{}) *bool
• func NewCfnAppMonitor_Override(c CfnAppMonitor, scope constructs.Construct, id *string, ...)
• type CfnAppMonitor
  • func NewCfnAppMonitor(scope constructs.Construct, id *string, props *CfnAppMonitorProps) CfnAppMonitor
• type CfnAppMonitorProps
• type CfnAppMonitor_AppMonitorConfigurationProperty

Functions

func CfnAppMonitor_CFN_RESOURCE_TYPE_NAME

func CfnAppMonitor_CFN_RESOURCE_TYPE_NAME() *string

func CfnAppMonitor_IsCfnElement

func CfnAppMonitor_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnAppMonitor_IsCfnResource

func CfnAppMonitor_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAppMonitor_IsConstruct

func CfnAppMonitor_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnAppMonitor_Override

func NewCfnAppMonitor_Override(c CfnAppMonitor, scope constructs.Construct, id *string, props *CfnAppMonitorProps)

Create a new `AWS::RUM::AppMonitor`.

Types

type CfnAppMonitor

type CfnAppMonitor interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AppMonitorConfiguration() interface{}
	SetAppMonitorConfiguration(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	CwLogEnabled() interface{}
	SetCwLogEnabled(val interface{})
	Domain() *string
	SetDomain(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::RUM::AppMonitor`.

Creates a CloudWatch RUM app monitor, which you can use to collect telemetry data from your application and send it to CloudWatch RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.

After you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see [How do I find a code snippet that I've already generated?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html)

TODO: EXAMPLE

func NewCfnAppMonitor

func NewCfnAppMonitor(scope constructs.Construct, id *string, props *CfnAppMonitorProps) CfnAppMonitor

Create a new `AWS::RUM::AppMonitor`.

type CfnAppMonitorProps

type CfnAppMonitorProps struct {
	// 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](https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html) .
	//
	// If you omit this argument, the sample rate used for CloudWatch RUM is set to 10% of the user sessions.
	AppMonitorConfiguration interface{} `json:"appMonitorConfiguration" yaml:"appMonitorConfiguration"`
	// 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` .
	CwLogEnabled interface{} `json:"cwLogEnabled" yaml:"cwLogEnabled"`
	// The top-level internet domain name for which your application has administrative authority.
	//
	// This parameter is required.
	Domain *string `json:"domain" yaml:"domain"`
	// A name for the app monitor.
	//
	// This parameter is required.
	Name *string `json:"name" yaml:"name"`
	// 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnAppMonitor`.

TODO: EXAMPLE

type CfnAppMonitor_AppMonitorConfigurationProperty

type CfnAppMonitor_AppMonitorConfigurationProperty struct {
	// If you set this to `true` , the CloudWatch RUM web client sets two cookies, a session cookie and a user cookie.
	//
	// The cookies allow the CloudWatch 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.
	AllowCookies interface{} `json:"allowCookies" yaml:"allowCookies"`
	// If you set this to `true` , CloudWatch RUM sends client-side traces to X-Ray for each sampled session.
	//
	// You can then see traces and segments from these user sessions in the RUM dashboard and the CloudWatch ServiceLens console. For more information, see [What is AWS X-Ray ?](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html)
	EnableXRay interface{} `json:"enableXRay" yaml:"enableXRay"`
	// 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 app monitor.
	ExcludedPages *[]*string `json:"excludedPages" yaml:"excludedPages"`
	// A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.
	FavoritePages *[]*string `json:"favoritePages" yaml:"favoritePages"`
	// 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 CloudWatch RUM.
	GuestRoleArn *string `json:"guestRoleArn" yaml:"guestRoleArn"`
	// The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM.
	IdentityPoolId *string `json:"identityPoolId" yaml:"identityPoolId"`
	// 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 app monitor.
	IncludedPages *[]*string `json:"includedPages" yaml:"includedPages"`
	// Specifies the portion of user sessions to use for CloudWatch 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.
	SessionSampleRate *float64 `json:"sessionSampleRate" yaml:"sessionSampleRate"`
	// 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.
	Telemetries *[]*string `json:"telemetries" yaml:"telemetries"`
}

This structure contains much of the configuration data for the app monitor.

TODO: EXAMPLE