AWS SDK for OpenResty. The SDK is generated from the original AWS JavaScript repository details.

The documentation will mostly cover the specifics for this library, the actual services invoked are documented by AWS.

For a quick start on how to use this library checkout the examples of the AWS class.

This library is under early development. Not everything has been implemented, and testing is hard since it requires access to AWS resources and not just regular CI.

This library depends on global settings. Escpecially the core services for authentication and metadata. Many of those can (also) be specified as environment variables.

Hence it is recommended to populate the global confguration object at application start in the OpenResty init phase. Simply add the following line;

 local _ = require("resty.aws.config").global 

This ensures the environment variables can still be read (in the init phase). And the auto-detection of the AWS region will execute.

The endpoint for EC2 metadata can block (until timeout) if the SDK is used on a non-EC2 machine. In that case you might want to set the AWS_EC2_METADATA_DISABLED to a value different from false (which is the default).

 export AWS_EC2_METADATA_DISABLED=true 

Installation is easiest using LuaRocks:

luarocks install lua-resty-aws 

To install from the git repo:

git clone https://github.com/Kong/lua-resty-aws.git cd lua-resty-aws make install 

To update the SDK version being used edit the version tag in update_api_files.sh and then run:

make dev 

Make sure to run make dev to pull in the generated files. Documentation can be generated using ldoc by running:

make docs 

Note that distribution is a little more complex than desired. This is because the repo does not contain all the json files pulled in from the JS sdk. This in turn means that luarocks upload cannot build a rock from the repo (because it is incomplete after just being pulled).

To work around this the make pack command actually builds a .rock file that is compatible with LuaRocks. The make upload target will upload the generated rock.

See the detailed release instructions at History.

Tests are executed using Busted and LuaCheck:

busted luacheck . 

or run

make test 

• Implement the request/response objects (more AWS like, currently Lua modules)
• Implement additional signatures (only V4 currently)
• Implement retries from the global config
• Additional tests for other services

Copyright: (c) 2020-2021 Kong, Inc.

Author: Thijs Schreijer

License: Apache 2.0

Versioning is strictly based on Semantic Versioning (please note that in the pre-1.0 stage the API is not considered stable and can change at any time, and in any release, major, minor, and patch)

Release process:

1. update the changelog below
2. run make clean
3. run make dev
4. run make test
5. run make docs
6. commit, and tag the commit with the version x.y.z
7. push the commit and tag
8. run VERSION=x.y.z make pack
9. test the created .rock file
10. upload using: VERSION=x.y.z APIKEY=abc... make upload
11. test installing the rock from LuaRocks

• fix: better error handling when credential providers fail to load #22

• feat: socket compatibility; overriding luasocket use in phases now returns the existing setting

• feat: enable use of regional STS endpoints
• deps: bumped the lua-resty-http dependency to 0.16 to disable the warnings and use the better connection building logic.
• fix: added sock:settimeouts to the socket compatibility layer.
• feat: implement a config object based on AWS CLI configuration.
  • for most use cases it will now suffice to load the config in the init phase since it caches al predefined environment variables.
  • BREAKING: getting EC2 credentials will now honor AWS_EC2_METADATA_DISABLED. Behaviour might change, but is expected to be very rare.
  • BREAKING: The TokenFileWebIdentityCredentials will honor the role_session_name setting (file or env) as default name. Behaviour might change, but is expected to be very rare.

• feat: added TokenFileWebIdentityCredentials. This adds default IAM credentials to be picked up on EKS. The default AWS instance creates a CredentialProviderChain which includes TokenFileWebIdentity. So on EKS it will now pick up container based credentials instead of falling back to the underlying (more coarse) EC2 credentials.
• fix: for 'query' type calls, add target action and version, which are required
• fix: allow for unsigned requests for services requiring that (STS)
• fix: do not validate patterns as regexes are incompatible

• feat: capability to fetch metadata for ECS tasks (EC2 & Fargate), versions 2, 3, and 4
• feat: capability to fetch IMDS metadata (EC2 & EKS), versions 1, and 2
• feat: automatic region detection, check the docs for details (utils module)
• fix: EC2MetadataCredentials no longer reuses the http-client to prevent issues with the underlying compatibility layer.

• fix: rockspec, add Penlight dependency
• fix: add proper json Content-Type header from meta-data
• fix: use proper signingName for the signature