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 Credentials
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
(nil) AWS access key id credential.
-
#auto_scaling_endpoint ⇒ String
readonly
(‘autoscaling.us-east-1.amazonaws.com’) The service endpoint for Auto Scaling.
-
#cloud_formation_endpoint ⇒ String
readonly
(‘cloudformation.us-east-1.amazonaws.com’) The service endpoint for AWS CloudFormation.
-
#credential_provider ⇒ CredentialProvider::Provider
readonly
Returns the object that is responsible for loading credentials.
-
#dynamo_db_endpoint ⇒ String
readonly
(‘dynamodb.us-east-1.amazonaws.com’) The service endpoint for Amazon DynamoDB.
-
#dynamo_db_retry_throughput_errors ⇒ String
readonly
(true) When true, AWS::DynamoDB::Errors::ProvisionedThroughputExceededException errors will be retried.
-
#ec2_endpoint ⇒ String
readonly
(‘ec2.amazonaws.com’) The service endpoint for Amazon EC2.
-
#elb_endpoint ⇒ String
readonly
(‘elasticloadbalancing.us-east-1.amazonaws.com’) The service endpoint for Elastic Load Balancing.
-
#http_handler ⇒ Object
readonly
The http handler that sends requests to AWS.
-
#http_idle_timeout ⇒ Integer
readonly
The number of seconds a persistent connection is allowed to sit idle before it should no longer be used.
-
#http_open_timeout ⇒ Integer
readonly
The number of seconds before the
http_handler
should timeout while trying to open a new HTTP sesssion. -
#http_read_timeout ⇒ Integer
readonly
The number of seconds before the
http_handler
should timeout while waiting for a HTTP response. -
#http_wire_trace ⇒ Boolean
readonly
When
true
, the http handler will log all wire traces to the:logger
. -
#iam_endpoint ⇒ String
readonly
(‘iam.amazonaws.com’) The service endpoint for AWS Idenity Access Management (IAM).
-
#log_formatter ⇒ LogFormatter
readonly
The log message formatter.
-
#log_level ⇒ Symbol
readonly
(:info) The log level.
-
#logger ⇒ Logger?
readonly
(nil) The logging interface.
-
#max_retries ⇒ Integer
readonly
(3) The maximum number of times service errors (500) should be retried.
-
#proxy_uri ⇒ URI?
readonly
(nil) The URI of the proxy to send service requests through.
-
#route_53_endpoint ⇒ URI?
readonly
(‘route53.amazonaws.com’) The service endpoint for Amazon Route 53.
-
#s3_endpoint ⇒ String
readonly
(‘s3.amazonaws.com’) The service endpoint for Amazon S3.
-
#s3_force_path_style ⇒ Boolean
readonly
(false) When
true
, requests will always use path style. -
#s3_multipart_max_parts ⇒ Integer
readonly
(1000) The maximum number of parts to split a file into when uploading in parts to S3.
-
#s3_multipart_min_part_size ⇒ Integer
readonly
(5242880) The absolute minimum size (in bytes) each S3 multipart segment should be defaults to 5242880 (5MB).
-
#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
(nil) AWS secret access key credential.
-
#session_token ⇒ String?
readonly
(nil) AWS secret token credential.
-
#simple_db_consistent_reads ⇒ Boolean
readonly
(false) Determines if all SimpleDB read requests should be done consistently.
-
#simple_db_endpoint ⇒ String
readonly
(‘sdb.amazonaws.com’) The service endpoint for Amazon SimpleDB.
-
#simple_email_service_endpoint ⇒ String
readonly
(‘email.us-east-1.amazonaws.com’) The service endpoint for Amazon Simple Email Service.
-
#simple_workflow_endpoint ⇒ String
readonly
(‘swf.us-east-1.amazonaws.com’) The service endpoint for Amazon Simple Workflow Service.
-
#sns_endpoint ⇒ String
readonly
(‘sns.us-east-1.amazonaws.com’) The service endpoint for Amazon SNS.
-
#sqs_endpoint ⇒ String
readonly
(‘sqs.us-east-1.amazonaws.com’) The service endpoint for Amazon SQS.
-
#ssl_ca_file ⇒ String
readonly
The path to a CA cert bundle in PEM format.
-
#ssl_ca_path ⇒ String
readonly
(nil) The path the a CA cert directory.
-
#ssl_verify_peer ⇒ Boolean
readonly
(true) When
true
the HTTP handler validate server certificates for HTTPS requests. -
#sts_endpoint ⇒ String
readonly
(‘sts.amazonaws.com’) The service endpoint for AWS Security Token Service.
-
#stub_requests ⇒ Boolean
readonly
(false) When
true
requests are not sent to AWS, instead empty reponses are generated and returned to each service request. -
#use_ssl ⇒ Boolean
readonly
(true) When
true
, all requests to AWS are sent using HTTPS instead vanilla HTTP. -
#user_agent_prefix ⇒ String
readonly
(nil) A string prefix to append to all requets against AWS services.
Class Method Summary collapse
Instance Method Summary collapse
-
#credentials ⇒ Hash
Returns a hash with your configured credentials.
-
#eql?(other) ⇒ Boolean
(also: #==)
Returns true if the two configuration objects have the same values.
-
#initialize(options = {}) ⇒ Configuration
constructor
Creates a new Configuration object.
-
#to_h ⇒ Hash
(also: #to_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.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
# File 'lib/aws/core/configuration.rb', line 226 def initialize = {} @created = .delete(:__created__) || {} # :signer is now a deprecated option, this ensures it will still # work, but its now prefered to set :credential_provider instead. # Credentail providers don't have to provide a #sign method. if signer = .delete(:signer) [:credential_provider] = signer end .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)
(nil) AWS access key id credential.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def access_key_id @access_key_id end |
#auto_scaling_endpoint ⇒ String (readonly)
(‘autoscaling.us-east-1.amazonaws.com’) The service endpoint for Auto Scaling.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def auto_scaling_endpoint @auto_scaling_endpoint end |
#cloud_formation_endpoint ⇒ String (readonly)
(‘cloudformation.us-east-1.amazonaws.com’) The service endpoint for AWS CloudFormation.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def cloud_formation_endpoint @cloud_formation_endpoint end |
#credential_provider ⇒ CredentialProvider::Provider (readonly)
Returns the object that is responsible for loading credentials.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def credential_provider @credential_provider end |
#dynamo_db_endpoint ⇒ String (readonly)
(‘dynamodb.us-east-1.amazonaws.com’) The service endpoint for Amazon DynamoDB.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def dynamo_db_endpoint @dynamo_db_endpoint end |
#dynamo_db_retry_throughput_errors ⇒ String (readonly)
(true) When true, AWS::DynamoDB::Errors::ProvisionedThroughputExceededException errors will be retried.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def dynamo_db_retry_throughput_errors @dynamo_db_retry_throughput_errors end |
#ec2_endpoint ⇒ String (readonly)
(‘ec2.amazonaws.com’) The service endpoint for Amazon EC2.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def ec2_endpoint @ec2_endpoint end |
#elb_endpoint ⇒ String (readonly)
(‘elasticloadbalancing.us-east-1.amazonaws.com’) The service endpoint for Elastic Load Balancing.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def elb_endpoint @elb_endpoint end |
#http_handler ⇒ Object (readonly)
The http handler that sends requests to AWS. Defaults to an HTTP handler built on net/http.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def http_handler @http_handler end |
#http_idle_timeout ⇒ Integer (readonly)
The number of seconds a persistent connection is allowed to sit idle before it should no longer be used.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def http_idle_timeout @http_idle_timeout end |
#http_open_timeout ⇒ Integer (readonly)
The number of seconds before the http_handler
should timeout while trying to open a new HTTP sesssion.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def http_open_timeout @http_open_timeout end |
#http_read_timeout ⇒ Integer (readonly)
The number of seconds before the http_handler
should timeout while waiting for a HTTP response.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def http_read_timeout @http_read_timeout end |
#http_wire_trace ⇒ Boolean (readonly)
When true
, the http handler will log all wire traces to the :logger
. If a :logger
is not configured, then wire traces will be sent to standard out.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def http_wire_trace @http_wire_trace end |
#iam_endpoint ⇒ String (readonly)
(‘iam.amazonaws.com’) The service endpoint for AWS Idenity Access Management (IAM).
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def iam_endpoint @iam_endpoint end |
#log_formatter ⇒ LogFormatter (readonly)
The log message formatter.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def log_formatter @log_formatter end |
#log_level ⇒ Symbol (readonly)
(:info) The log level.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def log_level @log_level end |
#logger ⇒ Logger? (readonly)
(nil) The logging interface.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def logger @logger end |
#max_retries ⇒ Integer (readonly)
(3) 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.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def max_retries @max_retries end |
#proxy_uri ⇒ URI? (readonly)
(nil) The URI of the proxy to send service requests through.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def proxy_uri @proxy_uri end |
#route_53_endpoint ⇒ URI? (readonly)
(‘route53.amazonaws.com’) The service endpoint for Amazon Route 53.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def route_53_endpoint @route_53_endpoint end |
#s3_endpoint ⇒ String (readonly)
(‘s3.amazonaws.com’) The service endpoint for Amazon S3.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def s3_endpoint @s3_endpoint end |
#s3_force_path_style ⇒ Boolean (readonly)
(false) When true
, requests will always use path style. This can be useful for testing environments.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def s3_force_path_style @s3_force_path_style end |
#s3_multipart_max_parts ⇒ Integer (readonly)
(1000) The maximum number of parts to split a file into when uploading in parts to S3.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def s3_multipart_max_parts @s3_multipart_max_parts end |
#s3_multipart_min_part_size ⇒ Integer (readonly)
(5242880) The absolute minimum size (in bytes) each S3 multipart segment should be defaults to 5242880 (5MB).
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 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).
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 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)
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def s3_server_side_encryption @s3_server_side_encryption end |
#secret_access_key ⇒ String? (readonly)
(nil) AWS secret access key credential.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def secret_access_key @secret_access_key end |
#session_token ⇒ String? (readonly)
(nil) AWS secret token credential.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def session_token @session_token end |
#simple_db_consistent_reads ⇒ Boolean (readonly)
(false) Determines if all SimpleDB read requests should be done consistently. Consistent reads are slower, but reflect all changes to SDB.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def simple_db_consistent_reads @simple_db_consistent_reads end |
#simple_db_endpoint ⇒ String (readonly)
(‘sdb.amazonaws.com’) The service endpoint for Amazon SimpleDB.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def simple_db_endpoint @simple_db_endpoint end |
#simple_email_service_endpoint ⇒ String (readonly)
(‘email.us-east-1.amazonaws.com’) The service endpoint for Amazon Simple Email Service.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def simple_email_service_endpoint @simple_email_service_endpoint end |
#simple_workflow_endpoint ⇒ String (readonly)
(‘swf.us-east-1.amazonaws.com’) The service endpoint for Amazon Simple Workflow Service.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def simple_workflow_endpoint @simple_workflow_endpoint end |
#sns_endpoint ⇒ String (readonly)
(‘sns.us-east-1.amazonaws.com’) The service endpoint for Amazon SNS.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def sns_endpoint @sns_endpoint end |
#sqs_endpoint ⇒ String (readonly)
(‘sqs.us-east-1.amazonaws.com’) The service endpoint for Amazon SQS.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 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.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def ssl_ca_file @ssl_ca_file end |
#ssl_ca_path ⇒ String (readonly)
(nil) The path the a CA cert directory.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def ssl_ca_path @ssl_ca_path end |
#ssl_verify_peer ⇒ Boolean (readonly)
(true) When true
the HTTP handler validate server certificates for HTTPS requests.
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.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def ssl_verify_peer @ssl_verify_peer end |
#sts_endpoint ⇒ String (readonly)
(‘sts.amazonaws.com’) The service endpoint for AWS Security Token Service.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def sts_endpoint @sts_endpoint end |
#stub_requests ⇒ Boolean (readonly)
(false) When true
requests are not sent to AWS, instead empty reponses are generated and returned to each service request.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def stub_requests @stub_requests end |
#use_ssl ⇒ Boolean (readonly)
(true) When true
, all requests to AWS are sent using HTTPS instead vanilla HTTP.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def use_ssl @use_ssl end |
#user_agent_prefix ⇒ String (readonly)
(nil) 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.
221 222 223 |
# File 'lib/aws/core/configuration.rb', line 221 def user_agent_prefix @user_agent_prefix end |
Class Method Details
.add_service(name, ruby_name, default_endpoint) ⇒ Object
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
# File 'lib/aws/core/configuration.rb', line 375 def add_service name, ruby_name, default_endpoint add_option :"#{ruby_name}_endpoint", default_endpoint add_option(:"#{ruby_name}_port") do |config,value| value || (config.use_ssl? ? 443 : 80) end # users only need to specify service regions when they use # a test endpoint with a sigv4 service add_option(:"#{ruby_name}_region") do |config,value| value || begin endpoint = config.send("#{ruby_name}_endpoint") if endpoint =~ /us-gov/ if matches = endpoint.match(/(us-gov-west-\d+)/) matches[1] else 'us-gov-west-1' # e.g. iam.us-gov.amazonaws.com end elsif matches = endpoint.match(/^.+\.(.+)\.amazonaws.com$/) matches[1] else 'us-east-1' end end end needs = [ :"#{ruby_name}_endpoint", :"#{ruby_name}_port", :"#{ruby_name}_region", :credential_provider, :http_handler, :http_read_timeout, :log_formatter, :log_level, :logger, :proxy_uri, :max_retries, :stub_requests?, :ssl_verify_peer?, :ssl_ca_file, :ssl_ca_path, :use_ssl?, :user_agent_prefix, ] create_block = lambda do |config,| AWS.const_get(name)::Client.new(:config => config) end add_option_with_needs :"#{ruby_name}_client", needs, &create_block end |
Instance Method Details
#credentials ⇒ Hash
Returns a hash with your configured credentials.
247 248 249 250 251 252 253 254 255 |
# File 'lib/aws/core/configuration.rb', line 247 def credentials credentials = {} [:access_key_id, :secret_access_key, :session_token].each do |opt| if value = credential_provider.send(opt) credentials[opt] = value end end credentials end |
#eql?(other) ⇒ Boolean Also known as: ==
Returns true if the two configuration objects have the same values.
302 303 304 |
# File 'lib/aws/core/configuration.rb', line 302 def eql? other other.is_a?(self.class) and self.supplied == other.supplied end |
#to_h ⇒ Hash Also known as: to_hash
Returns a hash of all configuration values.
293 294 295 296 297 |
# File 'lib/aws/core/configuration.rb', line 293 def to_h self.class..inject({}) do |h,k| h.merge(k => send(k)) 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)
277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/aws/core/configuration.rb', line 277 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 |