All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::CMS::MonitorGroupInstances

Last Updated:Aug 23, 2023

ALIYUN::CMS::MonitorGroupInstances is used to add instances to an application group.

Syntax

{
  "Type": "ALIYUN::CMS::MonitorGroupInstances",
  "Properties": {
    "Instances": List,
    "GroupId": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

Instances

List

Yes

No

The list of one or more instances.

For more information, see the Instances properties section.

GroupId

String

Yes

No

The ID of the application group.

None

Instances syntax

"Instances": [
  {
    "InstanceName": String,
    "Category": String,
    "InstanceId": String,
    "RegionId": String
  }
]

Instances properties

Property

Type

Required

Editable

Description

Constraint

InstanceName

String

Yes

No

The name of the instance.

None

Category

String

Yes

No

The name and specifications of the service to which the instance in the application group belongs.

Valid values:

  • ecs: Elastic Compute Service (ECS)

  • rds: ApsaraDB RDS

  • ads: AnalyticDB for MySQL

  • slb: Server Load Balancer (SLB)

  • vpc: Virtual Private Cloud (VPC)

  • apigateway: API Gateway

  • cdn: Alibaba Cloud CDN (CDN)

  • cs: Container Service for Kubernetes (ACK)

  • dcdn: Dynamic Route for CDN (DCDN)

  • ddos: Anti-DDoS Pro and Anti-DDoS Premium

  • eip: Elastic IP Address (EIP)

  • elasticsearch: Elasticsearch

  • emr: E-MapReduce (EMR)

  • ess: Auto Scaling (ESS)

  • hbase: ApsaraDB for HBase

  • iot_edge: IoT Edge

  • k8s_pod: pods in ACK

  • kvstore_sharding: ApsaraDB for Redis that uses the cluster master-replica architecture

  • kvstore_splitrw: ApsaraDB for Redis that uses the read/write splitting architecture

  • kvstore_standard: ApsaraDB for Redis that uses the standard master-replica architecture

  • memcache: ApsaraDB for Memcache

  • mns: Message Service (MNS)

  • mongodb: ApsaraDB for MongoDB that uses the replica set architecture

  • mongodb_cluster: ApsaraDB for MongoDB that uses the standalone architecture

  • mongodb_sharding: ApsaraDB for MongoDB that uses the sharded cluster architecture

  • mq_topic: MNS topics

  • ocs: ApsaraDB for Memcache (OCS)

  • opensearch: Open Search

  • oss: Object Storage Service (OSS)

  • polardb: PolarDB

  • petadata: HybridDB for MySQL

  • scdn: Secure CDN (SCDN)

  • sharebandwidthpackages: Internet Shared Bandwidth

  • sls: Log Service

  • vpn: VPN Gateway

InstanceId

String

Yes

No

The ID of the instance.

None

RegionId

String

Yes

No

The region ID of the instance.

None

Response parameters

Fn::GetAtt

GroupId: the ID of the application group.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      InstanceId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::InstanceId
      GroupId:
        Type: String
        Description: The ID of the application group.
    Resources:
      MonitorGroupInstances:
        Type: ALIYUN::CMS::MonitorGroupInstances
        Properties:
          Instances:
            - InstanceName: TestECS
              Category: ecs
              InstanceId:
                Ref: InstanceId
              RegionId:
                Ref: ALIYUN::Region
          GroupId:
            Ref: GroupId
    Outputs:
      GroupId:
        Description: The ID of the application group.
        Value:
          Fn::GetAtt:
            - MonitorGroupInstances
            - GroupId
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "InstanceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId"
        },
        "GroupId": {
          "Type": "String",
          "Description": "The ID of the application group."
        }
      },
      "Resources": {
        "MonitorGroupInstances": {
          "Type": "ALIYUN::CMS::MonitorGroupInstances",
          "Properties": {
            "Instances": [
              {
                "InstanceName": "TestECS",
                "Category": "ecs",
                "InstanceId": {
                  "Ref": "InstanceId"
                },
                "RegionId": {
                  "Ref": "ALIYUN::Region"
                }
              }
            ],
            "GroupId": {
              "Ref": "GroupId"
            }
          }
        }
      },
      "Outputs": {
        "GroupId": {
          "Description": "The ID of the application group.",
          "Value": {
            "Fn::GetAtt": [
              "MonitorGroupInstances",
              "GroupId"
            ]
          }
        }
      }
    }