dynatrace-environment-metric.json

{
  "typeName": "Dynatrace::Environment::Metric",
  "description": "Manage a timeseries metric (V1) in Dynatrace.",
  "sourceUrl": "https://github.com/aws-ia/cloudformation-dynatrace-resource-providers.git",
  "documentationUrl": "https://github.com/aws-ia/cloudformation-dynatrace-resource-providers",
  "definitions": {
    "DynatraceAccess": {
      "type": "object",
      "properties": {
        "Token": {
          "description": "Personal Access Token",
          "type": "string"
        },
        "Endpoint": {
          "description": "Endpoint URL to access Dynatrace API",
          "type": "string"
        }
      },
      "required": [
        "Token",
        "Endpoint"
      ],
      "additionalProperties": false
    },
    "Id": {
      "description": "The ID of the metric.",
      "type": "string",
      "pattern": "^custom\\:([a-zA-Z][a-zA-Z0-9]*([\\.\\_\\-][a-zA-Z])?)+$"
    },
    "DisplayName": {
      "description": "The name of the metric in the user interface. It is limited to 256 characters.",
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "Unit": {
      "description": "The unit of the metric.",
      "type": "string",
      "enum": [
        "Billion (bilcount)",
        "Bit (bit)",
        "BitPerHour (bit/h)",
        "BitPerMinute (bit/min)",
        "BitPerSecond (bit/s)",
        "Byte (B)",
        "BytePerHour (B/h)",
        "BytePerMinute (B/min)",
        "BytePerSecond (B/s)",
        "Cores",
        "Count (count)",
        "Day (ds)",
        "DecibelMilliWatt (dBm)",
        "G",
        "GibiByte (GiB)",
        "GigaByte (GB)",
        "Hour (hs)",
        "KibiByte (KiB)",
        "KibiBytePerHour (KiB/h)",
        "KibiBytePerMinute (KiB/min)",
        "KibiBytePerSecond (KiB/s)",
        "KiloByte (kB)",
        "KiloBytePerHour (kB/h)",
        "KiloBytePerMinute (kB/min)",
        "KiloBytePerSecond (kB/s)",
        "M",
        "MSU",
        "MebiByte (MiB)",
        "MebiBytePerHour (MiB/h)",
        "MebiBytePerMinute (MiB/min)",
        "MebiBytePerSecond (MiB/s)",
        "MegaByte (MB)",
        "MegaBytePerHour (MB/h)",
        "MegaBytePerMinute (MB/min)",
        "MegaBytePerSecond (MB/s)",
        "MicroSecond (µs)",
        "MilliSecond (ms)",
        "MilliSecondPerMinute (ms/min)",
        "Million (milcount)",
        "Minute (mins)",
        "Month (mos)",
        "N/A",
        "NanoSecond (ns)",
        "NanoSecondPerMinute (ns/min)",
        "PerHour (count/h)",
        "PerMinute (count/min)",
        "PerSecond (count/s)",
        "Percent (%)",
        "Pixel (px)",
        "Promille (‰)",
        "Ratio",
        "Second (s)",
        "State",
        "Unspecified",
        "Week (ws)",
        "Year (ys)",
        "k",
        "km/h",
        "m/h",
        "m/s",
        "mCores"
      ]
    },
    "Dimensions": {
      "description": "The metric dimension key that will be used to report multiple dimensions. For example, a dimension key to report the metric for different network cards for the same firewall.\n\nThe CUSTOM_DEVICE dimension is added to each new custom metric automatically.",
      "type": "array",
      "uniqueItems": false,
      "insertionOrder": false,
      "maxItems": 10,
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z0-9\\.\\-\\_]{1,128}$"
      }
    },
    "Types": {
      "description": "The definition of the technology type. It is used to group metrics under a logical technology name in the UI.\n\nMetrics must be assigned a software technology type that is identical to the technology type of the custom device you are sending the metric to.\n\nFor example, if you define your custom device using type F5-Firewall you must also register all related custom metrics as type F5-Firewall.\n\nThe field is required when creating a new metric.",
      "type": "array",
      "uniqueItems": false,
      "insertionOrder": false,
      "minItems": 1,
      "items": {
        "type": "string"
      }
    }
  },
  "typeConfiguration": {
    "properties": {
      "DynatraceAccess": {
        "$ref": "#/definitions/DynatraceAccess"
      }
    },
    "additionalProperties": false,
    "required": [
      "DynatraceAccess"
    ]
  },
  "properties": {
    "DisplayName": {
      "$ref": "#/definitions/DisplayName"
    },
    "Unit": {
      "$ref": "#/definitions/Unit"
    },
    "Dimensions": {
      "$ref": "#/definitions/Dimensions"
    },
    "Types": {
      "$ref": "#/definitions/Types"
    },
    "TimeseriesId": {
      "$ref": "#/definitions/Id"
    },
    "AggregationTypes": {
      "description": "The list of allowed aggregations for this metric.",
      "type": "array",
      "insertionOrder": false,
      "items": {
        "type": "string"
      }
    },
    "Filter": {
      "description": "The feature, where the metric originates.",
      "type": "string"
    },
    "DetailedSource": {
      "description": "The feature, where the metric originates.",
      "type": "string"
    },
    "PluginId": {
      "description": "The ID of the plugin, where the metric originates.",
      "type": "string"
    },
    "Warnings": {
      "description": "The warnings that occurred while creating the metric.",
      "type": "array",
      "insertionOrder": false,
      "items": {
        "type": "string"
      }
    }
  },
  "tagging": {
    "taggable": false
  },
  "additionalProperties": false,
  "createOnlyProperties": [
    "/properties/TimeseriesId",
    "/properties/DisplayName",
    "/properties/Dimensions",
    "/properties/Types"
  ],
  "readOnlyProperties": [
    "/properties/AggregationTypes",
    "/properties/Filter",
    "/properties/DetailedSource"
  ],
  "primaryIdentifier": [
    "/properties/TimeseriesId"
  ],
  "handlers": {
    "create": {
      "permissions": []
    },
    "read": {
      "permissions": []
    },
    "delete": {
      "permissions": []
    },
    "list": {
      "permissions": []
    }
  }
}