Instance metadata and user data in AWS - Mini Project: Build & Apply

AWS EC2 Instance Metadata and User Data

📖 Scenario: You are setting up a new AWS EC2 instance for a small web application. You want to configure the instance so it can access its own metadata and run a simple startup script automatically when it launches.

🎯 Goal: Build an AWS EC2 instance configuration that includes accessing instance metadata and setting user data to run a startup script.

📋 What You'll Learn

Create a variable with the instance metadata URL

Create a variable with a simple user data script

Write code to fetch instance metadata using the metadata URL

Add the user data script to the EC2 instance configuration

💡 Why This Matters

🌍 Real World

Accessing instance metadata and using user data scripts are common tasks when configuring cloud servers to automate setup and retrieve instance details.

💼 Career

Cloud engineers and DevOps professionals often write user data scripts and query instance metadata to automate server configuration and monitoring.

1

Create the instance metadata URL variable

Create a variable called metadata_url and set it to the exact string "http://169.254.169.254/latest/meta-data/".

AWS

# Create a variable called metadata_url with the instance metadata URL
# Your code here

Hint

The instance metadata service is accessed via a special IP address. Use that exact URL.

2

Create the user data script variable

Create a variable called user_data_script and set it to the exact multi-line string that contains a bash script starting with #!/bin/bash and includes the line echo "Hello from user data" > /var/tmp/user_data_output.txt.

AWS

metadata_url = "http://169.254.169.254/latest/meta-data/"
# Create a variable called user_data_script with the startup bash script
# Your code here

Hint

The user data script runs on instance launch. Use triple quotes for multi-line string.

3

Fetch instance metadata using the metadata URL

Write code to import the requests library and create a variable called instance_id that fetches the instance ID by sending a GET request to metadata_url + 'instance-id' and getting the text response.

AWS

metadata_url = "http://169.254.169.254/latest/meta-data/"
user_data_script = """#!/bin/bash
 echo \"Hello from user data\" > /var/tmp/user_data_output.txt
"""
# Import requests and fetch instance ID from metadata
# Your code here

Hint

Use requests.get() to fetch metadata and .text to get the string.

4

Add the user data script to the EC2 instance configuration

Create a dictionary called ec2_config with a key 'UserData' set to the variable user_data_script.

AWS

import requests

metadata_url = "http://169.254.169.254/latest/meta-data/"
user_data_script = """#!/bin/bash
 echo \"Hello from user data\" > /var/tmp/user_data_output.txt
"""

instance_id = requests.get(metadata_url + 'instance-id').text
# Create ec2_config dictionary with UserData key
# Your code here

Hint

The EC2 configuration dictionary should include the user data script under the 'UserData' key.

Practice

1. What is the primary purpose of instance metadata in AWS EC2?

easy

A. To provide information about the instance to itself

B. To store user files permanently

C. To allow external users to access the instance

D. To manage billing information for the instance

Solution

1. Step 1: Understand instance metadata role

   Instance metadata is data about the instance that the instance can access itself, such as its ID, IP address, or region.

2. Step 2: Differentiate from other options

   It is not for storing user files, external access, or billing management.

3. Final Answer:

   To provide information about the instance to itself -> Option A

4. Quick Check:

   Instance metadata = instance self-info [OK]

Hint: Instance metadata is info the server knows about itself [OK]

Common Mistakes:

• Confusing metadata with user data
• Thinking metadata is for external access
• Assuming metadata stores user files

2. Which IP address is used inside an EC2 instance to access instance metadata?

easy

A. 127.0.0.1

B. 169.254.169.254

C. 192.168.0.1

D. 10.0.0.1

Solution

1. Step 1: Recall the special metadata IP

   A fixed IP address 169.254.169.254 is reserved for instance metadata access inside EC2 instances.

2. Step 2: Exclude other common IPs

   127.0.0.1 is localhost, 192.168.0.1 and 10.0.0.1 are private network IPs but not for metadata.

3. Final Answer:

   169.254.169.254 -> Option B

4. Quick Check:

   Metadata IP = 169.254.169.254 [OK]

Hint: Metadata IP always starts with 169.254 [OK]

Common Mistakes:

• Using localhost IP 127.0.0.1
• Confusing with private network IPs
• Trying public IP addresses

3. Given this user data script for an EC2 instance:

#!/bin/bash
echo "Hello World" > /home/ec2-user/hello.txt

What will happen when the instance starts?

medium

A. The file will be created but empty

B. The instance will fail to start due to syntax error

C. Nothing happens because user data is ignored

D. The file /home/ec2-user/hello.txt will contain 'Hello World'

Solution

1. Step 1: Understand user data script execution

   User data scripts run once at instance start and can create files or run commands.

2. Step 2: Analyze the script effect

   The script writes 'Hello World' into the file /home/ec2-user/hello.txt, so the file will contain that text.

3. Final Answer:

   The file /home/ec2-user/hello.txt will contain 'Hello World' -> Option D

4. Quick Check:

   User data script writes file content [OK]

Hint: User data runs at start and executes commands [OK]

Common Mistakes:

• Thinking user data runs multiple times
• Assuming syntax error in simple echo
• Believing user data is disabled by default

4. You try to access instance metadata from your EC2 instance using curl http://169.254.169.254/latest/meta-data/ but get no response. What is the most likely cause?

medium

A. Instance metadata service is disabled or blocked

B. The IP address is incorrect

C. User data script is missing

D. The instance is stopped

Solution

1. Step 1: Check IP correctness

   The IP 169.254.169.254 is correct for metadata service, so IP is not the issue.

2. Step 2: Consider service availability

   If no response, the metadata service might be disabled or blocked by firewall or instance settings.

3. Final Answer:

   Instance metadata service is disabled or blocked -> Option A

4. Quick Check:

   No metadata response = service disabled/blocked [OK]

Hint: No metadata response usually means service disabled [OK]

Common Mistakes:

• Assuming wrong IP address
• Confusing user data with metadata
• Not checking instance state

5. You want to automate installing software on an EC2 instance at launch using user data. Which of these is the best practice?

hard

A. Manually SSH into the instance after launch to install software

B. Store installation commands in instance metadata

C. Write a shell script in user data that installs software and runs on first boot

D. Use user data only to store instance tags

Solution

1. Step 1: Understand user data purpose

   User data is designed to run scripts automatically at instance launch to configure or install software.

2. Step 2: Evaluate options

   Manual SSH is not automated, metadata is read-only info, and tags are not stored in user data.

3. Final Answer:

   Write a shell script in user data that installs software and runs on first boot -> Option C

4. Quick Check:

   User data automates setup scripts [OK]

Hint: Use user data scripts to automate setup at launch [OK]

Common Mistakes:

• Trying to store commands in metadata
• Ignoring automation benefits
• Misusing user data for tags