151 lines
4.5 KiB
PHP
151 lines
4.5 KiB
PHP
<?php
|
|
/**
|
|
* Copyright 2010-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License").
|
|
* You may not use this file except in compliance with the License.
|
|
* A copy of the License is located at
|
|
*
|
|
* http://aws.amazon.com/apache2.0
|
|
*
|
|
* or in the "license" file accompanying this file. This file is distributed
|
|
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
|
|
* express or implied. See the License for the specific language governing
|
|
* permissions and limitations under the License.
|
|
*/
|
|
|
|
namespace Aws\Common\Enum;
|
|
|
|
use Aws\Common\Enum;
|
|
|
|
/**
|
|
* Contains enumerable default factory options that can be passed to a client's factory method
|
|
*/
|
|
class ClientOptions extends Enum
|
|
{
|
|
/**
|
|
* @var string AWS Access Key ID
|
|
*/
|
|
const KEY = 'key';
|
|
|
|
/**
|
|
* @var string AWS secret access key
|
|
*/
|
|
const SECRET = 'secret';
|
|
|
|
/**
|
|
* @var string You can optionally provide a custom `Aws\Common\Credentials\CredentialsInterface` object
|
|
*/
|
|
const CREDENTIALS = 'credentials';
|
|
|
|
/**
|
|
* @var string Name of a credential profile to read from your ~/.aws/credentials file
|
|
*/
|
|
const PROFILE = 'profile';
|
|
|
|
/**
|
|
* @var string Custom AWS security token to use with request authentication
|
|
*/
|
|
const TOKEN = 'token';
|
|
|
|
/**
|
|
* @var string UNIX timestamp for when the custom credentials expire
|
|
*/
|
|
const TOKEN_TTD = 'token.ttd';
|
|
|
|
/**
|
|
* @var string Used to cache credentials when using providers that require HTTP requests. Set the trueto use the
|
|
* default APC cache or provide a `Guzzle\Cache\CacheAdapterInterface` object.
|
|
*/
|
|
const CREDENTIALS_CACHE = 'credentials.cache';
|
|
|
|
/**
|
|
* @var string Optional custom cache key to use with the credentials
|
|
*/
|
|
const CREDENTIALS_CACHE_KEY = 'credentials.cache.key';
|
|
|
|
/**
|
|
* @var string Pass this option to specify a custom `Guzzle\Http\ClientInterface` to use if your credentials require
|
|
* a HTTP request (e.g. RefreshableInstanceProfileCredentials)
|
|
*/
|
|
const CREDENTIALS_CLIENT = 'credentials.client';
|
|
|
|
/**
|
|
* @var string Region name (e.g. 'us-east-1', 'us-west-1', 'us-west-2', 'eu-west-1', etc...)
|
|
*/
|
|
const REGION = 'region';
|
|
|
|
/**
|
|
* @var string URI Scheme of the base URL (e.g. 'https', 'http').
|
|
*/
|
|
const SCHEME = 'scheme';
|
|
|
|
/**
|
|
* @var string Specify the name of the service
|
|
*/
|
|
const SERVICE = 'service';
|
|
|
|
/**
|
|
* @var string Instead of using a `region` and `scheme`, you can specify a custom base URL for the client
|
|
*/
|
|
const BASE_URL = 'base_url';
|
|
|
|
/**
|
|
* @var string You can optionally provide a custom signature implementation used to sign requests
|
|
*/
|
|
const SIGNATURE = 'signature';
|
|
|
|
/**
|
|
* @var string Set to explicitly override the service name used in signatures
|
|
*/
|
|
const SIGNATURE_SERVICE = 'signature.service';
|
|
|
|
/**
|
|
* @var string Set to explicitly override the region name used in signatures
|
|
*/
|
|
const SIGNATURE_REGION = 'signature.region';
|
|
|
|
/**
|
|
* @var string Option key holding an exponential backoff plugin
|
|
*/
|
|
const BACKOFF = 'client.backoff';
|
|
|
|
/**
|
|
* @var string `Guzzle\Log\LogAdapterInterface` object used to log backoff retries. Use 'debug' to emit PHP
|
|
* warnings when a retry is issued.
|
|
*/
|
|
const BACKOFF_LOGGER = 'client.backoff.logger';
|
|
|
|
/**
|
|
* @var string Optional template to use for exponential backoff log messages. See
|
|
* `Guzzle\Plugin\Backoff\BackoffLogger` for formatting information.
|
|
*/
|
|
const BACKOFF_LOGGER_TEMPLATE = 'client.backoff.logger.template';
|
|
|
|
/**
|
|
* @var string Set to true to use the bundled CA cert or pass the full path to an SSL certificate bundle. This
|
|
* option should be modified when you encounter curl error code 60. Set to "system" to use the cacert
|
|
* bundle on your system.
|
|
*/
|
|
const SSL_CERT = 'ssl.certificate_authority';
|
|
|
|
/**
|
|
* @var string Service description to use with the client
|
|
*/
|
|
const SERVICE_DESCRIPTION = 'service.description';
|
|
|
|
/**
|
|
* @var string Whether or not modeled responses have transformations applied to them
|
|
*/
|
|
const MODEL_PROCESSING = 'command.model_processing';
|
|
|
|
/**
|
|
* @var bool Set to false to disable validation
|
|
*/
|
|
const VALIDATION = 'validation';
|
|
|
|
/**
|
|
* @var string API version used by the client
|
|
*/
|
|
const VERSION = 'version';
|
|
}
|