ALIYUN::ARMS::ManagedPrometheus - Resource Orchestration Service

ALIYUN::ARMS::ManagedPrometheus is used to install a Prometheus agent in a ACK Serverless (ASK) cluster or an Elastic Compute Service (ECS) cluster.

Syntax

{
  "Type": "ALIYUN::ARMS::ManagedPrometheus",
  "Properties": {
    "VpcId": String,
    "SecurityGroupId": String,
    "VSwitchId": String,
    "ClusterName": String,
    "ClusterType": String,
    "GrafanaInstanceId": String,
    "ClusterId": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
VpcId	String	Yes	No	The ID of the virtual private cloud (VPC) to which the cluster belongs.	None.
SecurityGroupId	String	Yes	No	The ID of the security group to which the cluster belongs.	None.
VSwitchId	String	Yes	No	The ID of the vSwitch to which the cluster is connected.	None.
ClusterName	String	No	No	The cluster name.	This property is required if ClusterType is set to `ecs`.
ClusterType	String	Yes	No	The cluster type.	Valid values: ecs: ECS ask: ASK
GrafanaInstanceId	String	No	No	The ID of the Grafana workspace in which the cluster resides.	If you leave this property empty or set this property to `free`, the cluster is associated with the shared version of Grafana.
ClusterId	String	No	No	The ID of the ACK Serverless cluster.	Example: `cc7a37ee31aea4ed1a059eff8034b****`.

Return values

Fn::GetAtt

VpcId: the ID of the VPC to which the cluster belongs.
ClusterType: the cluster type.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    Type: String
    Description: The vpc ID of the cluster.
  SecurityGroupId:
    Type: String
    Description: The security group ID of the cluster.
  VSwitchId:
    Type: String
    Description: The vswith ID of the cluster.
  ClusterType:
    Type: String
    Description: The type of the cluster.
    AllowedValues:
      - ecs
    Default: ecs
Resources:
  ManagedPrometheus:
    Type: ALIYUN::ARMS::ManagedPrometheus
    Properties:
      VpcId:
        Ref: VpcId
      SecurityGroupId:
        Ref: SecurityGroupId
      VSwitchId:
        Ref: VSwitchId
      ClusterType:
        Ref: ClusterType
Outputs:
  VpcId:
    Description: The vpc ID of the cluster.
    Value:
      Fn::GetAtt:
        - ManagedPrometheus
        - VpcId
  ClusterType:
    Description: The type of the cluster.
    Value:
      Fn::GetAtt:
        - ManagedPrometheus
        - ClusterType

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "Description": "The vpc ID of the cluster."
    },
    "SecurityGroupId": {
      "Type": "String",
      "Description": "The security group ID of the cluster."
    },
    "VSwitchId": {
      "Type": "String",
      "Description": "The vswith ID of the cluster."
    },
    "ClusterType": {
      "Type": "String",
      "Description": "The type of the cluster.",
      "AllowedValues": [
        "ecs"
      ],
      "Default": "ecs"
    }
  },
  "Resources": {
    "ManagedPrometheus": {
      "Type": "ALIYUN::ARMS::ManagedPrometheus",
      "Properties": {
        "VpcId": {
          "Ref": "VpcId"
        },
        "SecurityGroupId": {
          "Ref": "SecurityGroupId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "ClusterType": {
          "Ref": "ClusterType"
        }
      }
    }
  },
  "Outputs": {
    "VpcId": {
      "Description": "The vpc ID of the cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ManagedPrometheus",
          "VpcId"
        ]
      }
    },
    "ClusterType": {
      "Description": "The type of the cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ManagedPrometheus",
          "ClusterType"
        ]
      }
    }
  }
}