Provides access to EC2 instance metadata when running on an EC2 instance. If this class is used on a non-EC2 instance, the properties in this class will return null.
Inheritance Hierarchy
Namespace: Amazon.Util
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z
Syntax
public static class EC2InstanceMetadata
The EC2InstanceMetadata type exposes the following members
Properties
| Name | Type | Description | |
|---|---|---|---|
|
AmiId | System.String |
The AMI ID used to launch the instance. |
|
|
AmiLaunchIndex | System.String |
The index of this instance in the reservation. |
|
|
AmiManifestPath | System.String |
The manifest path of the AMI with which the instance was launched. |
|
|
AncestorAmiIds | System.Collections.Generic.IEnumerable<System.String> |
The AMI IDs of any instances that were rebundled to create this AMI. Will only exist if the AMI manifest file contained an ancestor-amis key. |
|
|
AvailabilityZone | System.String |
The Availability Zone in which the instance launched. |
|
|
BlockDeviceMapping | System.Collections.Generic.IDictionary<System.String, System.String> |
The virtual devices associated with the ami, root, ebs, and swap. |
|
|
EC2ApiTokenUrl | System.String |
URI to retrieve the IMDS API token |
|
|
EC2DynamicDataRoot | System.String |
Root URI to retrieve dynamic instance data |
|
|
EC2MetadataRoot | System.String |
Root URI to retrieve instance metadata |
|
|
EC2MetadataV1Disabled | System.Boolean |
Controls whether request EC2 metadata v1 fallback is disabled. |
|
|
EC2UserDataRoot | System.String |
Root URI to retrieve instance user data |
|
|
Hostname | System.String |
The private hostname of the instance. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). |
|
|
IAMInstanceProfileInfo | Amazon.Util.IAMInstanceProfileMetadata |
Returns information about the last time the instance profile was updated, including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. |
|
|
IAMSecurityCredentials | System.Collections.Generic.IDictionary<System.String, Amazon.Util.IAMSecurityCredentialMetadata> |
Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM roles on the instance. |
|
|
IdentityDocument | System.String |
JSON containing instance attributes, such as instance-id, private IP address, etc |
|
|
IdentityPkcs7 | System.String |
Used to verify the document's authenticity and content against the signature. |
|
|
IdentitySignature | System.String |
Data that can be used by other parties to verify its origin and authenticity. |
|
|
InstanceAction | System.String |
Notifies the instance that it should reboot in preparation for bundling. Valid values: none | shutdown | bundle-pending. |
|
|
InstanceId | System.String |
The ID of this instance. |
|
|
InstanceMonitoring | System.String |
Value showing whether the customer has enabled detailed one-minute monitoring in CloudWatch. |
|
|
InstanceType | System.String |
The type of instance. |
|
|
IsIMDSEnabled | System.Boolean |
If set to true the SDK logic for falling back to V1 will be disabled. When using the SDK on an EC2 instance that has configured instance metadata service to use V1 only, a InvalidOperationException exception will be thrown when attempting to access the metadata in EC2 instance metadata.This includes AWS credentials and region information. The default value is false. |
|
|
KernelId | System.String |
The ID of the kernel launched with this instance, if applicable. |
|
|
LocalHostname | System.String |
The local hostname of the instance. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which device-number is 0). |
|
|
MacAddress | System.String |
The instance's MAC address. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which device-number is 0). |
|
|
NetworkInterfaces | System.Collections.Generic.IEnumerable<Amazon.Util.NetworkInterfaceMetadata> |
The network interfaces on the instance. |
|
|
PrivateIpAddress | System.String |
The private IP address of the instance. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which device-number is 0). |
|
|
ProductCodes | System.Collections.Generic.IEnumerable<System.String> |
Product codes associated with the instance, if any. |
|
|
Proxy | System.Net.IWebProxy |
Allows to configure the proxy used for HTTP requests. The default value is null. |
|
|
PublicKey | System.String |
Public key. Only available if supplied at instance launch time. |
|
|
RamdiskId | System.String |
The ID of the RAM disk specified at launch time, if applicable. |
|
|
Region | Amazon.RegionEndpoint |
The region in which the instance is running, extracted from the identity document data. |
|
|
ReservationId | System.String |
ID of the reservation. |
|
|
SecurityGroups | System.Collections.Generic.IEnumerable<System.String> |
The names of the security groups applied to the instance. |
|
|
ServiceEndpoint | System.String |
Base endpoint of the instance metadata service. Returns the endpoint configured first via environment variable AWS_EC2_METADATA_SERVICE_ENDPOINT then the current profile's ec2_metadata_service_endpoint value. If a specific endpoint is not configured, it selects a pre-determined endpoint based on environment variable AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE then the current profile's ec2_metadata_service_endpoint_mode setting. |
|
|
UserData | System.String |
The metadata sent to the instance. |
Methods
| Name | Description | |
|---|---|---|
|
|
ClearTokenFlag() | |
|
|
FetchApiToken() |
Fetches the api token to use with metadata requests. |
|
|
GetData(string) |
Return the metadata at the path |
|
|
GetData(string, int) |
Return the metadata at the path |
|
|
GetItems(string) |
Return the list of items in the metadata at path. |
|
|
GetItems(string, int) |
Return the list of items in the metadata at path. |
Fields
| Name | Type | Description | |
|---|---|---|---|
|
|
AWS_EC2_METADATA_DISABLED | System.String | |
|
|
EC2_APITOKEN_URL | System.String | |
|
|
EC2_DYNAMICDATA_ROOT | System.String | |
|
|
EC2_METADATA_ROOT | System.String | |
|
|
EC2_METADATA_SVC | System.String | |
|
|
EC2_USERDATA_ROOT | System.String | |
|
|
LATEST | System.String |
Remarks
Amazon EC2 instances can access instance-specific metadata, as well as data supplied when launching the instances, using a specific URI.
You can use this data to build more generic AMIs that can be modified by configuration files supplied at launch time. For example, if you run web servers for various small businesses, they can all use the same AMI and retrieve their content from the Amazon S3 bucket you specify at launch. To add a new customer at any time, simply create a bucket for the customer, add their content, and launch your AMI.
More information about EC2 Metadata http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5