Class: AWS::Core::Configuration
- Inherits:
-
Object
- Object
- AWS::Core::Configuration
- Defined in:
- lib/aws/core/configuration.rb
Overview
A configuration object for AWS interfaces and clients.
Configuring Credential
In order to do anything with AWS you will need to assign credentials. The simplest method is to assing your credentials into the default configuration:
AWS.config(:access_key_id => 'KEY', :secret_access_key => 'SECRET')
You can also export them into your environment and they will be picked up automatically:
export AWS_ACCESS_KEY_ID='YOUR_KEY_ID_HERE'
export AWS_SECRET_ACCESS_KEY='YOUR_SECRET_KEY_HERE'
For compatability with other AWS gems, the credentials can also be exported like:
export AMAZON_ACCESS_KEY_ID='YOUR_KEY_ID_HERE'
export AMAZON_SECRET_ACCESS_KEY='YOUR_SECRET_KEY_HERE'
Modifying a Configuration
Configuration objects are read-only. If you need a different set of configuration values, call #with, passing in the updates and a new configuration object will be returned.
config = Configuration.new(:max_retires => 3)
new_config = config.with(:max_retries => 2)
config.max_retries #=> 3
new_config.max_retries #=> 2
Global Configuration
The global default configuration can be found at AWS.config
Instance Attribute Summary collapse
-
#access_key_id ⇒ String?
readonly
AWS access key id credential.
-
#ec2_endpoint ⇒ String
readonly
The service endpoint for Amazon EC2.
-
#http_handler ⇒ Object
readonly
The http handler that sends requests to AWS.
-
#iam_endpoint ⇒ String
readonly
The service endpoint for AWS Idenity Access Management (IAM).
-
#logger ⇒ Object?
readonly
A logger instance that should receive log messages generated by service requets.
-
#max_retries ⇒ Integer
readonly
The maximum number of times service errors (500) should be retried.
-
#proxy_uri ⇒ String, ...
readonly
The URI of the proxy to send service requests through.
-
#s3_endpoint ⇒ String
readonly
The service endpoint for Amazon S3.
-
#s3_multipart_max_parts ⇒ Integer
readonly
The maximum number of parts to split a file into when uploading in parts to S3.
-
#s3_multipart_min_part_size ⇒ Integer
readonly
The absolute minimum size (in bytes) each S3 multipart segment should be.
-
#s3_multipart_threshold ⇒ Integer
readonly
(16777216) When uploading data to S3, if the number of bytes to send exceedes
:s3_multipart_threshold
then a multi part session is automatically started and the data is sent up in chunks. -
#s3_server_side_encryption ⇒ Symbol
readonly
The algorithm to use when encrypting object data on the server side.
-
#secret_access_key ⇒ String?
readonly
AWS secret access key credential.
-
#session_token ⇒ String?
readonly
AWS secret token credential.
-
#signer ⇒ Object
readonly
The request signer.
-
#simple_db_consistent_reads ⇒ Boolean
readonly
Determines if all SimpleDB read requests should be done consistently.
-
#simple_db_endpoint ⇒ String
readonly
The service endpoint for Amazon SimpleDB.
-
#simple_email_service_endpoint ⇒ String
readonly
The service endpoint for Amazon Simple Email Service.
-
#sns_endpoint ⇒ String
readonly
The service endpoint for Amazon SNS.
-
#sqs_endpoint ⇒ String
readonly
The service endpoint for Amazon SQS.
-
#ssl_ca_file ⇒ String
readonly
The path to a CA cert bundle in PEM format.
-
#ssl_verify_peer ⇒ Boolean
readonly
When
true
the HTTP handler validate server certificates for HTTPS requests. -
#sts_endpoint ⇒ String
readonly
The service endpoint for AWS Security Token Service.
-
#stub_requests ⇒ Boolean
readonly
When
true
requests are not sent to AWS, instead empty reponses are generated and returned to each service request. -
#use_ssl ⇒ Boolean
readonly
When
true
, all requests to AWS are sent using HTTPS instead vanilla HTTP. -
#user_agent_prefix ⇒ String
readonly
A string prefix to append to all requets against AWS services.
Class Method Summary collapse
Instance Method Summary collapse
-
#==(other) ⇒ Boolean
(also: #eql)
Returns true if the two configuration objects have the same values.
-
#initialize(options = {}) ⇒ Configuration
constructor
Creates a new Configuration object.
-
#to_h ⇒ Hash
Returns a hash of all configuration values.
-
#with(options = {}) ⇒ Configuration
Used to create a new Configuration object with the given modifications.
Constructor Details
#initialize(options = {}) ⇒ Configuration
Creates a new Configuration object.
190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/aws/core/configuration.rb', line 190 def initialize = {} @created = .delete(:__created__) || {} .each_pair do |opt_name, value| opt_name = opt_name.to_sym if self.class..include?(opt_name) supplied[opt_name] = value end end end |
Instance Attribute Details
#access_key_id ⇒ String? (readonly)
AWS access key id credential. Defaults to nil
.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def access_key_id @access_key_id end |
#ec2_endpoint ⇒ String (readonly)
The service endpoint for Amazon EC2. Defaults to ‘ec2.amazonaws.com’.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def ec2_endpoint @ec2_endpoint end |
#http_handler ⇒ Object (readonly)
The http handler that sends requests to AWS. Defaults to an HTTP handler built on net/http.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def http_handler @http_handler end |
#iam_endpoint ⇒ String (readonly)
The service endpoint for AWS Idenity Access Management (IAM). Defaults to ‘iam.amazonaws.com’.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def iam_endpoint @iam_endpoint end |
#logger ⇒ Object? (readonly)
A logger instance that should receive log messages generated by service requets.
A logger needs to respond to #log and must accept a severity (e.g. :info, :error, etc) and a string message. Defaults to nil
.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def logger @logger end |
#max_retries ⇒ Integer (readonly)
The maximum number of times service errors (500) should be retried. There is an exponential backoff in between service request retries, so the more retries the longer it can take to fail. Defautls to 3.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def max_retries @max_retries end |
#proxy_uri ⇒ String, ... (readonly)
The URI of the proxy to send service requests through. You can pass a URI object or a URI string. Defautls to nil
.
AWS.config(:proxy_uri => 'https://user:[email protected]:443/path?query')
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def proxy_uri @proxy_uri end |
#s3_endpoint ⇒ String (readonly)
The service endpoint for Amazon S3. Defaults to ‘s3.amazonaws.com’.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def s3_endpoint @s3_endpoint end |
#s3_multipart_max_parts ⇒ Integer (readonly)
The maximum number of parts to split a file into when uploading in parts to S3.
Defaults to 1000.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def s3_multipart_max_parts @s3_multipart_max_parts end |
#s3_multipart_min_part_size ⇒ Integer (readonly)
The absolute minimum size (in bytes) each S3 multipart segment should be. Defaults to 5242880 (5MB).
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def s3_multipart_min_part_size @s3_multipart_min_part_size end |
#s3_multipart_threshold ⇒ Integer (readonly)
(16777216) When uploading data to S3, if the number of bytes to send exceedes :s3_multipart_threshold
then a multi part session is automatically started and the data is sent up in chunks. The size of each part is specified by :s3_multipart_min_part_size
. Defaults to 16777216 (16MB).
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def s3_multipart_threshold @s3_multipart_threshold end |
#s3_server_side_encryption ⇒ Symbol (readonly)
The algorithm to use when encrypting object data on the server side. The only valid value is :aes256
, which specifies that the object should be stored using the AES encryption algorithm with 256 bit keys. Defaults to nil
, meaning server side encryption is not used unless specified on each individual call to upload an object. This option controls the default behavior for the following method:
You can construct an interface to Amazon S3 which always stores data using server side encryption as follows:
s3 = AWS::S3.new(:s3_server_side_encryption => :aes256)
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def s3_server_side_encryption @s3_server_side_encryption end |
#secret_access_key ⇒ String? (readonly)
AWS secret access key credential. Defaults to nil
.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def secret_access_key @secret_access_key end |
#session_token ⇒ String? (readonly)
AWS secret token credential. Defaults to nil
.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def session_token @session_token end |
#signer ⇒ Object (readonly)
The request signer. Defaults to a default request signer implementation.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def signer @signer end |
#simple_db_consistent_reads ⇒ Boolean (readonly)
Determines if all SimpleDB read requests should be done consistently. Consistent reads are slower, but reflect all changes to SDB. Defaults to false
.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def simple_db_consistent_reads @simple_db_consistent_reads end |
#simple_db_endpoint ⇒ String (readonly)
The service endpoint for Amazon SimpleDB. Defaults to ‘sdb.amazonaws.com’.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def simple_db_endpoint @simple_db_endpoint end |
#simple_email_service_endpoint ⇒ String (readonly)
The service endpoint for Amazon Simple Email Service. Defaults to ‘email.us-east-1.amazonaws.com’.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def simple_email_service_endpoint @simple_email_service_endpoint end |
#sns_endpoint ⇒ String (readonly)
The service endpoint for Amazon SNS. Defaults to ‘sns.us-east-1.amazonaws.com’.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def sns_endpoint @sns_endpoint end |
#sqs_endpoint ⇒ String (readonly)
The service endpoint for Amazon SQS. Defaults to ‘sqs.us-east-1.amazonaws.com’.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def sqs_endpoint @sqs_endpoint end |
#ssl_ca_file ⇒ String (readonly)
The path to a CA cert bundle in PEM format.
If ssl_verify_peer
is true (the default) this bundle will be used to validate the server certificate in each HTTPS request. The AWS SDK for Ruby ships with a CA cert bundle, which is the default value for this option.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def ssl_ca_file @ssl_ca_file end |
#ssl_verify_peer ⇒ Boolean (readonly)
When true
the HTTP handler validate server certificates for HTTPS requests. Defaults to true
.
This option should only be disabled for diagnostic purposes; leaving this option set to false
exposes your application to man-in-the-middle attacks and can pose a serious security risk.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def ssl_verify_peer @ssl_verify_peer end |
#sts_endpoint ⇒ String (readonly)
The service endpoint for AWS Security Token Service. Defaults to ‘sts.amazonaws.com’.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def sts_endpoint @sts_endpoint end |
#stub_requests ⇒ Boolean (readonly)
When true
requests are not sent to AWS, instead empty reponses are generated and returned to each service request.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def stub_requests @stub_requests end |
#use_ssl ⇒ Boolean (readonly)
When true
, all requests to AWS are sent using HTTPS instead vanilla HTTP. Defaults to true
.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def use_ssl @use_ssl end |
#user_agent_prefix ⇒ String (readonly)
A string prefix to append to all requets against AWS services. This should be set for clients and applications built ontop of the aws-sdk gem. Defaults to nil
.
185 186 187 |
# File 'lib/aws/core/configuration.rb', line 185 def user_agent_prefix @user_agent_prefix end |
Class Method Details
.add_service(name, ruby_name, default_endpoint) ⇒ Object
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/aws/core/configuration.rb', line 311 def add_service name, ruby_name, default_endpoint create_block = lambda do |config| AWS.const_get(name)::Client.new(:config => config) end needs = [ :signer, :http_handler, :"#{ruby_name}_endpoint", :max_retries, :stub_requests?, :proxy_uri, :use_ssl?, :ssl_verify_peer?, :ssl_ca_file, :user_agent_prefix, :logger, :logger_truncate_strings_at, ] add_option :"#{ruby_name}_endpoint", default_endpoint add_option_with_needs :"#{ruby_name}_client", needs, &create_block end |
Instance Method Details
#==(other) ⇒ Boolean Also known as: eql
Returns true if the two configuration objects have the same values.
248 249 250 |
# File 'lib/aws/core/configuration.rb', line 248 def == other other.is_a?(self.class) and self.supplied == other.supplied end |
#to_h ⇒ Hash
Returns a hash of all configuration values.
239 240 241 242 243 244 |
# File 'lib/aws/core/configuration.rb', line 239 def to_h self.class..inject({}) do |h,k| h[k] = send(k) h end end |
#with(options = {}) ⇒ Configuration
Used to create a new Configuration object with the given modifications. The current configuration object is not modified.
AWS.config(:max_retries => 2)
no_retries_config = AWS.config.with(:max_retries => 0)
AWS.config.max_retries #=> 2
no_retries_config.max_retries #=> 0
You can use these configuration objects returned by #with to create AWS objects:
AWS::S3.new(:config => no_retries_config)
AWS::SQS.new(:config => no_retries_config)
223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/aws/core/configuration.rb', line 223 def with = {} # symbolize option keys = .inject({}) {|h,kv| h[kv.first.to_sym] = kv.last; h } values = supplied.merge() if supplied == values self # nothing changed else self.class.new(values.merge(:__created__ => @created.dup)) end end |