https://github.com/lukewaite/laravel-aws-cache-adapter

Laravel Cache Adapter for AWS Credential Caching. Reduces calls to the EC2 metadata API.
https://github.com/lukewaite/laravel-aws-cache-adapter

aws aws-php-sdk iam laravel php

Last synced: about 2 months ago
JSON representation

Laravel Cache Adapter for AWS Credential Caching. Reduces calls to the EC2 metadata API.

• Host: GitHub
• URL: https://github.com/lukewaite/laravel-aws-cache-adapter
• Owner: lukewaite
• License: mit
• Created: 2017-04-29T13:45:01.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-02-13T19:33:08.000Z (almost 2 years ago)
• Last Synced: 2024-11-07T19:54:35.520Z (about 2 months ago)
• Topics: aws, aws-php-sdk, iam, laravel, php
• Language: PHP
• Homepage:
• Size: 15.6 KB
• Stars: 5
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# laravel-aws-cache-adapter

> Provides an `Aws\CacheInterface\CacheInterface` compliant cache for the

AWS SDK which uses the laravel Cache classes.

[![Latest Version on Packagist][ico-version]][link-packagist]

[![Software License][ico-license]](LICENSE.md)

[![Build Status][ico-travis]][link-travis]

[![Code Coverage][ico-coverage]][link-coverage]

### Purpose

When using EC2 Instance IAM Roles or ECS Task IAM Roles the AWS php sdk automatically performs

lookups against the ec2 metadata api (169.254.169.254) to get credentials. These by default

are not cached, and can occasionally be a source of trouble or slowdowns if the metadata api

is slow/not responding.

This package allows you to configure certain laravel filesystems to be automatically loaded

with a `CacheInterface` that will use a laravel cache store to cache the STS tokens returned,

reducing requests to the metadata api.

# Usage

### Direct Usage of the Adapter

The `LaravelCacheAdapter` can be passed directly into Flysystem in your `config/filesystems.php`

```

    's3' => [

        'driver'      => 's3',

        'base-path'   => 'https://s3.amazonaws.com',

        'credentials' => new LaravelCacheAdapter(app('cache'))

        'bucket'      => env('AWS_BUCKET'),

        'region'      => env('AWS_REGION', 'us-east-1'),

    ],

```

### Auto Insertion of the CredentialProvider via ServiceProvider

The default configuration settings are in `/config/laravel-aws-cache.php`. Copy this file to your

own config directory to modify the values. You can publish this config using this command:

```

$ php artisan vendor:publish --provider="LukeWaite\LaravelAwsCacheAdapter\ServiceProvider"

```

#### Configuration

```

return [

    /**

     * A comma separated list of filesystems defined in `config/filesystems.php` to which the

     * credential cache should be applied.

     */

    'filesystems' => env('LARAVEL_AWS_CACHE_FILESYSTEMS', null),

    /**

     * Whether or not to iterate through the `filesystems` defined and apply the credential cache.

     */

    'enable' => env('LARAVEL_AWS_CACHE_ENABLE', false),

    /**

     * The Laravel cache store defined in `config/cache.php` to use.

     */

    'cache' => env('LARAVEL_AWS_CACHE_CACHE', 'file')

];

```

[ico-version]: https://img.shields.io/packagist/v/lukewaite/laravel-aws-cache-adapter.svg?style=flat-square

[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square

[ico-travis]: https://img.shields.io/travis/lukewaite/laravel-aws-cache-adapter/master.svg?style=flat-square

[ico-coverage]: https://img.shields.io/scrutinizer/coverage/g/lukewaite/laravel-aws-cache-adapter/master.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/lukewaite/laravel-aws-cache-adapter

[link-travis]: https://travis-ci.org/lukewaite/laravel-aws-cache-adapter

[link-coverage]: https://scrutinizer-ci.com/g/lukewaite/laravel-aws-cache-adapter/?branch=master