Skip to content

Latest commit

 

History

History
168 lines (121 loc) · 9.9 KB

README.md

File metadata and controls

168 lines (121 loc) · 9.9 KB
Raw

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.11 is now Available!

This release introduces a refactored Asynchronous API and restructures the File Hierarchy of the project source code. Additionally, the minimum required version of cmake was raised to 3.13.

  • Asynchronous API refactoring is a partially breaking, backward incompatible change: all client methods such as OperationAsync and OperationCallable are no longer virtual methods but instead are conditionally compiled template methods. Having these methods as templates reduces the total binary size of the SDK by 40%. Individual client binary size may vary. In addition, it reduces build time of the SDK by up to 50% (release, unity build, SDK clients only). A code change may be required if your code inherits SDK’s Client classes and overrides the virtual async methods. Regular synchronous/blocking call methods are still available for override. Code changes are not required and SDK API are backward compatible if virtual async methods were not overwritten before.
  • Scripts and IDE project files not using the provided cmake build infrastructure must be reviewed and updated to reflect source tree changes.

All CRT libraries are git submodules of SDK for C++. It requires changes in git syntax to get all source code.

  • New users: If you haven't downloaded the source code for SDK for C++, you can get all git submodules recursively by: 
    git clone --recurse-submodules https://github.com/aws/aws-sdk-cpp
  • Existing users: If you’ve already downloaded source code for SDK for C++, e.g. in directory aws-sdk-cpp, you can update the git submodule by: 
    cd aws-sdk-cpp
git checkout main
git pull origin main
git submodule update --init --recursive
  • Alternatively, if you downloaded the code bundle from GitHub website and have no installation of git, you can download all the dependencies running the prefetch_crt_dependency.sh script from the root of the repository. It will download bundles of all dependencies from github website using curl and expand them in the right locations.

See Wiki page Improving S3 Throughput with AWS SDK for CPP v1.9 for more details, and create a new issue or pull request if you have any feedback on this new version.

API Reference Docs

The AWS SDK C++ recently re-formatted their API docs to be more modularized for easier navigation. Please update any old bookmarks that you may have.

The root index of the documents can be found at https://sdk.amazonaws.com/cpp/api/LATEST/index.html

from here each service specific documentation can be found under the modules tab. Upon opening one of these, you will see the associated class list of the client, including a links to the core module.

Upgrade Your SDK to Get Latest Security Patches

The AWS SDK for C++ has a dependency on cJSON. This dependency was updated to version 1.7.14 in the recent SDK updates. We would recommend to upgrade your SDK to version 1.9.67 for 1.9.x or 1.8.187 for 1.8.x. Thank @dkalinowski for reporting this issue: aws#1594

Jump To:

Getting Started

Building the SDK:

Minimum Requirements:

  • 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:

  1. Install CMake and the relevant build tools for your platform. Ensure these are available in your executable path.

  2. Create your build directory. Replace <BUILD_DIR> with your build directory name:

  3. Build the project:

    • For Auto Make build systems:
    cd <BUILD_DIR>
cmake <path-to-root-of-this-source-code> -DCMAKE_BUILD_TYPE=Debug -DCMAKE_PREFIX_PATH=<path-to-install>
make
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 -DCMAKE_PREFIX_PATH=<path-to-install>
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 -DCMAKE_PREFIX_PATH=<path-to-install>
xcodebuild -target ALL_BUILD

Other Dependencies:

To compile in Linux, you must have the header files for libcurl, libopenssl. The packages are typically available in your package manager.

Debian based Linux distributions example: sudo apt-get install libcurl-dev

RPM based Linux distributions example: sudo [yum|dnf|zypper] install libcurl-devel

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 walk through on how to set up an environment and build the AWS SDK for C++ on an EC2 instance.

Building aws-sdk-cpp - Using vcpkg

You can download and install aws-sdk-cpp using the vcpkg dependency manager:

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
./vcpkg install aws-sdk-cpp

The aws-sdk-cpp port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please create an issue or pull request on the vcpkg repository.

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

Getting Help

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. 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:

Using the SDK and Other Topics