x-aps - AWS::APS::Workspace ¶

Module to create/use existing AWS Managed Prometheus workspace(s).

          x-aps:
  managed-prometheus-01:
    Properties: {}
    MacroParameters: {}
    Services: {}
    Lookup: {}

         

Services ¶

ReturnValues ¶

You can export to environment variables the native AWS APS Workspace.ReturnValues , as per the documentation.

Tip

Non standard output attributes are also available:

RemoteWriteUrl: Uses the value for PrometheusEndpoint and adds /api/v1/remote_write to the URL.
QueryUrl: Uses the value for PrometheusEndpoint and adds /api/v1/query to the URL.

Attention

These are currently only available via ReturnValues , not via x-aps::<workspace>::<ReturnValue> in environment variables.

MacroParameters ¶

CreateNewLogGroup ¶

Parameter that can either be a boolean or the Properties for AWS Logs LogGroup It creates a new Log Group for Prometheus to log information to.

JSON Schema ¶

Model ¶

x-aps ¶

x-aps.spec.json
x-aps specification
type	object
properties
Lookup	x-resources.common.spec.json#/definitions/Lookup
Properties	https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html
	type	object
Settings	x-resources.common.spec.json#/definitions/Settings
Services	x-resources.common.spec.json#/definitions/Services
MacroParameters	type	object
	properties
	CreateNewLogGroup	oneOf	Creates a new LogGroup to use for LoggingConfiguration.
			type	boolean
			LogGroup properties as defined at https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html
			type	object
additionalProperties	False

Definition ¶

            {
  "$schema": "http://json-schema.org/draft-07/schema#",
  "id": "x-aps.spec.json",
  "$id": "x-aps.spec.json",
  "title": "x-aps",
  "description": "x-aps specification",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "Lookup": {
      "$ref": "x-resources.common.spec.json#/definitions/Lookup"
    },
    "Properties": {
      "type": "object",
      "description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html"
    },
    "Settings": {
      "$ref": "x-resources.common.spec.json#/definitions/Settings"
    },
    "Services": {
      "$ref": "x-resources.common.spec.json#/definitions/Services"
    },
    "MacroParameters": {
      "type": "object",
      "properties": {
        "CreateNewLogGroup": {
          "oneOf": [
            {
              "type": "boolean",
              "description": "Creates a new LogGroup to use for LoggingConfiguration."
            },
            {
              "type": "object",
              "description": "LogGroup properties as defined at https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html"
            }
          ]
        }
      }
    }
  }
}

           

Test files ¶

You can find the test files here to use as reference for your use-case.