Installation guide
)
)
);
If you prefer JSON syntax, you can define your configuration in JSON format instead of PHP.
{
"includes": ["_aws"],
"services": {
"default_settings": {
"params": {
"key": "your-aws-access-key-id",
"secret": "your-aws-secret-access-key",
"region": "us-west-2"
}
}
}
}
For more information about writing custom configuration files, please see Using the Service Builder in the Guzzle
documentation.
Client configuration options
Basic client configuration options include your key and secret credentials (see Providing Credentials to the SDK)
and a region (see Specifying a region). For typical use cases, you will not need to provide more than these 3
options. The following represents all of the possible client configuration options for service clients in the SDK.
Credentials Options
Options Description
key Your AWS access key ID. See AWS access keys.
secret Your AWS secret access key. See AWS access keys.
token An AWS security token to use with request authentication. Please note that not all
services accept temporary credentials. See
http://docs.aws.amazon.com/STS/latest/UsingSTS/UsingTokens.html.
token.ttd The UNIX timestamp for when the provided credentials expire.
credentials A credentials object (Aws\Common\Credentials\CredentialsInterface) can be
provided instead explicit access keys and tokens.
credentials.cache.keyOptional custom cache key to use with the credentials.
credentials.clientPass this option to specify a custom Guzzle\Http\ClientInterface to use if your
credentials require a HTTP request (e.g.
RefreshableInstanceProfileCredentials).
Endpoint and Signature Options
Options Description
region Region name (e.g., 'us-east-1', 'us-west-1', 'us-west-2', 'eu-west-1', etc.). See Specifying
a region.
scheme URI Scheme of the base URL (e.g.. 'https', 'http') used when base_url is not supplied.
base_url Allows you to specify a custom endpoint instead of have the SDK build one automatically
from the region and scheme.
signature Overrides the signature used by the client. Clients will always choose an appropriate
default signature. However, it can be useful to override this with a custom setting. This
can be set to "v4", "v3https", "v2" or an instance of
Aws\Common\Signature\SignatureInterface.
Configuring the SDK
27