AWS SDK for C++
The AWS SDK for C++ provides a modern C++ (version C++ 11 or later) interface for Amazon Web Services (AWS). It is meant to be performant and fully functioning with low- and high-level SDKs, while minimizing dependencies and providing platform portability (Windows, OSX, Linux, and mobile).
AWS SDK for C++ is in now in General Availability and recommended for production use. We invite our customers to join the development efforts by submitting pull requests and sending us feedback and ideas via GitHub Issues.
Version 1.8 is now Available!
Version 1.8 introduces much asked for new features and changes to the SDK but, because this might also cause compatibility issues with previous versions we've decided to keep it as a seperate branch to make the transition less jarring.
Building the SDK:
- Visual Studio 2015 or later
- OR GNU Compiler Collection (GCC) 4.9 or later
- OR Clang 3.3 or later
- 4GB of RAM
- 4GB of RAM is required to build some of the larger clients. The SDK build may fail on EC2 instance types t2.micro, t2.small and other small instance types due to insufficient memory.
Building From Source:
To create an out-of-source build:
Install CMake and the relevant build tools for your platform. Ensure these are available in your executable path.
Create your build directory. Replace <BUILD_DIR> with your build directory name:
Build the project:
- For Auto Make build systems:
cd <BUILD_DIR> cmake <path-to-root-of-this-source-code> -DCMAKE_BUILD_TYPE=Debug make sudo make install
- For Visual Studio:
cd <BUILD_DIR> cmake <path-to-root-of-this-source-code> -G "Visual Studio 15 Win64" -DCMAKE_BUILD_TYPE=Debug msbuild ALL_BUILD.vcxproj /p:Configuration=Debug
- For macOS - Xcode:
cmake <path-to-root-of-this-source-code> -G Xcode -DTARGET_ARCH="APPLE" -DCMAKE_BUILD_TYPE=Debug xcodebuild -target ALL_BUILD
Third party dependencies:
Starting from version 1.7.0, we added several third party dependencies, including
aws-c-event-stream. By default, they will be built and installed in
<BUILD_DIR>/.deps/install, and copied to default system directory during SDK installation. You can change the location by specifying
However, if you want to build and install these libraries in custom locations:
- Download, build and install
git clone https://github.com/awslabs/aws-c-common cd aws-c-common # checkout to a specific commit id if you want. git checkout <commit-id> mkdir build && cd build # without CMAKE_INSTALL_PREFIX, it will be installed to default system directory. cmake .. -DCMAKE_INSTALL_PREFIX=<deps-install-dir> <extra-cmake-parameters-here> make # or MSBuild ALL_BUILD.vcxproj on Windows make install # or MSBuild INSTALL.vcxproj on Windows
- Download, build and install
git clone https://github.com/awslabs/aws-checksums cd aws-checksums # checkout to a specific commit id if you want git checkout <commit-id> mkdir build && cd build # without CMAKE_INSTALL_PREFIX, it will be installed to default system directory. cmake .. -DCMAKE_INSTALL_PREFIX=<deps-install-dir> <extra-cmake-parameters-here> make # or MSBuild ALL_BUILD.vcxproj on Windows make install # or MSBuild INSTALL.vcxproj on Windows
- Download, build and install
git clone https://github.com/awslabs/aws-c-event-stream cd aws-c-event-stream # checkout to a specific commit id if you want git checkout <commit-id> mkdir build && cd build # aws-c-common and aws-checksums are dependencies of aws-c-event-stream # without CMAKE_INSTALL_PREFIX, it will be installed to default system directory. cmake .. -DCMAKE_INSTALL_PREFIX=<deps-install-dir> -DCMAKE_PREFIX_PATH=<deps-install-dir> <extra-cmake-parameters-here> make # or MSBuild ALL_BUILD.vcxproj on Windows make install # or MSBuild INSTALL.vcxproj on Windows
- Turn off
BUILD_DEPSwhen building C++ SDK:
cd BUILD_DIR cmake <path-to-root-of-this-source-code> -DBUILD_DEPS=OFF -DCMAKE_PREFIX_PATH=<deps-install-dir>
You may also find the following link helpful for including the build in your project: https://aws.amazon.com/blogs/developer/using-cmake-exports-with-the-aws-sdk-for-c/
To compile in Linux, you must have the header files for libcurl, libopenssl. The packages are typically available in your package manager.
sudo apt-get install libcurl-dev
Building for Android
To build for Android, add
-DTARGET_ARCH=ANDROID to your cmake command line. Currently we support Android APIs from 19 to 28 with Android NDK 19c and we are using build-in cmake toolchain file supplied by Android NDK, assuming you have the appropriate environment variables (ANDROID_NDK) set.
Android on Windows
Building for Android on Windows requires some additional setup. In particular, you will need to run cmake from a Visual Studio developer command prompt (2015 or higher). Additionally, you will need 'git' and 'patch' in your path. If you have git installed on a Windows system, then patch is likely found in a sibling directory (.../Git/usr/bin/). Once you've verified these requirements, your cmake command line will change slightly to use nmake:
cmake -G "NMake Makefiles" `-DTARGET_ARCH=ANDROID` <other options> ..
Nmake builds targets in a serial fashion. To make things quicker, we recommend installing JOM as an alternative to nmake and then changing the cmake invocation to:
cmake -G "NMake Makefiles JOM" `-DTARGET_ARCH=ANDROID` <other options> ..
Building for Docker
To build for Docker, ensure your container meets the minimum requirements. By default, Docker Desktop is set to use 2 GB runtime memory. We have provided Dockerfiles as templates for building the SDK in a container.
Building and running an app on EC2
Checkout this walkthrough on how to set up an enviroment and build the AWS SDK for C++ on an EC2 instance.
Issues and Contributions
We welcome all kinds of contributions, check this guideline to learn how you can contribute or report issues.
Maintenance and support for SDK major versions
For information about maintenance and support for SDK major versions and our underlying dependencies, see the following in the AWS SDKs and Tools Shared Configuration and Credentials Reference Guide
The best way to interact with our team is through GitHub. You can open an issue and choose from one of our templates for guidance, bug reports, or feature requests. You may also find help on community resources such as StackOverFlow with the tag #aws-sdk-cpp or If you have a support plan with AWS Support, you can also create a new support case.
Please make sure to check out our resources too before opening an issue:
- Our Developer Guide and API reference
- Our Changelog for recent breaking changes.
- Our Contribute guide.
- Our samples repo.