ImdsClient.h

Go to the documentation of this file.

#pragma once
 
#include <aws/crt/DateTime.h>
#include <aws/crt/Exports.h>
#include <aws/crt/Types.h>
#include <functional>
 
struct aws_credentials;
struct aws_imds_client;
struct aws_imds_instance_info;
struct aws_imds_iam_profile;
 
namespace Aws
{
 
    namespace Crt
    {
 
        namespace Io
        {
            class ClientBootstrap;
        }
 
        namespace Auth
        {
            class Credentials;
        }
 
        namespace Imds
        {
 
            struct AWS_CRT_CPP_API ImdsClientConfig
            {
                ImdsClientConfig() : Bootstrap(nullptr) {}
 
                Io::ClientBootstrap *Bootstrap;
 
                /* Should add retry strategy support once that is available */
            };
 
            struct AWS_CRT_CPP_API IamProfileView
            {
                DateTime lastUpdated;
                StringView instanceProfileArn;
                StringView instanceProfileId;
            };
 
            struct AWS_CRT_CPP_API IamProfile
            {
                IamProfile() {}
                IamProfile(const IamProfileView &other);
 
                IamProfile &operator=(const IamProfileView &other);
 
                DateTime lastUpdated;
                String instanceProfileArn;
                String instanceProfileId;
            };
 
            struct AWS_CRT_CPP_API InstanceInfoView
            {
                /* an array of StringView */
                Vector<StringView> marketplaceProductCodes;
                StringView availabilityZone;
                StringView privateIp;
                StringView version;
                StringView instanceId;
                /* an array of StringView */
                Vector<StringView> billingProducts;
                StringView instanceType;
                StringView accountId;
                StringView imageId;
                DateTime pendingTime;
                StringView architecture;
                StringView kernelId;
                StringView ramdiskId;
                StringView region;
            };
 
            struct AWS_CRT_CPP_API InstanceInfo
            {
                InstanceInfo() {}
                InstanceInfo(const InstanceInfoView &other);
 
                InstanceInfo &operator=(const InstanceInfoView &other);
 
                /* an array of StringView */
                Vector<String> marketplaceProductCodes;
                String availabilityZone;
                String privateIp;
                String version;
                String instanceId;
                /* an array of StringView */
                Vector<String> billingProducts;
                String instanceType;
                String accountId;
                String imageId;
                DateTime pendingTime;
                String architecture;
                String kernelId;
                String ramdiskId;
                String region;
            };
 
            using OnResourceAcquired = std::function<void(const StringView &resource, int errorCode, void *userData)>;
            using OnVectorResourceAcquired =
                std::function<void(const Vector<StringView> &resource, int errorCode, void *userData)>;
            using OnCredentialsAcquired =
                std::function<void(const Auth::Credentials &credentials, int errorCode, void *userData)>;
            using OnIamProfileAcquired =
                std::function<void(const IamProfileView &iamProfile, int errorCode, void *userData)>;
            using OnInstanceInfoAcquired =
                std::function<void(const InstanceInfoView &instanceInfo, int errorCode, void *userData)>;
 
            class AWS_CRT_CPP_API ImdsClient
            {
              public:
                ImdsClient(const ImdsClientConfig &config, Allocator *allocator = ApiAllocator()) noexcept;
 
                ~ImdsClient();
 
                ImdsClient(const ImdsClient &) = delete;
                ImdsClient(ImdsClient &&) = delete;
                ImdsClient &operator=(const ImdsClient &) = delete;
                ImdsClient &operator=(ImdsClient &&) = delete;
 
                aws_imds_client *GetUnderlyingHandle() { return m_client; }
 
                int GetResource(const StringView &resourcePath, OnResourceAcquired callback, void *userData);
 
                int GetAmiId(OnResourceAcquired callback, void *userData);
 
                int GetAmiLaunchIndex(OnResourceAcquired callback, void *userData);
 
                int GetAmiManifestPath(OnResourceAcquired callback, void *userData);
 
                int GetAncestorAmiIds(OnVectorResourceAcquired callback, void *userData);
 
                int GetInstanceAction(OnResourceAcquired callback, void *userData);
 
                int GetInstanceId(OnResourceAcquired callback, void *userData);
 
                int GetInstanceType(OnResourceAcquired callback, void *userData);
 
                int GetMacAddress(OnResourceAcquired callback, void *userData);
 
                int GetPrivateIpAddress(OnResourceAcquired callback, void *userData);
 
                int GetAvailabilityZone(OnResourceAcquired callback, void *userData);
 
                int GetProductCodes(OnResourceAcquired callback, void *userData);
 
                int GetPublicKey(OnResourceAcquired callback, void *userData);
 
                int GetRamDiskId(OnResourceAcquired callback, void *userData);
 
                int GetReservationId(OnResourceAcquired callback, void *userData);
 
                int GetSecurityGroups(OnVectorResourceAcquired callback, void *userData);
 
                int GetBlockDeviceMapping(OnVectorResourceAcquired callback, void *userData);
 
                int GetAttachedIamRole(OnResourceAcquired callback, void *userData);
 
                int GetCredentials(const StringView &iamRoleName, OnCredentialsAcquired callback, void *userData);
 
                int GetIamProfile(OnIamProfileAcquired callback, void *userData);
 
                int GetUserData(OnResourceAcquired callback, void *userData);
 
                int GetInstanceSignature(OnResourceAcquired callback, void *userData);
 
                int GetInstanceInfo(OnInstanceInfoAcquired callback, void *userData);
 
              private:
                static void s_onResourceAcquired(const aws_byte_buf *resource, int erroCode, void *userData);
 
                static void s_onVectorResourceAcquired(const aws_array_list *array, int errorCode, void *userData);
 
                static void s_onCredentialsAcquired(const aws_credentials *credentials, int errorCode, void *userData);
 
                static void s_onIamProfileAcquired(
                    const aws_imds_iam_profile *iamProfileInfo,
                    int errorCode,
                    void *userData);
 
                static void s_onInstanceInfoAcquired(
                    const aws_imds_instance_info *instanceInfo,
                    int error_code,
                    void *userData);
 
                aws_imds_client *m_client;
                Allocator *m_allocator;
            };
 
        } // namespace Imds
    } // namespace Crt
} // namespace Aws