oasis/aws-wrappers

v2.10.0 2017-11-16 13:26 UTC

README

The oasis/aws-wrappers component provides a collection of object oriented warppers for Amazon's official aws/aws-php-sdk.

Features

  • Only a limited number of widely used AWS services are wrapped.
  • One purpose of using the wrapper class is to avoid having to remember too many string constants in AWS SDK.
  • The wrapper classes provides simple-and-clear interface by sacrificing many advnaced feature of the original SDK.
  • The wrapper classes are extendable, and it is appreciated if you can help extend the wrappers' functionalities.

Installation

The oasis/aws-wrappers is an open-source component available at packagist.org. To require the package, try the following in your project directory:

composer require oasis/aws-wrappers

Prerequisite

Credentials

Because oasis/aws-wrappers is only a wrapper on top of aws/aws-php-sdk, it relies on the official SDK to authenticate client credentials. Please refer to the official documentation to find out how you specify credentials to the SDK

The most commonly used credential supplying method is to use the Profile. You will need to setup a correct AWS profile as instructed below:

Please prepare your ~/.aws/credentials file with permission 600 and content like below:

[tester]
aws_access_key_id = <YOUR AWS ACCESS KEY>
aws_secret_access_key = <YOUR AWS SECRET>

After that, you can specify the profile name when constructing a wrapped client object, e.g. "profile" => "tester"

NOTE: you may also use the "credentials" parameter to make use of other authentication/authorization methods

NOTE: if your project runs on an EC2 server and use the IAM role of the EC2 server as authentication method, you can specify "iamrole" => true instead of giving "profile" or "credentials"

Policy Permission

When using AWS SDK, one thing that is overlooked most of the time is the policy permission. You will have to visit the AWS IAM console to attach correct policy to your IAM account used in the profile setup. Detailed discussion on how to setup a correct policy using policy generator can be found here.

Service Wrappers