awsrum

package
v2.142.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 17, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

README

AWS::RUM Construct Library

This module is part of the AWS Cloud Development Kit project.

import rum "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::RUM.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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(x interface{}) *bool

Check whether the given object is a CfnResource.

func CfnAppMonitor_IsConstruct 

func CfnAppMonitor_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

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

func NewCfnAppMonitor_Override 

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

Types

type CfnAppMonitor 

type CfnAppMonitor interface {
	awscdk.CfnResource
	awscdk.IInspectable
	awscdk.ITaggable
	// A structure that contains much of the configuration data for the app monitor.
	AppMonitorConfiguration() interface{}
	SetAppMonitorConfiguration(val interface{})
	// The ID of the app monitor, such as `123456ab-1234-4ca9-9d2f-a1b2c3456789` .
	AttrId() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// Specifies whether this app monitor allows the web client to define and send custom events.
	CustomEvents() interface{}
	SetCustomEvents(val interface{})
	// Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.
	CwLogEnabled() interface{}
	SetCwLogEnabled(val interface{})
	// The top-level internet domain name for which your application has administrative authority.
	Domain() *string
	SetDomain(val *string)
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// A name for the app monitor.
	Name() *string
	SetName(val *string)
	// The tree node.
	Node() constructs.Node
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// Tag Manager which manages the tags for this resource.
	Tags() awscdk.TagManager
	// Assigns one or more tags (key-value pairs) to the app monitor.
	TagsRaw() *[]*awscdk.CfnTag
	SetTagsRaw(val *[]*awscdk.CfnTag)
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//   "GlobalSecondaryIndexes": [
	//     {
	//       "Projection": {
	//         "NonKeyAttributes": [ "myattribute" ]
	//         ...
	//       }
	//       ...
	//     },
	//     {
	//       "ProjectionType": "INCLUDE"
	//       ...
	//     },
	//   ]
	//   ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

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)

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnAppMonitor := awscdk.Aws_rum.NewCfnAppMonitor(this, jsii.String("MyCfnAppMonitor"), &CfnAppMonitorProps{
	Domain: jsii.String("domain"),
	Name: jsii.String("name"),

	// the properties below are optional
	AppMonitorConfiguration: &AppMonitorConfigurationProperty{
		AllowCookies: jsii.Boolean(false),
		EnableXRay: jsii.Boolean(false),
		ExcludedPages: []*string{
			jsii.String("excludedPages"),
		},
		FavoritePages: []*string{
			jsii.String("favoritePages"),
		},
		GuestRoleArn: jsii.String("guestRoleArn"),
		IdentityPoolId: jsii.String("identityPoolId"),
		IncludedPages: []*string{
			jsii.String("includedPages"),
		},
		MetricDestinations: []interface{}{
			&MetricDestinationProperty{
				Destination: jsii.String("destination"),

				// the properties below are optional
				DestinationArn: jsii.String("destinationArn"),
				IamRoleArn: jsii.String("iamRoleArn"),
				MetricDefinitions: []interface{}{
					&MetricDefinitionProperty{
						Name: jsii.String("name"),

						// the properties below are optional
						DimensionKeys: map[string]*string{
							"dimensionKeysKey": jsii.String("dimensionKeys"),
						},
						EventPattern: jsii.String("eventPattern"),
						Namespace: jsii.String("namespace"),
						UnitLabel: jsii.String("unitLabel"),
						ValueKey: jsii.String("valueKey"),
					},
				},
			},
		},
		SessionSampleRate: jsii.Number(123),
		Telemetries: []*string{
			jsii.String("telemetries"),
		},
	},
	CustomEvents: &CustomEventsProperty{
		Status: jsii.String("status"),
	},
	CwLogEnabled: jsii.Boolean(false),
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
})

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html

func NewCfnAppMonitor 

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

type CfnAppMonitorProps 

type CfnAppMonitorProps struct {
	// The top-level internet domain name for which your application has administrative authority.
	//
	// This parameter is required.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-domain
	//
	Domain *string `field:"required" json:"domain" yaml:"domain"`
	// A name for the app monitor.
	//
	// This parameter is required.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-name
	//
	Name *string `field:"required" json:"name" yaml:"name"`
	// 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/AmazonCloudWatch/latest/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.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-appmonitorconfiguration
	//
	AppMonitorConfiguration interface{} `field:"optional" json:"appMonitorConfiguration" yaml:"appMonitorConfiguration"`
	// 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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-customevents
	//
	CustomEvents interface{} `field:"optional" json:"customEvents" yaml:"customEvents"`
	// 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` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-cwlogenabled
	//
	CwLogEnabled interface{} `field:"optional" json:"cwLogEnabled" yaml:"cwLogEnabled"`
	// 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) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-tags
	//
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnAppMonitor`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnAppMonitorProps := &CfnAppMonitorProps{
	Domain: jsii.String("domain"),
	Name: jsii.String("name"),

	// the properties below are optional
	AppMonitorConfiguration: &AppMonitorConfigurationProperty{
		AllowCookies: jsii.Boolean(false),
		EnableXRay: jsii.Boolean(false),
		ExcludedPages: []*string{
			jsii.String("excludedPages"),
		},
		FavoritePages: []*string{
			jsii.String("favoritePages"),
		},
		GuestRoleArn: jsii.String("guestRoleArn"),
		IdentityPoolId: jsii.String("identityPoolId"),
		IncludedPages: []*string{
			jsii.String("includedPages"),
		},
		MetricDestinations: []interface{}{
			&MetricDestinationProperty{
				Destination: jsii.String("destination"),

				// the properties below are optional
				DestinationArn: jsii.String("destinationArn"),
				IamRoleArn: jsii.String("iamRoleArn"),
				MetricDefinitions: []interface{}{
					&MetricDefinitionProperty{
						Name: jsii.String("name"),

						// the properties below are optional
						DimensionKeys: map[string]*string{
							"dimensionKeysKey": jsii.String("dimensionKeys"),
						},
						EventPattern: jsii.String("eventPattern"),
						Namespace: jsii.String("namespace"),
						UnitLabel: jsii.String("unitLabel"),
						ValueKey: jsii.String("valueKey"),
					},
				},
			},
		},
		SessionSampleRate: jsii.Number(123),
		Telemetries: []*string{
			jsii.String("telemetries"),
		},
	},
	CustomEvents: &CustomEventsProperty{
		Status: jsii.String("status"),
	},
	CwLogEnabled: jsii.Boolean(false),
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html

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.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-allowcookies
	//
	AllowCookies interface{} `field:"optional" 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)
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-enablexray
	//
	EnableXRay interface{} `field:"optional" 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.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-excludedpages
	//
	ExcludedPages *[]*string `field:"optional" 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.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-favoritepages
	//
	FavoritePages *[]*string `field:"optional" 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.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-guestrolearn
	//
	GuestRoleArn *string `field:"optional" json:"guestRoleArn" yaml:"guestRoleArn"`
	// The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-identitypoolid
	//
	IdentityPoolId *string `field:"optional" 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.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-includedpages
	//
	IncludedPages *[]*string `field:"optional" json:"includedPages" yaml:"includedPages"`
	// An array of structures that each define a destination that this app monitor will send extended metrics to.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-metricdestinations
	//
	MetricDestinations interface{} `field:"optional" json:"metricDestinations" yaml:"metricDestinations"`
	// 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.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-sessionsamplerate
	//
	SessionSampleRate *float64 `field:"optional" 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.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-telemetries
	//
	Telemetries *[]*string `field:"optional" json:"telemetries" yaml:"telemetries"`
}

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

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

appMonitorConfigurationProperty := &AppMonitorConfigurationProperty{
	AllowCookies: jsii.Boolean(false),
	EnableXRay: jsii.Boolean(false),
	ExcludedPages: []*string{
		jsii.String("excludedPages"),
	},
	FavoritePages: []*string{
		jsii.String("favoritePages"),
	},
	GuestRoleArn: jsii.String("guestRoleArn"),
	IdentityPoolId: jsii.String("identityPoolId"),
	IncludedPages: []*string{
		jsii.String("includedPages"),
	},
	MetricDestinations: []interface{}{
		&MetricDestinationProperty{
			Destination: jsii.String("destination"),

			// the properties below are optional
			DestinationArn: jsii.String("destinationArn"),
			IamRoleArn: jsii.String("iamRoleArn"),
			MetricDefinitions: []interface{}{
				&MetricDefinitionProperty{
					Name: jsii.String("name"),

					// the properties below are optional
					DimensionKeys: map[string]*string{
						"dimensionKeysKey": jsii.String("dimensionKeys"),
					},
					EventPattern: jsii.String("eventPattern"),
					Namespace: jsii.String("namespace"),
					UnitLabel: jsii.String("unitLabel"),
					ValueKey: jsii.String("valueKey"),
				},
			},
		},
	},
	SessionSampleRate: jsii.Number(123),
	Telemetries: []*string{
		jsii.String("telemetries"),
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html

type CfnAppMonitor_CustomEventsProperty added in v2.63.0 

type CfnAppMonitor_CustomEventsProperty struct {
	// Set this to `ENABLED` to allow the web client to send custom events for this app monitor.
	//
	// Valid values are `ENABLED` and `DISABLED` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-customevents.html#cfn-rum-appmonitor-customevents-status
	//
	Status *string `field:"optional" json:"status" yaml:"status"`
}

This structure specifies whether this app monitor allows the web client to define and send custom events.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

customEventsProperty := &CustomEventsProperty{
	Status: jsii.String("status"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-customevents.html

type CfnAppMonitor_MetricDefinitionProperty added in v2.51.0 

type CfnAppMonitor_MetricDefinitionProperty struct {
	// The name of the metric that is defined in this structure.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html#cfn-rum-appmonitor-metricdefinition-name
	//
	Name *string `field:"required" json:"name" yaml:"name"`
	// This field is a map of field paths to dimension names.
	//
	// It defines the dimensions to associate with this metric in CloudWatch . The value of this field is used only if the metric destination is `CloudWatch` . If the metric destination is `Evidently` , the value of `DimensionKeys` is ignored.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html#cfn-rum-appmonitor-metricdefinition-dimensionkeys
	//
	DimensionKeys interface{} `field:"optional" json:"dimensionKeys" yaml:"dimensionKeys"`
	// The pattern that defines the metric.
	//
	// RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.
	//
	// If the metrics destination is `CloudWatch` and the event also matches a value in `DimensionKeys` , then the metric is published with the specified dimensions.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html#cfn-rum-appmonitor-metricdefinition-eventpattern
	//
	EventPattern *string `field:"optional" json:"eventPattern" yaml:"eventPattern"`
	// If you are creating a custom metric instead of an extended metrics, use this parameter to define the metric namespace for that custom metric.
	//
	// Do not specify this parameter if you are creating an extended metric.
	//
	// You can't use any string that starts with `AWS/` for your namespace.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html#cfn-rum-appmonitor-metricdefinition-namespace
	//
	Namespace *string `field:"optional" json:"namespace" yaml:"namespace"`
	// Use this field only if you are sending this metric to CloudWatch .
	//
	// It defines the CloudWatch metric unit that this metric is measured in.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html#cfn-rum-appmonitor-metricdefinition-unitlabel
	//
	UnitLabel *string `field:"optional" json:"unitLabel" yaml:"unitLabel"`
	// The field within the event object that the metric value is sourced from.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html#cfn-rum-appmonitor-metricdefinition-valuekey
	//
	ValueKey *string `field:"optional" json:"valueKey" yaml:"valueKey"`
}

Specifies one custom metric or extended metric that you want the CloudWatch RUM app monitor to send to a destination.

Valid destinations include CloudWatch and Evidently.

By default, RUM app monitors send some metrics to CloudWatch . These default metrics are listed in [CloudWatch metrics that you can collect.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-metrics.html)

In addition to these default metrics, you can choose to send extended metrics or custom metrics or both.

- Extended metrics enable you to send metrics with additional dimensions not included in the default metrics. You can also send extended metrics to Evidently as well as CloudWatch . The valid dimension names for the additional dimensions for extended metrics are `BrowserName` , `CountryCode` , `DeviceType` , `FileType` , `OSName` , and `PageId` . For more information, see [Extended metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html) . - Custom metrics are metrics that you define. You can send custom metrics to CloudWatch or to CloudWatch Evidently or to both. With custom metrics, you can use any metric name and namespace, and to derive the metrics you can use any custom events, built-in events, custom attributes, or default attributes.

You can't send custom metrics to the `AWS/RUM` namespace. You must send custom metrics to a custom namespace that you define. The namespace that you use can't start with `AWS/` . CloudWatch RUM prepends `RUM/CustomMetrics/` to the custom namespace that you define, so the final namespace for your metrics in CloudWatch is `RUM/CustomMetrics/ *your-custom-namespace*` .

For information about syntax rules for specifying custom metrics and extended metrics, see [MetridDefinitionRequest](https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_MetricDefinitionRequest.html) in the *CloudWatch RUM API Reference* .

The maximum number of metric definitions that one destination can contain is 2000.

Extended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric.

If some metric definitions that you specify are not valid, then the operation will not modify any metric definitions even if other metric definitions specified are valid.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

metricDefinitionProperty := &MetricDefinitionProperty{
	Name: jsii.String("name"),

	// the properties below are optional
	DimensionKeys: map[string]*string{
		"dimensionKeysKey": jsii.String("dimensionKeys"),
	},
	EventPattern: jsii.String("eventPattern"),
	Namespace: jsii.String("namespace"),
	UnitLabel: jsii.String("unitLabel"),
	ValueKey: jsii.String("valueKey"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html

type CfnAppMonitor_MetricDestinationProperty added in v2.51.0 

type CfnAppMonitor_MetricDestinationProperty struct {
	// Defines the destination to send the metrics to.
	//
	// Valid values are `CloudWatch` and `Evidently` . If you specify `Evidently` , you must also specify the ARN of the CloudWatch Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html#cfn-rum-appmonitor-metricdestination-destination
	//
	Destination *string `field:"required" json:"destination" yaml:"destination"`
	// Use this parameter only if `Destination` is `Evidently` .
	//
	// This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html#cfn-rum-appmonitor-metricdestination-destinationarn
	//
	DestinationArn *string `field:"optional" json:"destinationArn" yaml:"destinationArn"`
	// This parameter is required if `Destination` is `Evidently` . If `Destination` is `CloudWatch` , do not use this parameter.
	//
	// This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html#cfn-rum-appmonitor-metricdestination-iamrolearn
	//
	IamRoleArn *string `field:"optional" json:"iamRoleArn" yaml:"iamRoleArn"`
	// An array of structures which define the metrics that you want to send.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html#cfn-rum-appmonitor-metricdestination-metricdefinitions
	//
	MetricDefinitions interface{} `field:"optional" json:"metricDefinitions" yaml:"metricDefinitions"`
}

Creates or updates a destination to receive extended metrics from CloudWatch RUM.

You can send extended metrics to CloudWatch or to a CloudWatch Evidently experiment.

For more information about extended metrics, see [Extended metrics that you can send to CloudWatch and CloudWatch Evidently](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html) .

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

metricDestinationProperty := &MetricDestinationProperty{
	Destination: jsii.String("destination"),

	// the properties below are optional
	DestinationArn: jsii.String("destinationArn"),
	IamRoleArn: jsii.String("iamRoleArn"),
	MetricDefinitions: []interface{}{
		&MetricDefinitionProperty{
			Name: jsii.String("name"),

			// the properties below are optional
			DimensionKeys: map[string]*string{
				"dimensionKeysKey": jsii.String("dimensionKeys"),
			},
			EventPattern: jsii.String("eventPattern"),
			Namespace: jsii.String("namespace"),
			UnitLabel: jsii.String("unitLabel"),
			ValueKey: jsii.String("valueKey"),
		},
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.