aws-sdk-elasticloadbalancing 1.2.0 → 1.38.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +263 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-elasticloadbalancing/client.rb +342 -126
- data/lib/aws-sdk-elasticloadbalancing/client_api.rb +50 -1
- data/lib/aws-sdk-elasticloadbalancing/customizations.rb +2 -1
- data/lib/aws-sdk-elasticloadbalancing/errors.rb +267 -1
- data/lib/aws-sdk-elasticloadbalancing/resource.rb +4 -1
- data/lib/aws-sdk-elasticloadbalancing/types.rb +253 -24
- data/lib/aws-sdk-elasticloadbalancing/waiters.rb +66 -1
- data/lib/aws-sdk-elasticloadbalancing.rb +12 -6
- metadata +19 -11
@@ -1,7 +1,9 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
4
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
7
|
#
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
@@ -15,16 +17,35 @@ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
|
15
17
|
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
18
|
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
19
|
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
18
22
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
23
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
24
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
25
|
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
22
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
23
32
|
require 'aws-sdk-core/plugins/protocols/query.rb'
|
24
33
|
|
25
34
|
Aws::Plugins::GlobalConfiguration.add_identifier(:elasticloadbalancing)
|
26
35
|
|
27
36
|
module Aws::ElasticLoadBalancing
|
37
|
+
# An API client for ElasticLoadBalancing. To construct a client, you need to configure a `:region` and `:credentials`.
|
38
|
+
#
|
39
|
+
# client = Aws::ElasticLoadBalancing::Client.new(
|
40
|
+
# region: region_name,
|
41
|
+
# credentials: credentials,
|
42
|
+
# # ...
|
43
|
+
# )
|
44
|
+
#
|
45
|
+
# For details on configuring region and credentials see
|
46
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
47
|
+
#
|
48
|
+
# See {#initialize} for a full list of supported configuration options.
|
28
49
|
class Client < Seahorse::Client::Base
|
29
50
|
|
30
51
|
include Aws::ClientStubs
|
@@ -43,101 +64,282 @@ module Aws::ElasticLoadBalancing
|
|
43
64
|
add_plugin(Aws::Plugins::RetryErrors)
|
44
65
|
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
66
|
add_plugin(Aws::Plugins::RegionalEndpoint)
|
67
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
68
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
46
69
|
add_plugin(Aws::Plugins::ResponsePaging)
|
47
70
|
add_plugin(Aws::Plugins::StubResponses)
|
48
71
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
72
|
add_plugin(Aws::Plugins::JsonvalueConverter)
|
73
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
74
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
75
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
76
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
50
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
51
79
|
add_plugin(Aws::Plugins::Protocols::Query)
|
52
80
|
|
53
|
-
# @
|
54
|
-
#
|
55
|
-
#
|
81
|
+
# @overload initialize(options)
|
82
|
+
# @param [Hash] options
|
83
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
84
|
+
# Your AWS credentials. This can be an instance of any one of the
|
85
|
+
# following classes:
|
86
|
+
#
|
87
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
88
|
+
# credentials.
|
89
|
+
#
|
90
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
91
|
+
# shared file, such as `~/.aws/config`.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
94
|
+
#
|
95
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
96
|
+
# assume a role after providing credentials via the web.
|
97
|
+
#
|
98
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
99
|
+
# access token generated from `aws login`.
|
100
|
+
#
|
101
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
102
|
+
# process that outputs to stdout.
|
103
|
+
#
|
104
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
105
|
+
# from an EC2 IMDS on an EC2 instance.
|
106
|
+
#
|
107
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
108
|
+
# instances running in ECS.
|
109
|
+
#
|
110
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
111
|
+
# from the Cognito Identity service.
|
112
|
+
#
|
113
|
+
# When `:credentials` are not configured directly, the following
|
114
|
+
# locations will be searched for credentials:
|
115
|
+
#
|
116
|
+
# * `Aws.config[:credentials]`
|
117
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
118
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
119
|
+
# * `~/.aws/credentials`
|
120
|
+
# * `~/.aws/config`
|
121
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
122
|
+
# are very aggressive. Construct and pass an instance of
|
123
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
127
|
+
#
|
128
|
+
# @option options [required, String] :region
|
129
|
+
# The AWS region to connect to. The configured `:region` is
|
130
|
+
# used to determine the service `:endpoint`. When not passed,
|
131
|
+
# a default `:region` is searched for in the following locations:
|
132
|
+
#
|
133
|
+
# * `Aws.config[:region]`
|
134
|
+
# * `ENV['AWS_REGION']`
|
135
|
+
# * `ENV['AMAZON_REGION']`
|
136
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
137
|
+
# * `~/.aws/credentials`
|
138
|
+
# * `~/.aws/config`
|
139
|
+
#
|
140
|
+
# @option options [String] :access_key_id
|
141
|
+
#
|
142
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
143
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
144
|
+
# the background every 60 secs (default). Defaults to `false`.
|
145
|
+
#
|
146
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
147
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
148
|
+
# until there is sufficent client side capacity to retry the request.
|
149
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
150
|
+
# not retry instead of sleeping.
|
151
|
+
#
|
152
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
153
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
154
|
+
# this client.
|
155
|
+
#
|
156
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
157
|
+
# Allows you to provide an identifier for this client which will be attached to
|
158
|
+
# all generated client side metrics. Defaults to an empty string.
|
159
|
+
#
|
160
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
161
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
162
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
163
|
+
#
|
164
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
165
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
166
|
+
# agent is running on, where client metrics will be published via UDP.
|
167
|
+
#
|
168
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
169
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
170
|
+
# will use the Client Side Monitoring Agent Publisher.
|
171
|
+
#
|
172
|
+
# @option options [Boolean] :convert_params (true)
|
173
|
+
# When `true`, an attempt is made to coerce request parameters into
|
174
|
+
# the required types.
|
175
|
+
#
|
176
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
177
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
178
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
56
179
|
#
|
57
|
-
#
|
58
|
-
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
59
183
|
#
|
60
|
-
#
|
61
|
-
#
|
184
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
185
|
+
# Set to true to disable SDK automatically adding host prefix
|
186
|
+
# to default service endpoint when available.
|
62
187
|
#
|
63
|
-
#
|
64
|
-
#
|
188
|
+
# @option options [String] :endpoint
|
189
|
+
# The client endpoint is normally constructed from the `:region`
|
190
|
+
# option. You should only configure an `:endpoint` when connecting
|
191
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
65
192
|
#
|
66
|
-
#
|
193
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
194
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
195
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
196
|
+
#
|
197
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
198
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
199
|
+
#
|
200
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
201
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
202
|
+
# Use this option to config the time interval in seconds for making
|
203
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
204
|
+
#
|
205
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
206
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
207
|
+
#
|
208
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
209
|
+
# The log formatter.
|
210
|
+
#
|
211
|
+
# @option options [Symbol] :log_level (:info)
|
212
|
+
# The log level to send messages to the `:logger` at.
|
213
|
+
#
|
214
|
+
# @option options [Logger] :logger
|
215
|
+
# The Logger instance to send log messages to. If this option
|
216
|
+
# is not set, logging will be disabled.
|
217
|
+
#
|
218
|
+
# @option options [Integer] :max_attempts (3)
|
219
|
+
# An integer representing the maximum number attempts that will be made for
|
220
|
+
# a single request, including the initial attempt. For example,
|
221
|
+
# setting this value to 5 will result in a request being retried up to
|
222
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
223
|
+
#
|
224
|
+
# @option options [String] :profile ("default")
|
225
|
+
# Used when loading credentials from the shared credentials file
|
226
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
67
227
|
#
|
68
|
-
#
|
69
|
-
#
|
228
|
+
# @option options [Proc] :retry_backoff
|
229
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
230
|
+
# This option is only used in the `legacy` retry mode.
|
70
231
|
#
|
71
|
-
#
|
72
|
-
#
|
73
|
-
#
|
74
|
-
#
|
75
|
-
#
|
76
|
-
#
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
232
|
+
# @option options [Float] :retry_base_delay (0.3)
|
233
|
+
# The base delay in seconds used by the default backoff function. This option
|
234
|
+
# is only used in the `legacy` retry mode.
|
235
|
+
#
|
236
|
+
# @option options [Symbol] :retry_jitter (:none)
|
237
|
+
# A delay randomiser function used by the default backoff function.
|
238
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
239
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
240
|
+
# in the `legacy` retry mode.
|
241
|
+
#
|
242
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
243
|
+
#
|
244
|
+
# @option options [Integer] :retry_limit (3)
|
245
|
+
# The maximum number of times to retry failed requests. Only
|
246
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
247
|
+
# are retried. Generally, these are throttling errors, data
|
248
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
249
|
+
# endpoint discovery, and errors from expired credentials.
|
250
|
+
# This option is only used in the `legacy` retry mode.
|
80
251
|
#
|
81
|
-
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
252
|
+
# @option options [Integer] :retry_max_delay (0)
|
253
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
254
|
+
# used by the default backoff function. This option is only used in the
|
255
|
+
# `legacy` retry mode.
|
256
|
+
#
|
257
|
+
# @option options [String] :retry_mode ("legacy")
|
258
|
+
# Specifies which retry algorithm to use. Values are:
|
85
259
|
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
# * `ENV['AMAZON_REGION']`
|
89
|
-
# * `ENV['AWS_DEFAULT_REGION']`
|
90
|
-
# * `~/.aws/credentials`
|
91
|
-
# * `~/.aws/config`
|
260
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
261
|
+
# no retry mode is provided.
|
92
262
|
#
|
93
|
-
#
|
263
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
264
|
+
# This includes support for retry quotas, which limit the number of
|
265
|
+
# unsuccessful retries a client can make.
|
94
266
|
#
|
95
|
-
#
|
96
|
-
#
|
97
|
-
#
|
267
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
268
|
+
# functionality of `standard` mode along with automatic client side
|
269
|
+
# throttling. This is a provisional mode that may change behavior
|
270
|
+
# in the future.
|
98
271
|
#
|
99
|
-
# @option options [String] :endpoint
|
100
|
-
# The client endpoint is normally constructed from the `:region`
|
101
|
-
# option. You should only configure an `:endpoint` when connecting
|
102
|
-
# to test endpoints. This should be avalid HTTP(S) URI.
|
103
272
|
#
|
104
|
-
#
|
105
|
-
#
|
273
|
+
# @option options [String] :secret_access_key
|
274
|
+
#
|
275
|
+
# @option options [String] :session_token
|
276
|
+
#
|
277
|
+
# @option options [Boolean] :stub_responses (false)
|
278
|
+
# Causes the client to return stubbed responses. By default
|
279
|
+
# fake responses are generated and returned. You can specify
|
280
|
+
# the response data to return or errors to raise by calling
|
281
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
106
282
|
#
|
107
|
-
#
|
108
|
-
#
|
283
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
284
|
+
# requests are made, and retries are disabled.
|
109
285
|
#
|
110
|
-
#
|
111
|
-
#
|
112
|
-
#
|
286
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
287
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
288
|
+
# will be used if available.
|
113
289
|
#
|
114
|
-
#
|
115
|
-
#
|
116
|
-
#
|
290
|
+
# @option options [Boolean] :use_fips_endpoint
|
291
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
292
|
+
# When a `fips` region is used, the region is normalized and this config
|
293
|
+
# is set to `true`.
|
117
294
|
#
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
121
|
-
# are retried. Generally, these are throttling errors, data
|
122
|
-
# checksum errors, networking errors, timeout errors and auth
|
123
|
-
# errors from expired credentials.
|
295
|
+
# @option options [Boolean] :validate_params (true)
|
296
|
+
# When `true`, request parameters are validated before
|
297
|
+
# sending the request.
|
124
298
|
#
|
125
|
-
#
|
299
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
300
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
126
301
|
#
|
127
|
-
#
|
302
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
303
|
+
# seconds to wait when opening a HTTP session before raising a
|
304
|
+
# `Timeout::Error`.
|
128
305
|
#
|
129
|
-
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
# the response data to return or errors to raise by calling
|
133
|
-
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
306
|
+
# @option options [Float] :http_read_timeout (60) The default
|
307
|
+
# number of seconds to wait for response data. This value can
|
308
|
+
# safely be set per-request on the session.
|
134
309
|
#
|
135
|
-
#
|
136
|
-
#
|
310
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
311
|
+
# seconds a connection is allowed to sit idle before it is
|
312
|
+
# considered stale. Stale connections are closed and removed
|
313
|
+
# from the pool before making a request.
|
314
|
+
#
|
315
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
316
|
+
# seconds to wait for a 100-continue response before sending the
|
317
|
+
# request body. This option has no effect unless the request has
|
318
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
319
|
+
# disables this behaviour. This value can safely be set per
|
320
|
+
# request on the session.
|
137
321
|
#
|
138
|
-
#
|
139
|
-
#
|
140
|
-
#
|
322
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
323
|
+
# in seconds.
|
324
|
+
#
|
325
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
326
|
+
# HTTP debug output will be sent to the `:logger`.
|
327
|
+
#
|
328
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
329
|
+
# SSL peer certificates are verified when establishing a
|
330
|
+
# connection.
|
331
|
+
#
|
332
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
333
|
+
# certificate authority bundle file that should be used when
|
334
|
+
# verifying peer certificates. If you do not pass
|
335
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
336
|
+
# will be used if available.
|
337
|
+
#
|
338
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
339
|
+
# directory that contains the unbundled SSL certificate
|
340
|
+
# authority files for verifying peer certificates. If you do
|
341
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
342
|
+
# system default will be used if available.
|
141
343
|
#
|
142
344
|
def initialize(*args)
|
143
345
|
super
|
@@ -153,11 +355,11 @@ module Aws::ElasticLoadBalancing
|
|
153
355
|
# updates its value.
|
154
356
|
#
|
155
357
|
# For more information, see [Tag Your Classic Load Balancer][1] in the
|
156
|
-
# *Classic Load
|
358
|
+
# *Classic Load Balancers Guide*.
|
157
359
|
#
|
158
360
|
#
|
159
361
|
#
|
160
|
-
# [1]:
|
362
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html
|
161
363
|
#
|
162
364
|
# @option params [required, Array<String>] :load_balancer_names
|
163
365
|
# The name of the load balancer. You can specify one load balancer only.
|
@@ -214,11 +416,11 @@ module Aws::ElasticLoadBalancing
|
|
214
416
|
# the previously associated security groups.
|
215
417
|
#
|
216
418
|
# For more information, see [Security Groups for Load Balancers in a
|
217
|
-
# VPC][1] in the *Classic Load
|
419
|
+
# VPC][1] in the *Classic Load Balancers Guide*.
|
218
420
|
#
|
219
421
|
#
|
220
422
|
#
|
221
|
-
# [1]:
|
423
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-security-groups.html#elb-vpc-security-groups
|
222
424
|
#
|
223
425
|
# @option params [required, String] :load_balancer_name
|
224
426
|
# The name of the load balancer.
|
@@ -276,11 +478,11 @@ module Aws::ElasticLoadBalancing
|
|
276
478
|
#
|
277
479
|
# The load balancer evenly distributes requests across all registered
|
278
480
|
# subnets. For more information, see [Add or Remove Subnets for Your
|
279
|
-
# Load Balancer in a VPC][1] in the *Classic Load
|
481
|
+
# Load Balancer in a VPC][1] in the *Classic Load Balancers Guide*.
|
280
482
|
#
|
281
483
|
#
|
282
484
|
#
|
283
|
-
# [1]:
|
485
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-manage-subnets.html
|
284
486
|
#
|
285
487
|
# @option params [required, String] :load_balancer_name
|
286
488
|
# The name of the load balancer.
|
@@ -338,11 +540,11 @@ module Aws::ElasticLoadBalancing
|
|
338
540
|
# state of your EC2 instances.
|
339
541
|
#
|
340
542
|
# For more information, see [Configure Health Checks for Your Load
|
341
|
-
# Balancer][1] in the *Classic Load
|
543
|
+
# Balancer][1] in the *Classic Load Balancers Guide*.
|
342
544
|
#
|
343
545
|
#
|
344
546
|
#
|
345
|
-
# [1]:
|
547
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-healthchecks.html
|
346
548
|
#
|
347
549
|
# @option params [required, String] :load_balancer_name
|
348
550
|
# The name of the load balancer.
|
@@ -426,11 +628,11 @@ module Aws::ElasticLoadBalancing
|
|
426
628
|
# session stops being sticky until a new application cookie is issued.
|
427
629
|
#
|
428
630
|
# For more information, see [Application-Controlled Session
|
429
|
-
# Stickiness][1] in the *Classic Load
|
631
|
+
# Stickiness][1] in the *Classic Load Balancers Guide*.
|
430
632
|
#
|
431
633
|
#
|
432
634
|
#
|
433
|
-
# [1]:
|
635
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application
|
434
636
|
#
|
435
637
|
# @option params [required, String] :load_balancer_name
|
436
638
|
# The name of the load balancer.
|
@@ -492,11 +694,11 @@ module Aws::ElasticLoadBalancing
|
|
492
694
|
# configuration.
|
493
695
|
#
|
494
696
|
# For more information, see [Duration-Based Session Stickiness][1] in
|
495
|
-
# the *Classic Load
|
697
|
+
# the *Classic Load Balancers Guide*.
|
496
698
|
#
|
497
699
|
#
|
498
700
|
#
|
499
|
-
# [1]:
|
701
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration
|
500
702
|
#
|
501
703
|
# @option params [required, String] :load_balancer_name
|
502
704
|
# The name of the load balancer.
|
@@ -556,11 +758,11 @@ module Aws::ElasticLoadBalancing
|
|
556
758
|
# You can create up to 20 load balancers per region per account. You can
|
557
759
|
# request an increase for the number of load balancers for your account.
|
558
760
|
# For more information, see [Limits for Your Classic Load Balancer][1]
|
559
|
-
# in the *Classic Load
|
761
|
+
# in the *Classic Load Balancers Guide*.
|
560
762
|
#
|
561
763
|
#
|
562
764
|
#
|
563
|
-
# [1]:
|
765
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html
|
564
766
|
#
|
565
767
|
# @option params [required, String] :load_balancer_name
|
566
768
|
# The name of the load balancer.
|
@@ -574,11 +776,11 @@ module Aws::ElasticLoadBalancing
|
|
574
776
|
# The listeners.
|
575
777
|
#
|
576
778
|
# For more information, see [Listeners for Your Classic Load
|
577
|
-
# Balancer][1] in the *Classic Load
|
779
|
+
# Balancer][1] in the *Classic Load Balancers Guide*.
|
578
780
|
#
|
579
781
|
#
|
580
782
|
#
|
581
|
-
# [1]:
|
783
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html
|
582
784
|
#
|
583
785
|
# @option params [Array<String>] :availability_zones
|
584
786
|
# One or more Availability Zones from the same region as the load
|
@@ -611,17 +813,17 @@ module Aws::ElasticLoadBalancing
|
|
611
813
|
#
|
612
814
|
#
|
613
815
|
#
|
614
|
-
# [1]:
|
816
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/how-elastic-load-balancing-works.html#load-balancer-scheme
|
615
817
|
#
|
616
818
|
# @option params [Array<Types::Tag>] :tags
|
617
819
|
# A list of tags to assign to the load balancer.
|
618
820
|
#
|
619
821
|
# For more information about tagging your load balancer, see [Tag Your
|
620
|
-
# Classic Load Balancer][1] in the *Classic Load
|
822
|
+
# Classic Load Balancer][1] in the *Classic Load Balancers Guide*.
|
621
823
|
#
|
622
824
|
#
|
623
825
|
#
|
624
|
-
# [1]:
|
826
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html
|
625
827
|
#
|
626
828
|
# @return [Types::CreateAccessPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
627
829
|
#
|
@@ -816,11 +1018,11 @@ module Aws::ElasticLoadBalancing
|
|
816
1018
|
# properties of the existing listener.
|
817
1019
|
#
|
818
1020
|
# For more information, see [Listeners for Your Classic Load
|
819
|
-
# Balancer][1] in the *Classic Load
|
1021
|
+
# Balancer][1] in the *Classic Load Balancers Guide*.
|
820
1022
|
#
|
821
1023
|
#
|
822
1024
|
#
|
823
|
-
# [1]:
|
1025
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html
|
824
1026
|
#
|
825
1027
|
# @option params [required, String] :load_balancer_name
|
826
1028
|
# The name of the load balancer.
|
@@ -1108,11 +1310,11 @@ module Aws::ElasticLoadBalancing
|
|
1108
1310
|
# deregistered from the load balancer.
|
1109
1311
|
#
|
1110
1312
|
# For more information, see [Register or De-Register EC2 Instances][1]
|
1111
|
-
# in the *Classic Load
|
1313
|
+
# in the *Classic Load Balancers Guide*.
|
1112
1314
|
#
|
1113
1315
|
#
|
1114
1316
|
#
|
1115
|
-
# [1]:
|
1317
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html
|
1116
1318
|
#
|
1117
1319
|
# @option params [required, String] :load_balancer_name
|
1118
1320
|
# The name of the load balancer.
|
@@ -1179,11 +1381,11 @@ module Aws::ElasticLoadBalancing
|
|
1179
1381
|
# AWS account.
|
1180
1382
|
#
|
1181
1383
|
# For more information, see [Limits for Your Classic Load Balancer][1]
|
1182
|
-
# in the *Classic Load
|
1384
|
+
# in the *Classic Load Balancers Guide*.
|
1183
1385
|
#
|
1184
1386
|
#
|
1185
1387
|
#
|
1186
|
-
# [1]:
|
1388
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html
|
1187
1389
|
#
|
1188
1390
|
# @option params [String] :marker
|
1189
1391
|
# The marker for the next set of results. (You received this marker from
|
@@ -1283,6 +1485,13 @@ module Aws::ElasticLoadBalancing
|
|
1283
1485
|
# resp.instance_states[0].reason_code #=> String
|
1284
1486
|
# resp.instance_states[0].description #=> String
|
1285
1487
|
#
|
1488
|
+
#
|
1489
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1490
|
+
#
|
1491
|
+
# * any_instance_in_service
|
1492
|
+
# * instance_deregistered
|
1493
|
+
# * instance_in_service
|
1494
|
+
#
|
1286
1495
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DescribeInstanceHealth AWS API Documentation
|
1287
1496
|
#
|
1288
1497
|
# @overload describe_instance_health(params = {})
|
@@ -1526,6 +1735,8 @@ module Aws::ElasticLoadBalancing
|
|
1526
1735
|
# * {Types::DescribeAccessPointsOutput#load_balancer_descriptions #load_balancer_descriptions} => Array<Types::LoadBalancerDescription>
|
1527
1736
|
# * {Types::DescribeAccessPointsOutput#next_marker #next_marker} => String
|
1528
1737
|
#
|
1738
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1739
|
+
#
|
1529
1740
|
#
|
1530
1741
|
# @example Example: To describe one of your load balancers
|
1531
1742
|
#
|
@@ -1814,7 +2025,10 @@ module Aws::ElasticLoadBalancing
|
|
1814
2025
|
end
|
1815
2026
|
|
1816
2027
|
# Removes the specified Availability Zones from the set of Availability
|
1817
|
-
# Zones for the specified load balancer.
|
2028
|
+
# Zones for the specified load balancer in EC2-Classic or a default VPC.
|
2029
|
+
#
|
2030
|
+
# For load balancers in a non-default VPC, use
|
2031
|
+
# DetachLoadBalancerFromSubnets.
|
1818
2032
|
#
|
1819
2033
|
# There must be at least one Availability Zone registered with a load
|
1820
2034
|
# balancer at all times. After an Availability Zone is removed, all
|
@@ -1824,11 +2038,11 @@ module Aws::ElasticLoadBalancing
|
|
1824
2038
|
# Availability Zones.
|
1825
2039
|
#
|
1826
2040
|
# For more information, see [Add or Remove Availability Zones][1] in the
|
1827
|
-
# *Classic Load
|
2041
|
+
# *Classic Load Balancers Guide*.
|
1828
2042
|
#
|
1829
2043
|
#
|
1830
2044
|
#
|
1831
|
-
# [1]:
|
2045
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html
|
1832
2046
|
#
|
1833
2047
|
# @option params [required, String] :load_balancer_name
|
1834
2048
|
# The name of the load balancer.
|
@@ -1881,17 +2095,19 @@ module Aws::ElasticLoadBalancing
|
|
1881
2095
|
end
|
1882
2096
|
|
1883
2097
|
# Adds the specified Availability Zones to the set of Availability Zones
|
1884
|
-
# for the specified load balancer.
|
2098
|
+
# for the specified load balancer in EC2-Classic or a default VPC.
|
1885
2099
|
#
|
1886
|
-
#
|
1887
|
-
#
|
2100
|
+
# For load balancers in a non-default VPC, use
|
2101
|
+
# AttachLoadBalancerToSubnets.
|
1888
2102
|
#
|
1889
|
-
#
|
1890
|
-
#
|
2103
|
+
# The load balancer evenly distributes requests across all its
|
2104
|
+
# registered Availability Zones that contain instances. For more
|
2105
|
+
# information, see [Add or Remove Availability Zones][1] in the *Classic
|
2106
|
+
# Load Balancers Guide*.
|
1891
2107
|
#
|
1892
2108
|
#
|
1893
2109
|
#
|
1894
|
-
# [1]:
|
2110
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html
|
1895
2111
|
#
|
1896
2112
|
# @option params [required, String] :load_balancer_name
|
1897
2113
|
# The name of the load balancer.
|
@@ -1953,7 +2169,7 @@ module Aws::ElasticLoadBalancing
|
|
1953
2169
|
# `ConnectionSettings` by specifying an idle connection timeout value
|
1954
2170
|
# for your load balancer.
|
1955
2171
|
#
|
1956
|
-
# For more information, see the following in the *Classic Load
|
2172
|
+
# For more information, see the following in the *Classic Load Balancers
|
1957
2173
|
# Guide*\:
|
1958
2174
|
#
|
1959
2175
|
# * [Cross-Zone Load Balancing][1]
|
@@ -1966,10 +2182,10 @@ module Aws::ElasticLoadBalancing
|
|
1966
2182
|
#
|
1967
2183
|
#
|
1968
2184
|
#
|
1969
|
-
# [1]:
|
1970
|
-
# [2]:
|
1971
|
-
# [3]:
|
1972
|
-
# [4]:
|
2185
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html
|
2186
|
+
# [2]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html
|
2187
|
+
# [3]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/access-log-collection.html
|
2188
|
+
# [4]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html
|
1973
2189
|
#
|
1974
2190
|
# @option params [required, String] :load_balancer_name
|
1975
2191
|
# The name of the load balancer.
|
@@ -2109,11 +2325,11 @@ module Aws::ElasticLoadBalancing
|
|
2109
2325
|
# DeregisterInstancesFromLoadBalancer.
|
2110
2326
|
#
|
2111
2327
|
# For more information, see [Register or De-Register EC2 Instances][1]
|
2112
|
-
# in the *Classic Load
|
2328
|
+
# in the *Classic Load Balancers Guide*.
|
2113
2329
|
#
|
2114
2330
|
#
|
2115
2331
|
#
|
2116
|
-
# [1]:
|
2332
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html
|
2117
2333
|
#
|
2118
2334
|
# @option params [required, String] :load_balancer_name
|
2119
2335
|
# The name of the load balancer.
|
@@ -2232,11 +2448,11 @@ module Aws::ElasticLoadBalancing
|
|
2232
2448
|
#
|
2233
2449
|
# For more information about updating your SSL certificate, see [Replace
|
2234
2450
|
# the SSL Certificate for Your Load Balancer][1] in the *Classic Load
|
2235
|
-
#
|
2451
|
+
# Balancers Guide*.
|
2236
2452
|
#
|
2237
2453
|
#
|
2238
2454
|
#
|
2239
|
-
# [1]:
|
2455
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-update-ssl-cert.html
|
2240
2456
|
#
|
2241
2457
|
# @option params [required, String] :load_balancer_name
|
2242
2458
|
# The name of the load balancer.
|
@@ -2292,14 +2508,14 @@ module Aws::ElasticLoadBalancing
|
|
2292
2508
|
#
|
2293
2509
|
# For more information about enabling back-end instance authentication,
|
2294
2510
|
# see [Configure Back-end Instance Authentication][1] in the *Classic
|
2295
|
-
# Load
|
2296
|
-
# [Configure Proxy Protocol Support][2] in the *Classic Load
|
2511
|
+
# Load Balancers Guide*. For more information about Proxy Protocol, see
|
2512
|
+
# [Configure Proxy Protocol Support][2] in the *Classic Load Balancers
|
2297
2513
|
# Guide*.
|
2298
2514
|
#
|
2299
2515
|
#
|
2300
2516
|
#
|
2301
|
-
# [1]:
|
2302
|
-
# [2]:
|
2517
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-create-https-ssl-load-balancer.html#configure_backendauth_clt
|
2518
|
+
# [2]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-proxy-protocol.html
|
2303
2519
|
#
|
2304
2520
|
# @option params [required, String] :load_balancer_name
|
2305
2521
|
# The name of the load balancer.
|
@@ -2352,13 +2568,13 @@ module Aws::ElasticLoadBalancing
|
|
2352
2568
|
# For more information about setting policies, see [Update the SSL
|
2353
2569
|
# Negotiation Configuration][1], [Duration-Based Session Stickiness][2],
|
2354
2570
|
# and [Application-Controlled Session Stickiness][3] in the *Classic
|
2355
|
-
# Load
|
2571
|
+
# Load Balancers Guide*.
|
2356
2572
|
#
|
2357
2573
|
#
|
2358
2574
|
#
|
2359
|
-
# [1]:
|
2360
|
-
# [2]:
|
2361
|
-
# [3]:
|
2575
|
+
# [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/ssl-config-update.html
|
2576
|
+
# [2]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration
|
2577
|
+
# [3]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application
|
2362
2578
|
#
|
2363
2579
|
# @option params [required, String] :load_balancer_name
|
2364
2580
|
# The name of the load balancer.
|
@@ -2416,7 +2632,7 @@ module Aws::ElasticLoadBalancing
|
|
2416
2632
|
params: params,
|
2417
2633
|
config: config)
|
2418
2634
|
context[:gem_name] = 'aws-sdk-elasticloadbalancing'
|
2419
|
-
context[:gem_version] = '1.
|
2635
|
+
context[:gem_version] = '1.38.0'
|
2420
2636
|
Seahorse::Client::Request.new(handlers, context)
|
2421
2637
|
end
|
2422
2638
|
|
@@ -2433,7 +2649,7 @@ module Aws::ElasticLoadBalancing
|
|
2433
2649
|
# In between attempts, the waiter will sleep.
|
2434
2650
|
#
|
2435
2651
|
# # polls in a loop, sleeping between attempts
|
2436
|
-
# client.
|
2652
|
+
# client.wait_until(waiter_name, params)
|
2437
2653
|
#
|
2438
2654
|
# ## Configuration
|
2439
2655
|
#
|
@@ -2482,11 +2698,11 @@ module Aws::ElasticLoadBalancing
|
|
2482
2698
|
# The following table lists the valid waiter names, the operations they call,
|
2483
2699
|
# and the default `:delay` and `:max_attempts` values.
|
2484
2700
|
#
|
2485
|
-
# | waiter_name | params
|
2486
|
-
# | ----------------------- |
|
2487
|
-
# | any_instance_in_service | {#describe_instance_health} | 15 | 40 |
|
2488
|
-
# | instance_deregistered | {#describe_instance_health} | 15 | 40 |
|
2489
|
-
# | instance_in_service | {#describe_instance_health} | 15 | 40 |
|
2701
|
+
# | waiter_name | params | :delay | :max_attempts |
|
2702
|
+
# | ----------------------- | --------------------------------- | -------- | ------------- |
|
2703
|
+
# | any_instance_in_service | {Client#describe_instance_health} | 15 | 40 |
|
2704
|
+
# | instance_deregistered | {Client#describe_instance_health} | 15 | 40 |
|
2705
|
+
# | instance_in_service | {Client#describe_instance_health} | 15 | 40 |
|
2490
2706
|
#
|
2491
2707
|
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
2492
2708
|
# because the waiter has entered a state that it will not transition
|