Provision a RUM Application via ALIYUN::ARMS::RUM Resource - ROS

The ALIYUN::ARMS::RUM resource type creates a Real User Monitoring (RUM) application.

Syntax

{
  "Type": "ALIYUN::ARMS::Rum",
  "Properties": {
    "AppName": String,
    "SiteType": String,
    "AppGroup": String,
    "Description": String,
    "Language": String,
    "NickName": String,
    "PackageName": String,
    "ResourceGroupId": String,
    "RealRegionId": String,
    "Source": String,
    "Tags": List
  }
}

Properties

Property name	Type	Required	Updatable	Description	Constraints
AppName	String	Yes	No	The application name.	None
SiteType	String	Yes	No	The application type.	Valid values: web: Web and H5 applications. miniapp: Mini Program. iOS. android: The Android operating system.
AppGroup	String	No	No	The application group.	None
Description	String	No	Yes	The application description.	None
Language	String	No	No	The client language.	None
NickName	String	No	Yes	The application nickname.	None
PackageName	String	No	No	The package name of the Android application.	This property is required when you create an Android application.
ResourceGroupId	String	No	Yes	The resource group ID.	None
RealRegionId	String	No	No	The region where the application is accessed.	This property is used only in the Alibaba Finance Cloud scenario in Shanghai.
Source	String	No	No	The source of the RUM application.	None
Tags	List	No	No	The list of tags.	For more information, see Tags properties.

Tags syntax

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags properties

Property name	Type	Required	Allow Updates	Description	Constraints
Key	String	Yes	No	The tag key.	None
Value	String	No	No	The tag value.	None

Return values

Fn::GetAtt

Endpoint: The endpoint for reporting application data.
CdnDomain: The accelerated domain name of the RUM application.
Pid: The application ID.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SiteType:
    Type: String
    Description:
      en: The type of the website.
    Required: true
  AppName:
    Type: String
    Description:
      en: |-
        The name of the RUM application.
        The value can be up to 64 characters in length.
    Required: true
Resources:
  Rum:
    Type: ALIYUN::ARMS::Rum
    Properties:
      SiteType:
        Ref: SiteType
      AppName:
        Ref: AppName
Outputs:
  Endpoint:
    Description: The endpoint of the RUM application.
    Value:
      Fn::GetAtt:
        - Rum
        - Endpoint
  CdnDomain:
    Description: The CDN domain of the RUM application.
    Value:
      Fn::GetAtt:
        - Rum
        - CdnDomain
  Pid:
    Description: The PID of the RUM application.
    Value:
      Fn::GetAtt:
        - Rum
        - Pid

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SiteType": {
      "Type": "String",
      "Description": {
        "en": "The type of the website."
      },
      "Required": true
    },
    "AppName": {
      "Type": "String",
      "Description": {
        "en": "The name of the RUM application.\nThe value can be up to 64 characters in length."
      },
      "Required": true
    }
  },
  "Resources": {
    "Rum": {
      "Type": "ALIYUN::ARMS::Rum",
      "Properties": {
        "SiteType": {
          "Ref": "SiteType"
        },
        "AppName": {
          "Ref": "AppName"
        }
      }
    }
  },
  "Outputs": {
    "Endpoint": {
      "Description": "The endpoint of the RUM application.",
      "Value": {
        "Fn::GetAtt": [
          "Rum",
          "Endpoint"
        ]
      }
    },
    "CdnDomain": {
      "Description": "The CDN domain of the RUM application.",
      "Value": {
        "Fn::GetAtt": [
          "Rum",
          "CdnDomain"
        ]
      }
    },
    "Pid": {
      "Description": "The PID of the RUM application.",
      "Value": {
        "Fn::GetAtt": [
          "Rum",
          "Pid"
        ]
      }
    }
  }
}