AWS EC2 Metadata
Requirements
Running this transform within Docker on EC2 requires 2 network hops. Users must raise this limit:
aws ec2 modify-instance-metadata-options --instance-id <ID> --http-endpoint enabled --http-put-response-hop-limit 2
Configuration Options
Required Options
inputs(required)
A list of upstream source or transform
IDs. Wildcards (*) are supported.
See configuration for more info.
| Type | Syntax | Default | Example |
|---|---|---|---|
| array | literal | ["my-source-or-transform-id","prefix-*"] |
type(required)
The component type. This is a required field for all components and tells Vector which component to use.
| Type | Syntax | Default | Example |
|---|---|---|---|
| string | literal | ["aws_ec2_metadata"] |
Advanced Options
endpoint(optional)
Override the default EC2 Metadata endpoint.
| Type | Syntax | Default | Example |
|---|---|---|---|
| string | literal | http://169.254.169.254 |
fields(optional)
A list of fields to include in each event.
| Type | Syntax | Default | Example |
|---|---|---|---|
| array | literal | instance-idlocal-hostnamelocal-ipv4public-hostnamepublic-ipv4ami-idavailability-zonevpc-idsubnet-idregion | ["instance-id","local-hostname"] |
namespace(optional)
Prepend a namespace to each field's key.
| Type | Syntax | Default | Example |
|---|---|---|---|
| string | literal | ["","ec2","aws.ec2"] |
proxy(optional)
Configures an HTTP(S) proxy for Vector to use. By default, the globally configured proxy is used.
| Type | Syntax | Default | Example |
|---|---|---|---|
| hash | literal | [] |
refresh_interval_secs(optional)
The interval in seconds at which the EC2 Metadata api will be called.
| Type | Syntax | Default | Example |
|---|---|---|---|
| uint | 10 |
How it Works
State
This component is stateless, meaning its behavior is consistent across each input.