Instance Tags¶

EC2 instance tags can be exposed through the AWS Instance Metadata Service through the tags/instance instance category. The imds-mock exposes a default Name=imds-mock-ec2 tag to simulate the enablement of this feature.

Custom Tags¶

If you wish to override the default instance tags exposed by the imds-mock, the --instance-tags flag accepts a list of key=value pairs.

CLIDockerHubGHCR

imds-mock --instance-tags Name=Test,Environment=Dev

docker run -p 1338:1338 purpleclay/imds-mock --instance-tags Name=Test,Environment=Dev

docker run -p 1338:1338 ghcr.io/purpleclay/imds-mock --instance-tags Name=Test,Environment=Dev

Querying a Tag¶

Any custom tag can be retrieved using the root metadata category tags/instance. For example, to retrieve the Environment tag:

curl http://localhost:1338/latest/meta-data/tags/instance/Environment

Excluding Instance Tags¶

EC2 instance tags are omitted from the AWS Instance Metadata Service by default. Set the --exclude-instance-tags flag to simulate this in the imds-mock:

CLIDockerHubGHCR

imds-mock --exclude-instance-tags

docker run -p 1338:1338 purpleclay/imds-mock --exclude-instance-tags

docker run -p 1338:1338 ghcr.io/purpleclay/imds-mock --exclude-instance-tags