DATASOURCE::ARMS::PrometheusUrl - Resource Orchestration Service

DATASOURCE::ARMS::PrometheusUrl is used to query all URLs of a cluster, including the URLs for remote read, remote write, Pushgateway, and Grafana.

Syntax

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

Properties

Property

Type

Required

Editable

Description

Constraint

ClusterId

String

Yes

The cluster ID.

None.

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): does not refresh data source resources when the stack is updated.
Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

InternetPushGatewayUrl: the public URL for Pushgateway.
InternetGrafanaUrl: the public URL for Grafana.
ClusterId: the cluster ID.
InternetRemoteWriteUrl: the public URL for remote write.
Token: the information about the token.
ClusterType: the cluster type.
RemoteWriteUrl: the internal URL for remote write.
GrafanaUrl: the internal URL for Grafana.
RemoteReadUrl: the internal URL for remote read.
PushGatewayUrl: the internal URL for Pushgateway.
OpenTelemetryUrl: the internal URL for OpenTelemetry.
InternetOpenTelemetryUrl: the public URL for OpenTelemetry.
InternetRemoteReadUrl: the public URL for remote read.

Examples

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ClusterId:
    Description:
      en: Cluster ID.
    Required: false
    Type: String
Resources:
  PrometheusUrl:
    Properties:
      ClusterId:
        Ref: ClusterId
    Type: DATASOURCE::ARMS::PrometheusUrl
Outputs:
  ClusterId:
    Description: Cluster ID.
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - ClusterId
  ClusterType:
    Description: Cluster type.
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - ClusterType
  GrafanaUrl:
    Description: Internal HTTP API URL (Grafana read URL).
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - GrafanaUrl
  InternetGrafanaUrl:
    Description: Internet HTTP API URL (Grafana read URL).
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - InternetGrafanaUrl
  InternetOpenTelemetryUrl:
    Description: Internet OpenTelemetry URL.
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - InternetOpenTelemetryUrl
  InternetPushGatewayUrl:
    Description: Internet push gateway URL.
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - InternetPushGatewayUrl
  InternetRemoteReadUrl:
    Description: Internet remote read URL.
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - InternetRemoteReadUrl
  InternetRemoteWriteUrl:
    Description: Internet remote write URL.
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - InternetRemoteWriteUrl
  OpenTelemetryUrl:
    Description: Internal OpenTelemetry URL.
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - OpenTelemetryUrl
  PushGatewayUrl:
    Description: Internal push gateway URL.
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - PushGatewayUrl
  RemoteReadUrl:
    Description: Internal remote read URL.
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - RemoteReadUrl
  RemoteWriteUrl:
    Description: Internal remote write URL.
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - RemoteWriteUrl
  Token:
    Description: The token for Grafana read URL.
    Value:
      Fn::GetAtt:
      - PrometheusUrl
      - Token

`JSON` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ClusterId": {
      "Type": "String",
      "Description": {
        "en": "Cluster ID."
      },
      "Required": false
    }
  },
  "Resources": {
    "PrometheusUrl": {
      "Type": "DATASOURCE::ARMS::PrometheusUrl",
      "Properties": {
        "ClusterId": {
          "Ref": "ClusterId"
        }
      }
    }
  },
  "Outputs": {
    "InternetPushGatewayUrl": {
      "Description": "Internet push gateway URL.",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "InternetPushGatewayUrl"
        ]
      }
    },
    "InternetGrafanaUrl": {
      "Description": "Internet HTTP API URL (Grafana read URL).",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "InternetGrafanaUrl"
        ]
      }
    },
    "ClusterId": {
      "Description": "Cluster ID.",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "ClusterId"
        ]
      }
    },
    "InternetRemoteWriteUrl": {
      "Description": "Internet remote write URL.",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "InternetRemoteWriteUrl"
        ]
      }
    },
    "Token": {
      "Description": "The token for Grafana read URL.",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "Token"
        ]
      }
    },
    "ClusterType": {
      "Description": "Cluster type.",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "ClusterType"
        ]
      }
    },
    "RemoteWriteUrl": {
      "Description": "Internal remote write URL.",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "RemoteWriteUrl"
        ]
      }
    },
    "GrafanaUrl": {
      "Description": "Internal HTTP API URL (Grafana read URL).",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "GrafanaUrl"
        ]
      }
    },
    "RemoteReadUrl": {
      "Description": "Internal remote read URL.",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "RemoteReadUrl"
        ]
      }
    },
    "PushGatewayUrl": {
      "Description": "Internal push gateway URL.",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "PushGatewayUrl"
        ]
      }
    },
    "OpenTelemetryUrl": {
      "Description": "Internal OpenTelemetry URL.",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "OpenTelemetryUrl"
        ]
      }
    },
    "InternetOpenTelemetryUrl": {
      "Description": "Internet OpenTelemetry URL.",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "InternetOpenTelemetryUrl"
        ]
      }
    },
    "InternetRemoteReadUrl": {
      "Description": "Internet remote read URL.",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusUrl",
          "InternetRemoteReadUrl"
        ]
      }
    }
  }
}