| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | provisional |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.EC2.Metadata
Description
This module contains functions for retrieving various EC2 metadata from an instance's local metadata endpoint.
It is intended to be used when you need to make metadata calls prior to
initialisation of the Env.
Synopsis
- isEC2 :: MonadIO m => Manager -> m Bool
- dynamic :: MonadIO m => Manager -> Dynamic -> m ByteString
- metadata :: MonadIO m => Manager -> Metadata -> m ByteString
- userdata :: MonadIO m => Manager -> m (Maybe ByteString)
- identity :: MonadIO m => Manager -> m (Either String IdentityDocument)
- data Dynamic
- data Metadata
- = AMIId
- | AMILaunchIndex
- | AMIManifestPath
- | AncestorAMIIds
- | BlockDevice !Mapping
- | Hostname
- | IAM !Info
- | InstanceAction
- | InstanceId
- | InstanceType
- | KernelId
- | LocalHostname
- | LocalIPV4
- | MAC
- | Network !Text !Interface
- | AvailabilityZone
- | ProductCodes
- | PublicHostname
- | PublicIPV4
- | OpenSSHKey
- | RAMDiskId
- | ReservationId
- | SecurityGroups
- data Mapping
- data Info
- data Interface
- data IdentityDocument = IdentityDocument {
- _devpayProductCodes :: Maybe [Text]
- _billingProducts :: Maybe [Text]
- _version :: Maybe Text
- _privateIp :: Maybe Text
- _availabilityZone :: Text
- _region :: Region
- _instanceId :: Text
- _instanceType :: Text
- _accountId :: Text
- _imageId :: Maybe Text
- _kernelId :: Maybe Text
- _ramdiskId :: Maybe Text
- _architecture :: Maybe Text
- _pendingTime :: Maybe ISO8601
- devpayProductCodes :: Lens' IdentityDocument (Maybe [Text])
- billingProducts :: Lens' IdentityDocument (Maybe [Text])
- version :: Lens' IdentityDocument (Maybe Text)
- privateIp :: Lens' IdentityDocument (Maybe Text)
- availabilityZone :: Lens' IdentityDocument Text
- region :: Lens' IdentityDocument Region
- instanceId :: Lens' IdentityDocument Text
- instanceType :: Lens' IdentityDocument Text
- accountId :: Lens' IdentityDocument Text
- imageId :: Lens' IdentityDocument (Maybe Text)
- kernelId :: Lens' IdentityDocument (Maybe Text)
- ramdiskId :: Lens' IdentityDocument (Maybe Text)
- architecture :: Lens' IdentityDocument (Maybe Text)
- pendingTime :: Lens' IdentityDocument (Maybe UTCTime)
EC2 Instance Check
isEC2 :: MonadIO m => Manager -> m Bool Source #
Test whether the underlying host is running on EC2 by
making an HTTP request to http://instance-data/latest.
Retrieving Instance Data
dynamic :: MonadIO m => Manager -> Dynamic -> m ByteString Source #
Retrieve the specified Dynamic data.
Throws HttpException if HTTP communication fails.
metadata :: MonadIO m => Manager -> Metadata -> m ByteString Source #
Retrieve the specified Metadata.
Throws HttpException if HTTP communication fails.
userdata :: MonadIO m => Manager -> m (Maybe ByteString) Source #
Retrieve the user data. Returns Nothing if no user data is assigned
to the instance.
Throws HttpException if HTTP communication fails.
identity :: MonadIO m => Manager -> m (Either String IdentityDocument) Source #
Path Constructors
Constructors
| FWS | Value showing whether the customer has enabled detailed one-minute monitoring in CloudWatch. Valid values: enabled | disabled. |
| Document | JSON containing instance attributes, such as instance-id,
private IP address, etc.
See: |
| PKCS7 | Used to verify the document's authenticity and content against the signature. |
| Signature |
Instances
| Eq Dynamic Source # | |
| Ord Dynamic Source # | |
Defined in Amazonka.EC2.Metadata | |
| Show Dynamic Source # | |
| Generic Dynamic Source # | |
| ToText Dynamic Source # | |
Defined in Amazonka.EC2.Metadata | |
| type Rep Dynamic Source # | |
Defined in Amazonka.EC2.Metadata type Rep Dynamic = D1 ('MetaData "Dynamic" "Amazonka.EC2.Metadata" "libZSamazonkaZSamazonka" 'False) ((C1 ('MetaCons "FWS" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Document" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PKCS7" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Signature" 'PrefixI 'False) (U1 :: Type -> Type))) | |
Constructors
| AMIId | The AMI ID used to launch the instance. |
| AMILaunchIndex | If you started more than one instance at the same time, this value indicates the order in which the instance was launched. The value of the first instance launched is 0. |
| AMIManifestPath | The path to the AMI's manifest file in Amazon S3. If you used an Amazon EBS-backed AMI to launch the instance, the returned result is unknown. |
| AncestorAMIIds | The AMI IDs of any instances that were rebundled to create this AMI. This value will only exist if the AMI manifest file contained an ancestor-amis key. |
| BlockDevice !Mapping | See: |
| Hostname | 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). |
| IAM !Info | See: |
| InstanceAction | Notifies the instance that it should reboot in preparation for bundling. Valid values: none | shutdown | bundle-pending. |
| InstanceId | The ID of this instance. |
| InstanceType | The type of instance. See: |
| KernelId | The ID of the kernel launched with this instance, if applicable. |
| LocalHostname | The private DNS 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). |
| LocalIPV4 | 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 the device number is 0). |
| MAC | The instance's media access control (MAC) address. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). |
| Network !Text !Interface | See: |
| AvailabilityZone | The Availability Zone in which the instance launched. |
| ProductCodes | Product codes associated with the instance, if any. |
| PublicHostname | The instance's public DNS. If the instance is in a VPC, this category is only returned if the enableDnsHostnames attribute is set to true. For more information, see Using DNS with Your VPC. |
| PublicIPV4 | The public IP address. If an Elastic IP address is associated with the instance, the value returned is the Elastic IP address. |
| OpenSSHKey | Public key. Only available if supplied at instance launch time. |
| RAMDiskId | The ID of the RAM disk specified at launch time, if applicable. |
| ReservationId | ID of the reservation. |
| SecurityGroups | The names of the security groups applied to the instance. |
Instances
Constructors
| AMI | The virtual device that contains the root/boot file system. |
| EBS !Int | The virtual devices associated with Amazon EBS volumes, if present. This value is only available in metadata if it is present at launch time. The N indicates the index of the Amazon EBS volume (such as ebs1 or ebs2). |
| Ephemeral !Int | The virtual devices associated with ephemeral devices, if present. The N indicates the index of the ephemeral volume. |
| Root | The virtual devices or partitions associated with the root devices, or partitions on the virtual device, where the root (/ or C:) file system is associated with the given instance. |
| Swap | The virtual devices associated with swap. Not always present. |
Instances
| Eq Mapping Source # | |
| Ord Mapping Source # | |
Defined in Amazonka.EC2.Metadata | |
| Show Mapping Source # | |
| Generic Mapping Source # | |
| ToText Mapping Source # | |
Defined in Amazonka.EC2.Metadata | |
| type Rep Mapping Source # | |
Defined in Amazonka.EC2.Metadata type Rep Mapping = D1 ('MetaData "Mapping" "Amazonka.EC2.Metadata" "libZSamazonkaZSamazonka" 'False) ((C1 ('MetaCons "AMI" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EBS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int))) :+: (C1 ('MetaCons "Ephemeral" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :+: (C1 ('MetaCons "Root" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Swap" 'PrefixI 'False) (U1 :: Type -> Type)))) | |
Constructors
| Info' | Returns information about the last time the instance profile was updated, including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. |
| SecurityCredentials (Maybe Text) | Where role-name is the name of the IAM role associated with the instance. Returns the temporary security credentials. See: |
Instances
| Eq Info Source # | |
| Ord Info Source # | |
| Show Info Source # | |
| Generic Info Source # | |
| ToText Info Source # | |
Defined in Amazonka.EC2.Metadata | |
| type Rep Info Source # | |
Defined in Amazonka.EC2.Metadata type Rep Info = D1 ('MetaData "Info" "Amazonka.EC2.Metadata" "libZSamazonkaZSamazonka" 'False) (C1 ('MetaCons "Info'" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SecurityCredentials" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Constructors
| IDeviceNumber | The device number associated with that interface. Each interface must have a unique device number. The device number serves as a hint to device naming in the instance; for example, device-number is 2 for the eth2 device. |
| IIPV4Associations !Text | The private IPv4 addresses that are associated with each public-ip address and assigned to that interface. |
| ILocalHostname | The interface's local hostname. |
| ILocalIPV4s | The private IP addresses associated with the interface. |
| IMAC | The instance's MAC address. |
| IOwnerId | The ID of the owner of the network interface. In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. Traffic on an interface is always billed to the interface owner. |
| IPublicHostname | The interface's public DNS. If the instance is in a VPC, this category is only returned if the enableDnsHostnames attribute is set to true. For more information, see Using DNS with Your VPC. |
| IPublicIPV4s | The Elastic IP addresses associated with the interface. There may be multiple IP addresses on an instance. |
| ISecurityGroups | Security groups to which the network interface belongs. Returned only for instances launched into a VPC. |
| ISecurityGroupIds | IDs of the security groups to which the network interface belongs. Returned only for instances launched into a VPC. For more information on security groups in the EC2-VPC platform, see Security Groups for Your VPC. |
| ISubnetId | The ID of the subnet in which the interface resides. Returned only for instances launched into a VPC. |
| ISubnetIPV4_CIDRBlock | The CIDR block of the subnet in which the interface resides. Returned only for instances launched into a VPC. |
| IVPCId | The ID of the VPC in which the interface resides. Returned only for instances launched into a VPC. |
| IVPCIPV4_CIDRBlock | The CIDR block of the VPC in which the interface resides. Returned only for instances launched into a VPC. |
Instances
Identity Document
data IdentityDocument Source #
Represents an instance's identity document.
Note: Fields such as $sel:_instanceType:IdentityDocument are represented as unparsed Text and
will need to be manually parsed using fromText when the relevant types
from a library such as Amazonka.EC2 are brought into scope.
Constructors
| IdentityDocument | |
Fields
| |
Instances
Lenses
billingProducts :: Lens' IdentityDocument (Maybe [Text]) Source #