Skip to content

Commit

Permalink
Update readme, remove sigv4a crt section (#3076)
Browse files Browse the repository at this point in the history
  • Loading branch information
alextwoods committed Jul 31, 2024
1 parent 770bb89 commit 10452d6
Showing 1 changed file with 1 addition and 21 deletions.
22 changes: 1 addition & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,30 +259,10 @@ Simply downcase the service module name for the helper:
The AWS SDK for Ruby has optional functionality that requires the
[AWS Common Runtime (CRT)](https://docs.aws.amazon.com/sdkref/latest/guide/common-runtime.html)
bindings to be included as a dependency with your application. This functionality includes:
* [Amazon S3 Multi-Region Access Points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPoints.html)
* CRC-32c support for [S3 Additional Checksums](https://aws.amazon.com/blogs/aws/new-additional-checksum-algorithms-for-amazon-s3/)

If the required AWS Common Runtime dependency is not installed you will receive an error
indicating that the required dependency is missing to use the associated functionality. To install this dependency follow
the provided [instructions](#installing-the-aws-common-runtime-crt-dependency).

### Installing the AWS Common Runtime (CRT) Dependency
AWS CRT bindings are in developer preview and are available in the
the [aws-crt](https://rubygems.org/gems/aws-crt/) gem. You can install them
by adding the `aws-crt` gem to your Gemfile.

[Sigv4a](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html)
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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPoints.html)
and Amazon EventBridge Global Endpoints.
Currently sigv4a requires the [aws-crt](https://rubygems.org/gems/aws-crt/) gem. The `aws-sigv4` signers
will automatically use the CRT provided signers with support for `sigv4a` when the `aws-crt` gem is available.

```ruby
gem 'aws-sdk-s3', '~> 1'
gem 'aws-sigv4', '1.4.1.crt'
```
the [aws-crt](https://rubygems.org/gems/aws-crt/) gem. You can install them by adding the `aws-crt` gem to your Gemfile.

## Getting Help

Expand Down

0 comments on commit 10452d6

Please sign in to comment.