DATASOURCE::ARMS::Prometheus インスタンスプロパティリファレンス - ROS

DATASOURCE::ARMS::Prometheus は、Prometheus インスタンスに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::ARMS::Prometheus",
  "Properties": {
    "ClusterId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

ClusterId

String

はい

Prometheus インスタンスの ID。

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時のデータソースリソースのリフレッシュポリシー。

有効な値：

Never (デフォルト): スタックの更新時にデータソースリソースをリフレッシュしません。
Always: スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

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

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ClusterId:
    Type: String
    Description:
      en: The ID of the Prometheus instance.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ARMS::Prometheus
    Properties:
      ClusterId:
        Ref: ClusterId
Outputs:
  VpcId:
    Description: The VPC ID. This parameter is returned only for Prometheus instances for ECS.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VpcId
  ResourceGroupId:
    Description: The ID of the resource group to which the instance belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  ClusterId:
    Description: The ID of the Prometheus instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ClusterId
  UserId:
    Description: The user ID.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UserId
  SecurityGroupId:
    Description: The ID of the security group. This parameter is returned only for Prometheus instances for ECS.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SecurityGroupId
  VSwitchId:
    Description: The vSwitch ID. This parameter is returned only for Prometheus instances for ECS.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VSwitchId
  PaymentType:
    Description: The billing method.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  ClusterType:
    Description: The type of the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ClusterType
  Tags:
    Description: The tags of the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  SubClustersJson:
    Description: The child instances of the Prometheus instance for GlobalView.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SubClustersJson
  GrafanaInstanceId:
    Description: The ID of the Grafana workspace.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GrafanaInstanceId
  PrometheusName:
    Description: The name of the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PrometheusName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ClusterId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the Prometheus instance."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ARMS::Prometheus",
      "Properties": {
        "ClusterId": {
          "Ref": "ClusterId"
        }
      }
    }
  },
  "Outputs": {
    "VpcId": {
      "Description": "ECS 向け Prometheus インスタンスの場合のみ返されます。VPC ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "インスタンスが属するリソースグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "ClusterId": {
      "Description": "Prometheus インスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ClusterId"
        ]
      }
    },
    "UserId": {
      "Description": "ユーザー ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UserId"
        ]
      }
    },
    "SecurityGroupId": {
      "Description": "ECS 向け Prometheus インスタンスの場合のみ返されます。セキュリティグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityGroupId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "ECS 向け Prometheus インスタンスの場合のみ返されます。vSwitch ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "PaymentType": {
      "Description": "課金方法。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "ClusterType": {
      "Description": "インスタンスのタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ClusterType"
        ]
      }
    },
    "Tags": {
      "Description": "インスタンスのタグ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "SubClustersJson": {
      "Description": "GlobalView の Prometheus インスタンスのサブインスタンス。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SubClustersJson"
        ]
      }
    },
    "GrafanaInstanceId": {
      "Description": "Grafana ワークスペースの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GrafanaInstanceId"
        ]
      }
    },
    "PrometheusName": {
      "Description": "インスタンスの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PrometheusName"
        ]
      }
    }
  }
}