AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Module: Aws::Rails

Defined in:
lib/aws/rails/railtie.rb,
lib/aws-sdk-rails.rb,
lib/aws/rails/mailer.rb,
lib/aws/rails/notifications.rb,
lib/aws/rails/sqs_active_job/poller.rb,
lib/aws/rails/sqs_active_job/executor.rb,
lib/aws/rails/sqs_active_job/job_runner.rb,
lib/aws/rails/sqs_active_job/configuration.rb,
lib/aws/rails/sqs_active_job/lambda_handler.rb,
lib/aws/rails/middleware/ebs_sqs_active_job_middleware.rb

Overview

Use the Rails namespace.

Defined Under Namespace

Modules: SqsActiveJob Classes: EbsSqsActiveJobMiddleware, Mailer

Constant Summary collapse

VERSION =
File.read(File.expand_path('../VERSION', __dir__)).strip

Class Method Summary collapse

Class Method Details

.add_action_mailer_delivery_method(name = :ses, options = {}) ⇒ Object

This is called automatically from the SDK's Railtie, but can be manually called if you want to specify options for building the Aws::SES::Client.

Parameters:

  • name (Symbol) (defaults to: :ses)

    The name of the ActionMailer delivery method to register.

  • options (Hash) (defaults to: {})

    The options you wish to pass on to the Aws::SES::Client initialization method.



33
34
35
36
37
# File 'lib/aws/rails/railtie.rb', line 33

def self.add_action_mailer_delivery_method(name = :ses, options = {})
  ActiveSupport.on_load(:action_mailer) do
    add_delivery_method(name, Aws::Rails::Mailer, options)
  end
end

.add_sqsd_middleware(app) ⇒ Object

Register a middleware that will handle requests from the Elastic Beanstalk worker SQS Daemon. This will only be added in the presence of the AWS_PROCESS_BEANSTALK_WORKER_REQUESTS environment variable. The expectation is this variable should only be set on EB worker environments.



72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/aws/rails/railtie.rb', line 72

def self.add_sqsd_middleware(app)
  is_eb_worker_hosted = Aws::Util.str_2_bool(ENV['AWS_PROCESS_BEANSTALK_WORKER_REQUESTS'].to_s.downcase)

  return unless is_eb_worker_hosted

  if app.config.force_ssl
    # SQS Daemon sends requests over HTTP - allow and process them before enforcing SSL.
    app.config.middleware.insert_before(ActionDispatch::SSL, Aws::Rails::EbsSqsActiveJobMiddleware)
  else
    app.config.middleware.use(Aws::Rails::EbsSqsActiveJobMiddleware)
  end
end

.instrument_sdk_operationsObject

Adds ActiveSupport Notifications instrumentation to AWS SDK client operations. Each operation will produce an event with a name: <operation>.<service>.aws. For example, S3's put_object has an event name of: put_object.S3.aws



59
60
61
62
63
64
65
66
67
# File 'lib/aws/rails/railtie.rb', line 59

def self.instrument_sdk_operations
  Aws.constants.each do |c|
    m = Aws.const_get(c)
    if m.is_a?(Module) && m.const_defined?(:Client) &&
       m.const_get(:Client).superclass == Seahorse::Client::Base
      m.const_get(:Client).add_plugin(Aws::Rails::Notifications)
    end
  end
end

.log_to_rails_loggerObject

Configures the AWS SDK for Ruby's logger to use the Rails logger.



40
41
42
43
# File 'lib/aws/rails/railtie.rb', line 40

def self.log_to_rails_logger
  Aws.config[:logger] = ::Rails.logger
  nil
end

.use_rails_encrypted_credentialsObject

Configures the AWS SDK with credentials from Rails encrypted credentials.



46
47
48
49
50
51
52
53
# File 'lib/aws/rails/railtie.rb', line 46

def self.use_rails_encrypted_credentials
  # limit the config keys we merge to credentials only
  aws_credential_keys = %i[access_key_id secret_access_key session_token]

  Aws.config.merge!(
    ::Rails.application.credentials[:aws].to_h.slice(*aws_credential_keys)
  )
end