ClientOptions.php 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. <?php
  2. /**
  3. * Copyright 2010-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License").
  6. * You may not use this file except in compliance with the License.
  7. * A copy of the License is located at
  8. *
  9. * http://aws.amazon.com/apache2.0
  10. *
  11. * or in the "license" file accompanying this file. This file is distributed
  12. * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  13. * express or implied. See the License for the specific language governing
  14. * permissions and limitations under the License.
  15. */
  16. namespace Aws\Common\Enum;
  17. use Aws\Common\Enum;
  18. /**
  19. * Contains enumerable default factory options that can be passed to a client's factory method
  20. */
  21. class ClientOptions extends Enum
  22. {
  23. /**
  24. * @var string AWS Access Key ID
  25. */
  26. const KEY = 'key';
  27. /**
  28. * @var string AWS secret access key
  29. */
  30. const SECRET = 'secret';
  31. /**
  32. * @var string You can optionally provide a custom `Aws\Common\Credentials\CredentialsInterface` object
  33. */
  34. const CREDENTIALS = 'credentials';
  35. /**
  36. * @var string Custom AWS security token to use with request authentication
  37. */
  38. const TOKEN = 'token';
  39. /**
  40. * @var string UNIX timestamp for when the custom credentials expire
  41. */
  42. const TOKEN_TTD = 'token.ttd';
  43. /**
  44. * @var string Used to cache credentials when using providers that require HTTP requests. Set the trueto use the
  45. * default APC cache or provide a `Guzzle\Cache\CacheAdapterInterface` object.
  46. */
  47. const CREDENTIALS_CACHE = 'credentials.cache';
  48. /**
  49. * @var string Optional custom cache key to use with the credentials
  50. */
  51. const CREDENTIALS_CACHE_KEY = 'credentials.cache.key';
  52. /**
  53. * @var string Pass this option to specify a custom `Guzzle\Http\ClientInterface` to use if your credentials require
  54. * a HTTP request (e.g. RefreshableInstanceProfileCredentials)
  55. */
  56. const CREDENTIALS_CLIENT = 'credentials.client';
  57. /**
  58. * @var string Region name (e.g. 'us-east-1', 'us-west-1', 'us-west-2', 'eu-west-1', etc...)
  59. */
  60. const REGION = 'region';
  61. /**
  62. * @var string URI Scheme of the base URL (e.g. 'https', 'http').
  63. */
  64. const SCHEME = 'scheme';
  65. /**
  66. * @var string Specify the name of the service
  67. */
  68. const SERVICE = 'service';
  69. /**
  70. * @var string Instead of using a `region` and `scheme`, you can specify a custom base URL for the client
  71. */
  72. const BASE_URL = 'base_url';
  73. /**
  74. * @var string You can optionally provide a custom signature implementation used to sign requests
  75. */
  76. const SIGNATURE = 'signature';
  77. /**
  78. * @var string Set to explicitly override the service name used in signatures
  79. */
  80. const SIGNATURE_SERVICE = 'signature.service';
  81. /**
  82. * @var string Set to explicitly override the region name used in signatures
  83. */
  84. const SIGNATURE_REGION = 'signature.region';
  85. /**
  86. * @var string Option key holding an exponential backoff plugin
  87. */
  88. const BACKOFF = 'client.backoff';
  89. /**
  90. * @var string `Guzzle\Log\LogAdapterInterface` object used to log backoff retries. Use 'debug' to emit PHP
  91. * warnings when a retry is issued.
  92. */
  93. const BACKOFF_LOGGER = 'client.backoff.logger';
  94. /**
  95. * @var string Optional template to use for exponential backoff log messages. See
  96. * `Guzzle\Plugin\Backoff\BackoffLogger` for formatting information.
  97. */
  98. const BACKOFF_LOGGER_TEMPLATE = 'client.backoff.logger.template';
  99. /**
  100. * @var string Set to true to use the bundled CA cert or pass the full path to an SSL certificate bundle. This
  101. * option should be modified when you encounter curl error code 60. Set to "system" to use the cacert
  102. * bundle on your system.
  103. */
  104. const SSL_CERT = 'ssl.certificate_authority';
  105. /**
  106. * @var string Service description to use with the client
  107. */
  108. const SERVICE_DESCRIPTION = 'service.description';
  109. /**
  110. * @var string Whether or not modeled responses have transformations applied to them
  111. */
  112. const MODEL_PROCESSING = 'command.model_processing';
  113. /**
  114. * @var bool Set to false to disable validation
  115. */
  116. const VALIDATION = 'validation';
  117. /**
  118. * @var string API version used by the client
  119. */
  120. const VERSION = 'version';
  121. }