awslabs / aws-crt-ruby Goto Github PK

AWS Common Runtime for Ruby

Links of Interest

• AWS Common Run Time

Installation

AWS CRT bindings are in developer preview and are available from RubyGems as the aws-crt gem. You can install them by adding the aws-crt gem to your Gemfile.

Sigv4a is an extension to Sigv4 that allows signatures that are valid in more than one region. Sigv4a is required to use some services/operations such as S3 Multi-Region Access Points. Currently sigv4a requires the aws-crt gem and a version of the aws-sigv4 gem built on top of aws-crt (at least version 1.5.0):

gem 'aws-sdk-s3', '~> 1'
gem 'aws-sigv4', '~> 1' # must be at least 1.5.0
gem 'aws-crt'

Versioning

This project uses semantic versioning. You can safely express a dependency on a major version and expect all minor and patch versions to be backwards compatible.

A CHANGELOG can be found at each gem's root path (i.e. aws-crt can be found at gems/aws-crt/CHANGELOG.md). The CHANGELOG is also accessible via the RubyGems.org page under "LINKS" section.

Maintenance and support for SDK major versions

For information about maintenance and support for SDK major versions and their underlying dependencies, see the following in the AWS SDKs and Tools Shared Configuration and Credentials Reference Guide:

• AWS SDKs and Tools Maintenance Policy

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.