1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
|
# frozen_string_literal: true
module Aws
module Plugins
# @api private
class RegionalEndpoint < Seahorse::Client::Plugin
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 searched 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(:sigv4a_signing_region_set,
doc_type: Array,
rbs_type: 'Array[String]',
docstring: <<-DOCS) do |cfg|
A list of regions that should be signed with SigV4a signing. When
not passed, a default `:sigv4a_signing_region_set` is searched for
in the following locations:
* `Aws.config[:sigv4a_signing_region_set]`
* `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
* `~/.aws/config`
DOCS
resolve_sigv4a_signing_region_set(cfg)
end
option(:use_dualstack_endpoint,
doc_type: 'Boolean',
docstring: <<-DOCS) do |cfg|
When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
will be used if available.
DOCS
resolve_use_dualstack_endpoint(cfg)
end
option(:use_fips_endpoint,
doc_type: 'Boolean',
docstring: <<-DOCS) do |cfg|
When set to `true`, fips compatible endpoints will be used if available.
When a `fips` region is used, the region is normalized and this config
is set to `true`.
DOCS
resolve_use_fips_endpoint(cfg)
end
# This option signals whether :endpoint was provided or not.
# Legacy endpoints must continue to be generated at client time.
option(:regional_endpoint, false)
option(:ignore_configured_endpoint_urls,
doc_type: 'Boolean',
docstring: <<-DOCS) do |cfg|
Setting to true disables use of endpoint URLs provided via environment
variables and the shared configuration file.
DOCS
resolve_ignore_configured_endpoint_urls(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 or custom endpoints. This should be a valid HTTP(S) URI.
DOCS
resolve_endpoint(cfg)
end
def after_initialize(client)
region = client.config.region
raise Errors::MissingRegionError if region.nil? || region == ''
# resolve a default endpoint to preserve legacy behavior
initialize_default_endpoint(client) if client.config.endpoint.nil?
region_set = client.config.sigv4a_signing_region_set
return if region_set.nil?
raise Errors::InvalidRegionSetError unless region_set.is_a?(Array)
region_set = region_set.compact.reject(&:empty?)
raise Errors::InvalidRegionSetError if region_set.empty?
client.config.sigv4a_signing_region_set = region_set
end
private
def initialize_default_endpoint(client)
client_module = Object.const_get(client.class.name.rpartition('::').first)
param_class = client_module.const_get(:EndpointParameters)
endpoint_provider = client.config.endpoint_provider
params = param_class.create(client.config)
endpoint = endpoint_provider.resolve_endpoint(params)
client.config.endpoint = endpoint.url
rescue ArgumentError, NameError
# fallback to legacy
client.config.endpoint = resolve_legacy_endpoint(client.config)
end
# set a default endpoint in config using legacy (endpoints.json) resolver
def resolve_legacy_endpoint(cfg)
endpoint_prefix = cfg.api.metadata['endpointPrefix']
if cfg.respond_to?(:sts_regional_endpoints)
sts_regional = cfg.sts_regional_endpoints
end
endpoint = Aws::Partitions::EndpointProvider.resolve(
cfg.region,
endpoint_prefix,
sts_regional,
{
dualstack: cfg.use_dualstack_endpoint,
fips: cfg.use_fips_endpoint
}
)
URI(endpoint)
end
class << self
private
def 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
def resolve_sigv4a_signing_region_set(cfg)
value = ENV['AWS_SIGV4A_SIGNING_REGION_SET']
value ||= Aws.shared_config.sigv4a_signing_region_set(profile: cfg.profile)
value.split(',') if value
end
def resolve_use_dualstack_endpoint(cfg)
value = ENV['AWS_USE_DUALSTACK_ENDPOINT']
value ||= Aws.shared_config.use_dualstack_endpoint(
profile: cfg.profile
)
Aws::Util.str_2_bool(value) || false
end
def resolve_use_fips_endpoint(cfg)
value = ENV['AWS_USE_FIPS_ENDPOINT']
value ||= Aws.shared_config.use_fips_endpoint(profile: cfg.profile)
Aws::Util.str_2_bool(value) || false
end
def resolve_ignore_configured_endpoint_urls(cfg)
value = ENV['AWS_IGNORE_CONFIGURED_ENDPOINT_URLS']
value ||= Aws.shared_config.ignore_configured_endpoint_urls(profile: cfg.profile)
Aws::Util.str_2_bool(value&.downcase) || false
end
# NOTE: with Endpoints 2.0, some of this logic is deprecated
# but because new old service gems may depend on new core versions
# we must preserve that behavior.
# Additional behavior controls the setting of the custom SDK::Endpoint
# parameter.
# When the `regional_endpoint` config is set to true - this indicates to
# Endpoints2.0 that a custom endpoint has NOT been configured by the user.
def resolve_endpoint(cfg)
endpoint = resolve_custom_config_endpoint(cfg)
endpoint_prefix = cfg.api.metadata['endpointPrefix']
return endpoint unless endpoint.nil? && cfg.region && endpoint_prefix
validate_region!(cfg.region)
handle_legacy_pseudo_regions(cfg)
# set regional_endpoint flag - this indicates to Endpoints 2.0
# that a custom endpoint has NOT been configured by the user
cfg.override_config(:regional_endpoint, true)
# a default endpoint is resolved in after_initialize
nil
end
# get a custom configured endpoint from ENV or configuration
def resolve_custom_config_endpoint(cfg)
return if cfg.ignore_configured_endpoint_urls
env_service_endpoint(cfg) || env_global_endpoint(cfg) || shared_config_endpoint(cfg)
end
def env_service_endpoint(cfg)
service_id = cfg.api.metadata['serviceId'] || cfg.api.metadata['endpointPrefix']
env_service_id = service_id.gsub(" ", "_").upcase
return unless endpoint = ENV["AWS_ENDPOINT_URL_#{env_service_id}"]
cfg.logger&.debug(
"Endpoint configured from ENV['AWS_ENDPOINT_URL_#{env_service_id}']: #{endpoint}\n")
endpoint
end
def env_global_endpoint(cfg)
return unless endpoint = ENV['AWS_ENDPOINT_URL']
cfg.logger&.debug(
"Endpoint configured from ENV['AWS_ENDPOINT_URL']: #{endpoint}\n")
endpoint
end
def shared_config_endpoint(cfg)
service_id = cfg.api.metadata['serviceId'] || cfg.api.metadata['endpointPrefix']
return unless endpoint = Aws.shared_config.configured_endpoint(profile: cfg.profile, service_id: service_id)
cfg.logger&.debug(
"Endpoint configured from shared config(profile: #{cfg.profile}): #{endpoint}\n")
endpoint
end
# check region is a valid RFC host label
def validate_region!(region)
unless Seahorse::Util.host_label?(region)
raise Errors::InvalidRegionError
end
end
def handle_legacy_pseudo_regions(cfg)
region = cfg.region
new_region = region.gsub('fips-', '').gsub('-fips', '')
if region != new_region
warn("Legacy region #{region} was transformed to #{new_region}."\
'`use_fips_endpoint` config was set to true.')
cfg.override_config(:use_fips_endpoint, true)
cfg.override_config(:region, new_region)
end
end
end
end
end
end
|