Instance metadata and user data in AWS - Commands & Configuration

Introduction

When you launch a cloud server, you often need to know details about it or set it up automatically. Instance metadata lets the server learn about itself, like its name or network. User data lets you give instructions to the server to run when it starts, like installing software.

When you want the server to know its own IP address or hostname without manual input

When you want to automatically install software or set configurations when the server starts

When you need to pass secrets or keys securely to the server at launch time

When you want to automate setup tasks like creating users or starting services

When you want to debug or check server details without logging into it

Commands

This command fetches the unique ID of the running server from its metadata service. It helps identify the server without logging in.

Terminal

curl http://169.254.169.254/latest/meta-data/instance-id

Expected Output

i-0abcd1234efgh5678

This command retrieves the user data script or text that was provided when the server was launched. It shows what instructions the server received to run at startup.

Terminal

curl http://169.254.169.254/latest/user-data

Expected Output

#!/bin/bash

yum update -y

amazon-linux-extras install nginx1 -y

systemctl start nginx

This command launches a new server with a specific image and type. It uses a user data script from the file 'setup.sh' to configure the server automatically and tags it with a name.

Terminal

aws ec2 run-instances --image-id ami-0abcdef1234567890 --count 1 --instance-type t2.micro --user-data file://setup.sh --tag-specifications 'ResourceType=instance,Tags=[{Key=Name,Value=example-instance}]'

Expected Output

{

    "Instances": [

        {

            "InstanceId": "i-0abcd1234efgh5678",

            "ImageId": "ami-0abcdef1234567890",

            "InstanceType": "t2.micro",

            "State": {"Name": "pending"}

        }

    ]

}

→

--user-data - Specifies the script or commands to run when the instance starts

→

--tag-specifications - Adds tags like Name to help identify the instance

Key Concept

If you remember nothing else from this pattern, remember: instance metadata lets a server learn about itself, and user data lets you give it instructions to run when it starts.

Common Mistakes

Trying to access instance metadata from outside the server

The metadata service is only accessible from inside the server at a special IP address, so external requests fail

Run metadata queries from within the server's command line or scripts

Providing user data without the correct script header (like #!/bin/bash)

Without the proper header, the server may not run the user data as a script, so setup commands fail

Always start user data scripts with a proper shell header like #!/bin/bash

Not encoding or formatting user data correctly when launching instances

Incorrect formatting can cause the user data to be ignored or cause errors during instance startup

Use file:// syntax with properly formatted scripts or base64 encode user data if required

Summary

Use curl commands inside the server to get instance metadata like instance ID or IP address.

Provide user data scripts when launching instances to automate setup tasks.

Use AWS CLI run-instances command with --user-data flag to pass startup instructions.