Class EC2MetadataUtils


  • public class EC2MetadataUtils
    extends Object
    Utility class for retrieving Amazon EC2 instance metadata.
    You can use the 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 Amazon EC2 Metadata
    See Also:
    Amazon EC2 User Guide: Instance Metadata
    • Constructor Detail

      • EC2MetadataUtils

        public EC2MetadataUtils()
    • Method Detail

      • getAmiId

        public static String getAmiId()
        Get the AMI ID used to launch the instance.
      • getAmiLaunchIndex

        public static String getAmiLaunchIndex()
        Get the index of this instance in the reservation.
      • getAmiManifestPath

        public static String getAmiManifestPath()
        Get the manifest path of the AMI with which the instance was launched.
      • getAncestorAmiIds

        public static List<String> getAncestorAmiIds()
        Get the list of AMI IDs of any instances that were rebundled to created this AMI. Will only exist if the AMI manifest file contained an ancestor-amis key.
      • getInstanceAction

        public static String getInstanceAction()
        Notifies the instance that it should reboot in preparation for bundling. Valid values: none | shutdown | bundle-pending.
      • getInstanceId

        public static String getInstanceId()
        Get the ID of this instance.
      • getInstanceType

        public static String getInstanceType()
        Get the type of the instance.
      • getLocalHostName

        public static String getLocalHostName()
        Get 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).
      • getMacAddress

        public static String getMacAddress()
        Get the MAC 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).
      • getPrivateIpAddress

        public static String getPrivateIpAddress()
        Get 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).
      • getAvailabilityZone

        public static String getAvailabilityZone()
        Get the Availability Zone in which the instance launched.
      • getProductCodes

        public static List<String> getProductCodes()
        Get the list of product codes associated with the instance, if any.
      • getPublicKey

        public static String getPublicKey()
        Get the public key. Only available if supplied at instance launch time.
      • getRamdiskId

        public static String getRamdiskId()
        Get the ID of the RAM disk specified at launch time, if applicable.
      • getReservationId

        public static String getReservationId()
        Get the ID of the reservation.
      • getSecurityGroups

        public static List<String> getSecurityGroups()
        Get the list of names of the security groups applied to the instance.
      • getIAMInstanceProfileInfo

        public static EC2MetadataUtils.IAMInfo getIAMInstanceProfileInfo()
        Get information about the last time the instance profile was updated, including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId.
      • getInstanceInfo

        public static EC2MetadataUtils.InstanceInfo getInstanceInfo()
        The instance info is only guaranteed to be a JSON document per http://docs .aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html

        This method is only a best attempt to capture the instance info as a typed object.

        Get an InstanceInfo object with dynamic information about this instance.

      • getEC2InstanceRegion

        public static String getEC2InstanceRegion()
        Returns the current region of this running EC2 instance; or null if it is unable to do so. The method avoids interpreting other parts of the instance info JSON document to minimize potential failure.

        The instance info is only guaranteed to be a JSON document per http://docs .aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html

      • getIAMSecurityCredentials

        public static Map<String,​EC2MetadataUtils.IAMSecurityCredential> getIAMSecurityCredentials()
        Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM roles on the instance.
      • getBlockDeviceMapping

        public static Map<String,​String> getBlockDeviceMapping()
        Get the virtual devices associated with the ami, root, ebs, and swap.
      • getUserData

        public static String getUserData()
        Get the metadata sent to the instance
      • getData

        public static String getData​(String path,
                                     int tries)