x-tags ¶

Mapping syntax ¶

Key/Value structure ¶

            x-tags:
  str: value

List syntax ¶

Alternatively, you can use the default AWS CFN implementation

List of Key/Value tags ¶

            x-tags:
  - Key: sts
    Value: <value>

           

Default tags ¶

CreatedByComposeX: true # Allows you to identify quickly if that resource was created by Compose-X compose-x::version: <value> # Defines which version of compose-x was used to create this resource.

JSON Schema ¶

Model ¶

x-tags ¶

x-tags.spec.json
x-tags specification
oneOf	type	object
	patternProperties
	[\x20-\x7E]+	type	string
		maxLength	256
		minLength	0
	type	array
	items	type	object
		properties
		Key	type	string
			maxLength	128
			minLength	1
		Value	type	string
			maxLength	256
			minLength	0

Definition ¶

           {
  "$schema": "http://json-schema.org/draft-07/schema#",
  "id": "x-tags.spec.json",
  "$id": "x-tags.spec.json",
  "title": "x-tags",
  "description": "x-tags specification",
  "oneOf": [
    {
      "type": "object",
      "patternProperties": {
        "[\\x20-\\x7E]+": {
          "type": "string",
          "minLength": 0,
          "maxLength": 256
        }
      }
    },
    {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "Key",
          "Value"
        ],
        "properties": {
          "Key": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "Value": {
            "type": "string",
            "minLength": 0,
            "maxLength": 256
          }
        }
      }
    }
  ]
}

          

Hint

It is against the ECS Compose-X philosophy to tag existing resources. If you need to tag existing resources, you will have to find another technique to do that. Sorry for the inconvenience.