Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions pipeline/filters/aws-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,19 @@ The plugin supports the following configuration parameters:
| Key | Description | Default |
| :--- | :--- | :--- |
| `imds_version` | Specify which version of the instance metadata service to use. Valid values are `v1` and `v2`. | `v2` |
| `az` | The [availability zone](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html), such as `us-east-1a`. | `true` |
| `partition` | The [partition](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html), such as `aws`. | `true` |
| `domain` | The domain for AWS resources in the region, such as `amazonaws.com`. | `false` |
| `region` | The [region](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions), such as `us-east-1`. | `false` |
| `az` | The [availability zone](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones), such as `us-east-1a`. | `true` |
| `az_id` | The [availability zone ID](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#az-ids), such as `use1-az1`. | `false` |
| `placement_group` | The [placement group](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) name. | `false` |
| `partition_number` | The [placement group](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) partition number. | `false` |
| `host_id` | The [dedicated host](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html) ID. | `false` |
| `ec2_instance_id` | The EC2 instance ID. | `true` |
| `ec2_instance_type` | The EC2 instance type. | `false` |
| `private_ip` | The EC2 instance private IP. | `false` |
| `private_ip` | The EC2 instance private IPv4 address. | `false` |
| `public_ip` | The EC2 instance public IPv4 address. | `false` |
| `ipv6` | The EC2 instance IPv6 address. | `false` |
| `ami_id` | The EC2 instance image ID. | `false` |
| `account_id` | The account ID for the current EC2 instance. | `false` |
| `hostname` | The hostname for the current EC2 instance. | `false` |
Expand Down Expand Up @@ -84,10 +93,19 @@ pipeline:
Name aws
Match *
imds_version v1
partition true
domain true
region true
az true
az_id true
placement_group true
partition_number true
host_id true
ec2_instance_id true
ec2_instance_type true
private_ip true
public_ip true
ipv6 true
ami_id true
account_id true
hostname true
Expand Down