All Products
Search

This Product

    Resource Orchestration Service:ALIYUN::ARMS::RetcodeApp

    Document Center

    Resource Orchestration Service:ALIYUN::ARMS::RetcodeApp

    Last Updated:Jul 29, 2024

    ALIYUN::ARMS::RetcodeApp is used to create a browser monitoring task.

    Syntax

    {
  "Type": "ALIYUN::ARMS::RetcodeApp",
  "Properties": {
    "RetcodeAppType": String,
    "RegionId": String,
    "RetcodeAppName": String
  }
}

    Properties

    Property

    Type

    Required

    Editable

    Description

    Constraint

    RegionId

    String

    Yes

    No

    The region ID.

    Valid values:

    • cn-hangzhou

    • ap-southeast-1

    RetcodeAppName

    String

    Yes

    No

    The name of the application for which you want to create the browser monitoring task.

    None.

    RetcodeAppType

    String

    Yes

    No

    The type of the application for which you want to create the browser monitoring task.

    Valid values:

    • web

    • weex

    • mini_dd

    • mini_alipay

    • mini_wx

    • mini_common

    Return values

    Fn::GetAtt

    • Pid: the process ID (PID).

    • AppId: the application ID.

    Examples

    YAML format

    ROSTemplateFormatVersion: '2015-09-01'
Resources:
  RetcodeApp:
    Type: 'ALIYUN::ARMS::RetcodeApp'
    Properties:
      RetcodeAppType:
        Ref: RetcodeAppType
      RegionId:
        Ref: RegionId
      RetcodeAppName:
        Ref: RetcodeAppName
Parameters:
  RetcodeAppType:
    Type: String
    Description: >-
      The type of the application for which you want to create the browser
      monitoring job. Allowed values: web, weex, mini_dd, mini_alipay, mini_wx,
      mini_common.
  RegionId:
    Default: cn-hangzhou
    Type: String
    Description: >-
      Region ID. Allowed values: cn-hangzhou, ap-southeast-1. Default to
      cn-hangzhou.
    AllowedValues:
      - cn-hangzhou
      - ap-southeast-1
  RetcodeAppName:
    Type: String
    Description: >-
      The name of the application for which you want to create the browser
      monitoring job.
Outputs:
  Pid:
    Description: The PID.
    Value:
      'Fn::GetAtt':
        - RetcodeApp
        - Pid
  AppId:
    Description: >-
      The ID of the application for which you created the browser monitoring
      job.
    Value:
      'Fn::GetAtt':
        - RetcodeApp
        - AppId

    JSON format

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "RetcodeApp": {
      "Type": "ALIYUN::ARMS::RetcodeApp",
      "Properties": {
        "RetcodeAppType": {
          "Ref": "RetcodeAppType"
        },
        "RegionId": {
          "Ref": "RegionId"
        },
        "RetcodeAppName": {
          "Ref": "RetcodeAppName"
        }
      }
    }
  },
  "Parameters": {
    "RetcodeAppType": {
      "Type": "String",
      "Description": "The type of the application for which you want to create the browser monitoring job. Allowed values: web, weex, mini_dd, mini_alipay, mini_wx, mini_common."
    },
    "RegionId": {
      "Default": "cn-hangzhou",
      "Type": "String",
      "Description": "Region ID. Allowed values: cn-hangzhou, ap-southeast-1. Default to cn-hangzhou.",
      "AllowedValues": [
        "cn-hangzhou",
        "ap-southeast-1"
      ]
    },
    "RetcodeAppName": {
      "Type": "String",
      "Description": "The name of the application for which you want to create the browser monitoring job."
    }
  },
  "Outputs": {
    "Pid": {
      "Description": "The PID.",
      "Value": {
        "Fn::GetAtt": [
          "RetcodeApp",
          "Pid"
        ]
      }
    },
    "AppId": {
      "Description": "The ID of the application for which you created the browser monitoring job.",
      "Value": {
        "Fn::GetAtt": [
          "RetcodeApp",
          "AppId"
        ]
      }
    }
  }
}