CloudWatch RUM

1 resource kind. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

RUMAppMonitor # CLOUD CONTROL · AWS::RUM::AppMonitor

RUMAppMonitor manages AWS::RUM::AppMonitor through the AWS Cloud Control API.

kubectl get rumappmonitors · example on GitHub

Example

# RUMAppMonitor — CloudWatch RUM
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/rum.html#rumappmonitor
apiVersion: aws.konfig.io/v1alpha1
kind: RUMAppMonitor
metadata:
  name: example-rumappmonitor
  namespace: default
spec:
  appMonitorConfiguration:
    allowCookies: false
    enableXRay: true
    excludedPages:
    - example
    favoritePages:
    - example
    guestRoleArn: arn:aws:iam::123456789012:role/example-role
    includedPages:
    - example
    metricDestinations:
    - destination: CloudWatch
      destinationArn: arn:aws:iam::123456789012:role/example-role
      iamRoleArn: arn:aws:iam::123456789012:role/example-role
      metricDefinitions:
      - eventPattern: example
        name: example-rumappmonitor
        namespace: example
        unitLabel: example
        valueKey: example
    sessionSampleRate: 1
    telemetries:
    - example
  customEvents:
    status: ENABLED
  cwLogEnabled: true
  deobfuscationConfiguration:
    javaScriptSourceMaps:
      s3Uri: example
      status: ENABLED
  domain: example
  domainList:
  - example
  name: example-rumappmonitor
  platform: Web
  providerRef:
    name: example-rumappmonitor
    region: us-east-1
  resourcePolicy:
    policyDocument: '{"Version": "2012-10-17", "Statement": [{"Effect": "Allow", "Action": ["s3:GetObject"],
      "Resource": "*"}]}'
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`appMonitorConfiguration`	object	—	RUMAppMonitorAppMonitorConfiguration is a nested property type of AWS::RUM::AppMonitor.
`appMonitorConfiguration.allowCookies`	boolean	—	If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie.
`appMonitorConfiguration.enableXRay`	boolean	—	If you set this to true, RUM enables xray tracing for the user sessions that RUM samples.
`appMonitorConfiguration.excludedPages`	array<string>	—	A list of URLs in your website or application to exclude from RUM data collection.
`appMonitorConfiguration.favoritePages`	array<string>	—	A list of pages in the RUM console that are to be displayed with a favorite icon.
`appMonitorConfiguration.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.
`appMonitorConfiguration.identityPoolId`	string	—	The ID of the identity pool that is used to authorize the sending of data to RUM.
`appMonitorConfiguration.includedPages`	array<string>	—	If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
`appMonitorConfiguration.metricDestinations`	array<object>	—	An array of structures which define the destinations and the metrics that you want to send.
`appMonitorConfiguration.metricDestinations[].destination`	enum	yes	Defines the destination to send the metrics to. Allowed: `CloudWatch, Evidently`
`appMonitorConfiguration.metricDestinations[].destinationArn`	string	—	Evidently has been discontinued and therefore this is no longer an acceptable field.
`appMonitorConfiguration.metricDestinations[].iamRoleArn`	string	—	Evidently has been discontinued and therefore this is no longer an acceptable field.
`appMonitorConfiguration.metricDestinations[].metricDefinitions`	array<object>	—	An array of structures which define the metrics that you want to send.
`appMonitorConfiguration.metricDestinations[].metricDefinitions[].dimensionKeys`	map<string>	—	Use this field only if you are sending the metric to CloudWatch.
`appMonitorConfiguration.metricDestinations[].metricDefinitions[].eventPattern`	string	—	The pattern that defines the metric, specified as a JSON object.
`appMonitorConfiguration.metricDestinations[].metricDefinitions[].name`	string	yes	The name for the metric that is defined in this structure.
`appMonitorConfiguration.metricDestinations[].metricDefinitions[].namespace`	string	—	The namespace used by CloudWatch Metrics for the metric that is defined in this structure
`appMonitorConfiguration.metricDestinations[].metricDefinitions[].unitLabel`	string	—	The CloudWatch metric unit to use for this metric.
`appMonitorConfiguration.metricDestinations[].metricDefinitions[].valueKey`	string	—	The field within the event object that the metric value is sourced from.
`appMonitorConfiguration.sessionSampleRate`	number	—	Specifies the percentage of user sessions to use for RUM data collection.
`appMonitorConfiguration.telemetries`	array<string>	—	An array that lists the types of telemetry data that this app monitor is to collect.
`customEvents`	object	—	RUMAppMonitorCustomEvents is a nested property type of AWS::RUM::AppMonitor.
`customEvents.status`	enum	—	Indicates whether AppMonitor accepts custom events. Allowed: `ENABLED, DISABLED`
`cwLogEnabled`	boolean	—	Data collected by RUM is kept by RUM for 30 days and then deleted.
`deobfuscationConfiguration`	object	—	RUMAppMonitorDeobfuscationConfiguration is a nested property type of AWS::RUM::AppMonitor.
`deobfuscationConfiguration.javaScriptSourceMaps`	object	—	A structure that contains the configuration for how an app monitor can unminify JavaScript error stack traces using source maps.
`deobfuscationConfiguration.javaScriptSourceMaps.s3Uri`	string	—	The S3Uri of the bucket or folder that stores the source map files.
`deobfuscationConfiguration.javaScriptSourceMaps.status`	enum	yes	Specifies whether JavaScript error stack traces should be unminified for this app monitor. Allowed: `ENABLED, DISABLED`
`domain`	string	—	The top-level internet domain name for which your application has administrative authority.
`domainList`	array<string>	—	The top-level internet domain names for which your application has administrative authority.
`name`	string	yes	A name for the app monitor Create-only in AWS: changing it requires replacing the resource.
`platform`	enum	—	Create-only in AWS: changing it requires replacing the resource. Allowed: `Web, Android, iOS`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`resourcePolicy`	object	—	RUMAppMonitorResourcePolicy is a nested property type of AWS::RUM::AppMonitor.
`resourcePolicy.policyDocument`	string	yes	The JSON to use as the resource policy.
`resourcePolicy.policyRevisionId`	string	—	A string value that you can use to conditionally update your policy.
`tags`	array<object>	—
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`id`	string	—	The unique ID of the new app monitor.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.