aws-sdk-php-laravel

Install the package via Composer by adding aws/aws-sdk-php-laravel to your composer.json file and running composer update.

Registering the Provider

For Laravel

Add Aws\Laravel\AwsServiceProvider::class to the providers array in config/app.php.

To use the AWS facade, add Aws\Laravel\AwsFacade::class to the aliases array in config/app.php.

For Lumen

Register the provider in bootstrap/app.php using $app->register().

{
    "require": {
        "aws/aws-sdk-php-laravel": "~3.0"
    }
}

// Laravel: config/app.php
'providers' => array(
    // ...
    Aws\Laravel\AwsServiceProvider::class,
)

'aliases' => array(
    // ...
    'AWS' => Aws\Laravel\AwsFacade::class,
)

// Lumen: bootstrap/app.php
$app->register(Aws\Laravel\AwsServiceProvider::class);

The package automatically uses the following environment variables for configuration:

• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY
• AWS_REGION (defaults to us-east-1)

To customize settings or override specific services, publish the configuration file using Artisan:

php artisan vendor:publish --provider="Aws\Laravel\AwsServiceProvider"

This creates config/aws.php. You can define service-specific overrides (e.g., for Ses) within this file. If you prefer to use the AWS SDK default credential chain, you can remove the credentials key from the config file.

To customize your AWS configuration, you can publish the configuration file to your application's config directory. This is done using the aws-config tag.

Run the following Artisan command to publish the file:

php artisan vendor:publish --tag=aws-config

This will copy the configuration template to config/aws.php.

You can interact with AWS services by retrieving the AWS instance from the service container and calling createClient($serviceName).

Laravel (Service Container)

$s3 = App::make('aws')->createClient('s3');

Laravel (Facade)

If you registered the AWS alias in config/app.php:

$s3 = AWS::createClient('s3');

Lumen

$s3 = app('aws')->createClient('s3');

// Example: Uploading a file to S3 in Laravel
$s3 = AWS::createClient('s3');
$s3->putObject(array(
    'Bucket'     => 'YOUR_BUCKET',
    'Key'        => 'YOUR_OBJECT_KEY',
    'SourceFile' => '/the/path/to/the/file/you/are/uploading.ext',
));

The AwsServiceProvider registers the AWS SDK as a singleton in the Laravel service container. You can resolve the AWS SDK instance using the aws binding or the Aws\Sdk alias. This allows you to inject the SDK into your classes or resolve it via the app() helper.

When resolved, the SDK is instantiated using the configuration found under the aws key in your application's configuration files.