Sha256: ab7af976a09771b7ef5bbcf8c1bfb91876527a775ff91d07f47a978506f6b3a8

Contents?: true

Size: 1.67 KB

Versions: 70

Compression:

Stored size: 1.67 KB

Contents

module Aws
  module Plugins
    # @api private
    class RegionalEndpoint < Seahorse::Client::Plugin

      # raised when region is not configured
      MISSING_REGION = 'missing required configuration option :region'

      option(:profile)

      option(:region,
        required: true,
        doc_type: String,
        docstring: <<-DOCS) do |cfg|
The AWS region to connect to.  The configured `:region` is
used to determine the service `:endpoint`. When not passed,
a default `:region` is search for in the following locations:

* `Aws.config[:region]`
* `ENV['AWS_REGION']`
* `ENV['AMAZON_REGION']`
* `ENV['AWS_DEFAULT_REGION']`
* `~/.aws/credentials`
* `~/.aws/config`
        DOCS
        resolve_region(cfg)
      end

      option(:endpoint, doc_type: String, docstring: <<-DOCS) do |cfg|
The client endpoint is normally constructed from the `:region`
option. You should only configure an `:endpoint` when connecting
to test endpoints. This should be avalid HTTP(S) URI.
        DOCS
        endpoint_prefix = cfg.api.metadata['endpointPrefix']
        if cfg.region && endpoint_prefix
          Aws::Partitions::EndpointProvider.resolve(cfg.region, endpoint_prefix)
        end
      end

      def after_initialize(client)
        if client.config.region.nil? or client.config.region == ''
          raise Errors::MissingRegionError
        end
      end

      private

      def self.resolve_region(cfg)
        keys = %w(AWS_REGION AMAZON_REGION AWS_DEFAULT_REGION)
        env_region = ENV.values_at(*keys).compact.first
        env_region = nil if env_region == ''
        cfg_region = Aws.shared_config.region(profile: cfg.profile)
        env_region || cfg_region
      end

    end
  end
end

Version data entries

70 entries across 70 versions & 1 rubygems

Version Path
aws-sdk-core-3.36.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.35.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.34.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.33.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.32.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.31.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.30.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.29.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.28.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.27.1 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.27.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.26.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.25.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.24.1 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.24.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.23.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.22.1 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.22.0 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.21.3 lib/aws-sdk-core/plugins/regional_endpoint.rb
aws-sdk-core-3.21.2 lib/aws-sdk-core/plugins/regional_endpoint.rb