ALIYUN::ARMS::Prometheus リソースタイプリファレンス - ROS

ALIYUN::ARMS::Prometheus は、Prometheus インスタンスを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ARMS::Prometheus",
  "Properties": {
    "VpcId": String,
    "ResourceGroupId": String,
    "ClusterId": String,
    "SecurityGroupId": String,
    "VSwitchId": String,
    "ClusterType": String,
    "Tags": List,
    "SubClustersJson": List,
    "GrafanaInstanceId": String,
    "PrometheusName": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ClusterType	String	はい	いいえ	Prometheus インスタンスのタイプ。	有効な値: ManagedKubernetes: serverless Kubernetes (ASK) クラスタ用の Prometheus インスタンス ecs: Elastic Compute Service (ECS) 用の Prometheus インスタンス vpc-prometheus: Virtual Private Cloud (VPC) 用の Prometheus インスタンス cloud-product-prometheus: クラウドサービス用のリージョンレベルの Prometheus インスタンス remote-write-prometheus: 汎用 Prometheus インスタンス GlobalViewV2: GlobalView V2 用の Prometheus インスタンス global-view: GlobalView 用の Prometheus インスタンス
GrafanaInstanceId	String	はい	はい	Prometheus インスタンスを関連付ける Grafana ワークスペースの ID。	Grafana の共有エディションを使用する場合は、値を free に設定する必要があります。
PrometheusName	String	はい	いいえ	Prometheus インスタンスの名前。	ClusterType が remote-write-prometheus、ecs、または global-view に設定されている場合は、このプロパティを指定する必要があります。 ECS 用の Prometheus インスタンスを作成する場合、PrometheusName の値は「name-vpc-id」形式である必要があり、「name」フィールドの値は最大 24 文字の長さにすることができます。たとえば、PrometheusName を「mytest1-vpc-xxxxxxxxxxx」に設定できます。
ClusterId	String	いいえ	いいえ	ASK クラスタの ID。	ClusterType が ManagedKubernetes に設定されている場合は、このプロパティを指定する必要があります。
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし。
SecurityGroupId	String	いいえ	いいえ	VPC が属するセキュリティグループ。	ClusterType が ecs または ManagedKubernetes に設定されている場合は、このプロパティを指定する必要があります。
SubClustersJson	List	いいえ	はい	GlobalView 用の Prometheus インスタンスのサブインスタンス。値は JSON 文字列です。	ClusterType が global-view に設定されている場合は、このプロパティを指定する必要があります。集約されるインスタンスに関する情報。 [ { "headers":{ }, "regionId":"cn-hangzhou", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c39a1048921e04f*********", "sourceName":"arms-luyao-test", "dataSource":"", "userId":"1672753*******" }, { "headers":{ }, "regionId":"cn-beijing", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c6b6485496d5b40*******", "sourceName":"agent-321-Test", "dataSource":"", "userId":"1672753*******" }, { "headers":{ }, "regionId":"cn-zhangjiakou", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c261a4f3200c446*******", "sourceName":"zaifeng-cardinality-01", "dataSource":"", "userId":"1672753*********" } ]
Tags	List	いいえ	はい	カスタムタグ。	最大 20 個のタグを追加できます。詳細については、「タグのプロパティ」をご参照ください。
VpcId	String	いいえ	いいえ	VPC。	ClusterType が ecs または ManagedKubernetes に設定されている場合は、このプロパティを指定する必要があります。
VSwitchId	String	いいえ	いいえ	VPC 内の vSwitch。	ClusterType が ecs または ManagedKubernetes に設定されている場合は、このプロパティを指定する必要があります。

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	タグキー。	タグキーは 1 ～ 128 文字の長さで、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。
Value	String	いいえ	いいえ	タグ値。	タグ値は最大 128 文字の長さで、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。

戻り値

Fn::GetAtt

VpcId: Prometheus インスタンスの VPC ID。
ResourceGroupId: Prometheus インスタンスが属するリソースグループの ID。
ClusterId: Prometheus インスタンスの ID。
UserId: ユーザー ID。
SecurityGroupId: セキュリティグループの ID。
VSwitchId: Prometheus インスタンスが接続されている vSwitch の ID。
PaymentType: Prometheus インスタンスの課金方法。
ClusterType: Prometheus インスタンスのタイプ。
Tags: Prometheus インスタンスに追加されたタグ。
SubClustersJson: GlobalView 用の Prometheus インスタンスのサブインスタンス。値は JSON 文字列です。
GrafanaInstanceId: Prometheus インスタンスが関連付けられている Grafana ワークスペースの ID。
PrometheusName: Prometheus インスタンスの名前。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ClusterType:
    Type: String
    Description:
      ja: インスタンスタイプ。
    AllowedValues:
      - vpc-prometheus
      - ManagedKubernetes
      - cloud-product-prometheus
      - remote-write-prometheus
      - GlobalViewV2
      - ecs
      - global-view
    Required: true
  GrafanaInstanceId:
    Type: String
    Description:
      ja: Grafana ワークスペース ID。
    Required: true
  PrometheusName:
    Type: String
    Description:
      ja: リソースの名前。
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ARMS::Prometheus
    Properties:
      ClusterType:
        Ref: ClusterType
      GrafanaInstanceId:
        Ref: GrafanaInstanceId
      PrometheusName:
        Ref: PrometheusName
Outputs:
  VpcId:
    Description: '仮想プライベートクラウド (VPC) の ID。'
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - VpcId
  ResourceGroupId:
    Description: リソースグループの ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceGroupId
  ClusterId:
    Description: クラスタの ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ClusterId
  UserId:
    Description: ユーザー ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - UserId
  SecurityGroupId:
    Description: 'セキュリティグループの ID。'
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SecurityGroupId
  VSwitchId:
    Description: 'vSwitch の ID。'
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - VSwitchId
  PaymentType:
    Description: 支払いタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PaymentType
  ClusterType:
    Description: インスタンスタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ClusterType
  Tags:
    Description: Prometheus のタグ。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Tags
  SubClustersJson:
    Description: GlobalView クラスタのサブクラスタ情報。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SubClustersJson
  GrafanaInstanceId:
    Description: Grafana ワークスペース ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - GrafanaInstanceId
  PrometheusName:
    Description: リソースの名前。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PrometheusName

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ClusterType": {
      "Type": "String",
      "Description": {
        "ja": "インスタンスタイプ。"
      },
      "AllowedValues": [
        "vpc-prometheus",
        "ManagedKubernetes",
        "cloud-product-prometheus",
        "remote-write-prometheus",
        "GlobalViewV2",
        "ecs",
        "global-view"
      ],
      "Required": true
    },
    "GrafanaInstanceId": {
      "Type": "String",
      "Description": {
        "ja": "Grafana ワークスペース ID。"
      },
      "Required": true
    },
    "PrometheusName": {
      "Type": "String",
      "Description": {
        "ja": "リソースの名前。"
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ARMS::Prometheus",
      "Properties": {
        "ClusterType": {
          "Ref": "ClusterType"
        },
        "GrafanaInstanceId": {
          "Ref": "GrafanaInstanceId"
        },
        "PrometheusName": {
          "Ref": "PrometheusName"
        }
      }
    }
  },
  "Outputs": {
    "VpcId": {
      "Description": "仮想プライベートクラウド (VPC) の ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VpcId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "リソースグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceGroupId"
        ]
      }
    },
    "ClusterId": {
      "Description": "クラスタの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ClusterId"
        ]
      }
    },
    "UserId": {
      "Description": "ユーザー ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UserId"
        ]
      }
    },
    "SecurityGroupId": {
      "Description": "セキュリティグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SecurityGroupId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "vSwitch の ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VSwitchId"
        ]
      }
    },
    "PaymentType": {
      "Description": "支払いタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PaymentType"
        ]
      }
    },
    "ClusterType": {
      "Description": "インスタンスタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ClusterType"
        ]
      }
    },
    "Tags": {
      "Description": "Prometheus のタグ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      }
    },
    "SubClustersJson": {
      "Description": "GlobalView クラスタのサブクラスタ情報。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SubClustersJson"
        ]
      }
    },
    "GrafanaInstanceId": {
      "Description": "Grafana ワークスペース ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "GrafanaInstanceId"
        ]
      }
    },
    "PrometheusName": {
      "Description": "リソースの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PrometheusName"
        ]
      }
    }
  }
}