aws-sdk-elasticloadbalancing 1.0.0.rc1 → 1.0.0.rc2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f2c241c919b2d2d404b3c418ea9f14f07849109c
4
- data.tar.gz: 8c03f479e3649d5f74d43319cc13dceeabeb8a4a
3
+ metadata.gz: 5d3d07e3bfa70174d51bf9ff451f9b38b89fcd2b
4
+ data.tar.gz: db0e3d8b3d055726b5fdfcda39a8febe5da737f3
5
5
  SHA512:
6
- metadata.gz: b8fafb0a3d4952194ba14ba5377139e88312b54fa9328500fa58e93179de61b98f685191032a1ea107927a22990d9aa438826eddfb61755c8ec5c19f495fa998
7
- data.tar.gz: bc91b49c1a59eaf8d8006efb888ab2329d8749cc5e4bfeab27f849cb3be46b0aad509a4599bcda4ec1730467f9f1b14f783425363da65d20f312eaf242e77c18
6
+ metadata.gz: fc5a97dbe359e5b4b5cfc0f6ddbfc26c8c892f173580e2b5ceecbb76cc2fb48c186acb8a4c8af2c7034e8b936bc65accae5636793e5e6fbb654dc168b251b940
7
+ data.tar.gz: 85b5ba92cfaed351ae7b1a2adaea7006aa99c86b91ba0fca44e6b3a13658ffc68001b4b404032901ae037c65413164448c55dc8758787efd08e5115e62fda0d6
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -43,6 +43,6 @@ require_relative 'aws-sdk-elasticloadbalancing/customizations'
43
43
  # @service
44
44
  module Aws::ElasticLoadBalancing
45
45
 
46
- GEM_VERSION = '1.0.0.rc1'
46
+ GEM_VERSION = '1.0.0.rc2'
47
47
 
48
48
  end
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -18,1431 +18,1666 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
18
  require 'aws-sdk-core/plugins/response_paging.rb'
19
19
  require 'aws-sdk-core/plugins/stub_responses.rb'
20
20
  require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
21
22
  require 'aws-sdk-core/plugins/signature_v4.rb'
22
23
  require 'aws-sdk-core/plugins/protocols/query.rb'
23
24
 
24
25
  Aws::Plugins::GlobalConfiguration.add_identifier(:elasticloadbalancing)
25
26
 
26
- module Aws
27
- module ElasticLoadBalancing
28
- class Client < Seahorse::Client::Base
27
+ module Aws::ElasticLoadBalancing
28
+ class Client < Seahorse::Client::Base
29
29
 
30
- include Aws::ClientStubs
30
+ include Aws::ClientStubs
31
31
 
32
- @identifier = :elasticloadbalancing
32
+ @identifier = :elasticloadbalancing
33
33
 
34
- set_api(ClientApi::API)
34
+ set_api(ClientApi::API)
35
35
 
36
- add_plugin(Seahorse::Client::Plugins::ContentLength)
37
- add_plugin(Aws::Plugins::CredentialsConfiguration)
38
- add_plugin(Aws::Plugins::Logging)
39
- add_plugin(Aws::Plugins::ParamConverter)
40
- add_plugin(Aws::Plugins::ParamValidator)
41
- add_plugin(Aws::Plugins::UserAgent)
42
- add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
- add_plugin(Aws::Plugins::RetryErrors)
44
- add_plugin(Aws::Plugins::GlobalConfiguration)
45
- add_plugin(Aws::Plugins::RegionalEndpoint)
46
- add_plugin(Aws::Plugins::ResponsePaging)
47
- add_plugin(Aws::Plugins::StubResponses)
48
- add_plugin(Aws::Plugins::IdempotencyToken)
49
- add_plugin(Aws::Plugins::SignatureV4)
50
- add_plugin(Aws::Plugins::Protocols::Query)
36
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
37
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
38
+ add_plugin(Aws::Plugins::Logging)
39
+ add_plugin(Aws::Plugins::ParamConverter)
40
+ add_plugin(Aws::Plugins::ParamValidator)
41
+ add_plugin(Aws::Plugins::UserAgent)
42
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
+ add_plugin(Aws::Plugins::RetryErrors)
44
+ add_plugin(Aws::Plugins::GlobalConfiguration)
45
+ add_plugin(Aws::Plugins::RegionalEndpoint)
46
+ add_plugin(Aws::Plugins::ResponsePaging)
47
+ add_plugin(Aws::Plugins::StubResponses)
48
+ add_plugin(Aws::Plugins::IdempotencyToken)
49
+ add_plugin(Aws::Plugins::JsonvalueConverter)
50
+ add_plugin(Aws::Plugins::SignatureV4)
51
+ add_plugin(Aws::Plugins::Protocols::Query)
51
52
 
52
- # @option options [required, Aws::CredentialProvider] :credentials
53
- # Your AWS credentials. This can be an instance of any one of the
54
- # following classes:
55
- #
56
- # * `Aws::Credentials` - Used for configuring static, non-refreshing
57
- # credentials.
58
- #
59
- # * `Aws::InstanceProfileCredentials` - Used for loading credentials
60
- # from an EC2 IMDS on an EC2 instance.
61
- #
62
- # * `Aws::SharedCredentials` - Used for loading credentials from a
63
- # shared file, such as `~/.aws/config`.
64
- #
65
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
66
- #
67
- # When `:credentials` are not configured directly, the following
68
- # locations will be searched for credentials:
69
- #
70
- # * `Aws.config[:credentials]`
71
- # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
72
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
73
- # * `~/.aws/credentials`
74
- # * `~/.aws/config`
75
- # * EC2 IMDS instance profile - When used by default, the timeouts are
76
- # very aggressive. Construct and pass an instance of
77
- # `Aws::InstanceProfileCredentails` to enable retries and extended
78
- # timeouts.
79
- # @option options [required, String] :region
80
- # The AWS region to connect to. The configured `:region` is
81
- # used to determine the service `:endpoint`. When not passed,
82
- # a default `:region` is search for in the following locations:
83
- #
84
- # * `Aws.config[:region]`
85
- # * `ENV['AWS_REGION']`
86
- # * `ENV['AMAZON_REGION']`
87
- # * `ENV['AWS_DEFAULT_REGION']`
88
- # * `~/.aws/credentials`
89
- # * `~/.aws/config`
90
- # @option options [String] :access_key_id
91
- # @option options [Boolean] :convert_params (true)
92
- # When `true`, an attempt is made to coerce request parameters into
93
- # the required types.
94
- # @option options [String] :endpoint
95
- # The client endpoint is normally constructed from the `:region`
96
- # option. You should only configure an `:endpoint` when connecting
97
- # to test endpoints. This should be avalid HTTP(S) URI.
98
- # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
99
- # The log formatter.
100
- # @option options [Symbol] :log_level (:info)
101
- # The log level to send messages to the `:logger` at.
102
- # @option options [Logger] :logger
103
- # The Logger instance to send log messages to. If this option
104
- # is not set, logging will be disabled.
105
- # @option options [String] :profile ("default")
106
- # Used when loading credentials from the shared credentials file
107
- # at HOME/.aws/credentials. When not specified, 'default' is used.
108
- # @option options [Integer] :retry_limit (3)
109
- # The maximum number of times to retry failed requests. Only
110
- # ~ 500 level server errors and certain ~ 400 level client errors
111
- # are retried. Generally, these are throttling errors, data
112
- # checksum errors, networking errors, timeout errors and auth
113
- # errors from expired credentials.
114
- # @option options [String] :secret_access_key
115
- # @option options [String] :session_token
116
- # @option options [Boolean] :stub_responses (false)
117
- # Causes the client to return stubbed responses. By default
118
- # fake responses are generated and returned. You can specify
119
- # the response data to return or errors to raise by calling
120
- # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
121
- #
122
- # ** Please note ** When response stubbing is enabled, no HTTP
123
- # requests are made, and retries are disabled.
124
- # @option options [Boolean] :validate_params (true)
125
- # When `true`, request parameters are validated before
126
- # sending the request.
127
- def initialize(*args)
128
- super
129
- end
53
+ # @option options [required, Aws::CredentialProvider] :credentials
54
+ # Your AWS credentials. This can be an instance of any one of the
55
+ # following classes:
56
+ #
57
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
58
+ # credentials.
59
+ #
60
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
61
+ # from an EC2 IMDS on an EC2 instance.
62
+ #
63
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
64
+ # shared file, such as `~/.aws/config`.
65
+ #
66
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
67
+ #
68
+ # When `:credentials` are not configured directly, the following
69
+ # locations will be searched for credentials:
70
+ #
71
+ # * `Aws.config[:credentials]`
72
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
73
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
74
+ # * `~/.aws/credentials`
75
+ # * `~/.aws/config`
76
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
77
+ # very aggressive. Construct and pass an instance of
78
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
79
+ # timeouts.
80
+ #
81
+ # @option options [required, String] :region
82
+ # The AWS region to connect to. The configured `:region` is
83
+ # used to determine the service `:endpoint`. When not passed,
84
+ # a default `:region` is search for in the following locations:
85
+ #
86
+ # * `Aws.config[:region]`
87
+ # * `ENV['AWS_REGION']`
88
+ # * `ENV['AMAZON_REGION']`
89
+ # * `ENV['AWS_DEFAULT_REGION']`
90
+ # * `~/.aws/credentials`
91
+ # * `~/.aws/config`
92
+ #
93
+ # @option options [String] :access_key_id
94
+ #
95
+ # @option options [Boolean] :convert_params (true)
96
+ # When `true`, an attempt is made to coerce request parameters into
97
+ # the required types.
98
+ #
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
+ #
104
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
105
+ # The log formatter.
106
+ #
107
+ # @option options [Symbol] :log_level (:info)
108
+ # The log level to send messages to the `:logger` at.
109
+ #
110
+ # @option options [Logger] :logger
111
+ # The Logger instance to send log messages to. If this option
112
+ # is not set, logging will be disabled.
113
+ #
114
+ # @option options [String] :profile ("default")
115
+ # Used when loading credentials from the shared credentials file
116
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
117
+ #
118
+ # @option options [Integer] :retry_limit (3)
119
+ # The maximum number of times to retry failed requests. Only
120
+ # ~ 500 level server errors and certain ~ 400 level client errors
121
+ # are retried. Generally, these are throttling errors, data
122
+ # checksum errors, networking errors, timeout errors and auth
123
+ # errors from expired credentials.
124
+ #
125
+ # @option options [String] :secret_access_key
126
+ #
127
+ # @option options [String] :session_token
128
+ #
129
+ # @option options [Boolean] :stub_responses (false)
130
+ # Causes the client to return stubbed responses. By default
131
+ # fake responses are generated and returned. You can specify
132
+ # the response data to return or errors to raise by calling
133
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
134
+ #
135
+ # ** Please note ** When response stubbing is enabled, no HTTP
136
+ # requests are made, and retries are disabled.
137
+ #
138
+ # @option options [Boolean] :validate_params (true)
139
+ # When `true`, request parameters are validated before
140
+ # sending the request.
141
+ #
142
+ def initialize(*args)
143
+ super
144
+ end
130
145
 
131
- # @!group API Operations
146
+ # @!group API Operations
132
147
 
133
- # Adds the specified tags to the specified load balancer. Each load
134
- # balancer can have a maximum of 10 tags.
135
- #
136
- # Each tag consists of a key and an optional value. If a tag with the
137
- # same key is already associated with the load balancer, `AddTags`
138
- # updates its value.
139
- #
140
- # For more information, see [Tag Your Classic Load Balancer][1] in the
141
- # *Classic Load Balancers Guide*.
142
- #
143
- #
144
- #
145
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html
146
- # @option params [required, Array<String>] :load_balancer_names
147
- # The name of the load balancer. You can specify one load balancer only.
148
- # @option params [required, Array<Types::Tag>] :tags
149
- # The tags.
150
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
151
- #
152
- # @example Request syntax with placeholder values
153
- # resp = client.add_tags({
154
- # load_balancer_names: ["AccessPointName"], # required
155
- # tags: [ # required
156
- # {
157
- # key: "TagKey", # required
158
- # value: "TagValue",
159
- # },
160
- # ],
161
- # })
162
- # @overload add_tags(params = {})
163
- # @param [Hash] params ({})
164
- def add_tags(params = {}, options = {})
165
- req = build_request(:add_tags, params)
166
- req.send_request(options)
167
- end
168
-
169
- # Associates one or more security groups with your load balancer in a
170
- # virtual private cloud (VPC). The specified security groups override
171
- # the previously associated security groups.
172
- #
173
- # For more information, see [Security Groups for Load Balancers in a
174
- # VPC][1] in the *Classic Load Balancers Guide*.
175
- #
176
- #
177
- #
178
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-security-groups.html#elb-vpc-security-groups
179
- # @option params [required, String] :load_balancer_name
180
- # The name of the load balancer.
181
- # @option params [required, Array<String>] :security_groups
182
- # The IDs of the security groups to associate with the load balancer.
183
- # Note that you cannot specify the name of the security group.
184
- # @return [Types::ApplySecurityGroupsToLoadBalancerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
185
- #
186
- # * {Types::ApplySecurityGroupsToLoadBalancerOutput#security_groups #SecurityGroups} => Array&lt;String&gt;
187
- #
188
- # @example Request syntax with placeholder values
189
- # resp = client.apply_security_groups_to_load_balancer({
190
- # load_balancer_name: "AccessPointName", # required
191
- # security_groups: ["SecurityGroupId"], # required
192
- # })
193
- #
194
- # @example Response structure
195
- # resp.security_groups #=> Array
196
- # resp.security_groups[0] #=> String
197
- # @overload apply_security_groups_to_load_balancer(params = {})
198
- # @param [Hash] params ({})
199
- def apply_security_groups_to_load_balancer(params = {}, options = {})
200
- req = build_request(:apply_security_groups_to_load_balancer, params)
201
- req.send_request(options)
202
- end
148
+ # Adds the specified tags to the specified load balancer. Each load
149
+ # balancer can have a maximum of 10 tags.
150
+ #
151
+ # Each tag consists of a key and an optional value. If a tag with the
152
+ # same key is already associated with the load balancer, `AddTags`
153
+ # updates its value.
154
+ #
155
+ # For more information, see [Tag Your Classic Load Balancer][1] in the
156
+ # *Classic Load Balancers Guide*.
157
+ #
158
+ #
159
+ #
160
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html
161
+ #
162
+ # @option params [required, Array<String>] :load_balancer_names
163
+ # The name of the load balancer. You can specify one load balancer only.
164
+ #
165
+ # @option params [required, Array<Types::Tag>] :tags
166
+ # The tags.
167
+ #
168
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
169
+ #
170
+ # @example Request syntax with placeholder values
171
+ #
172
+ # resp = client.add_tags({
173
+ # load_balancer_names: ["AccessPointName"], # required
174
+ # tags: [ # required
175
+ # {
176
+ # key: "TagKey", # required
177
+ # value: "TagValue",
178
+ # },
179
+ # ],
180
+ # })
181
+ #
182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/AddTags AWS API Documentation
183
+ #
184
+ # @overload add_tags(params = {})
185
+ # @param [Hash] params ({})
186
+ def add_tags(params = {}, options = {})
187
+ req = build_request(:add_tags, params)
188
+ req.send_request(options)
189
+ end
203
190
 
204
- # Adds one or more subnets to the set of configured subnets for the
205
- # specified load balancer.
206
- #
207
- # The load balancer evenly distributes requests across all registered
208
- # subnets. For more information, see [Add or Remove Subnets for Your
209
- # Load Balancer in a VPC][1] in the *Classic Load Balancers Guide*.
210
- #
211
- #
212
- #
213
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-manage-subnets.html
214
- # @option params [required, String] :load_balancer_name
215
- # The name of the load balancer.
216
- # @option params [required, Array<String>] :subnets
217
- # The IDs of the subnets to add. You can add only one subnet per
218
- # Availability Zone.
219
- # @return [Types::AttachLoadBalancerToSubnetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
220
- #
221
- # * {Types::AttachLoadBalancerToSubnetsOutput#subnets #Subnets} => Array&lt;String&gt;
222
- #
223
- # @example Request syntax with placeholder values
224
- # resp = client.attach_load_balancer_to_subnets({
225
- # load_balancer_name: "AccessPointName", # required
226
- # subnets: ["SubnetId"], # required
227
- # })
228
- #
229
- # @example Response structure
230
- # resp.subnets #=> Array
231
- # resp.subnets[0] #=> String
232
- # @overload attach_load_balancer_to_subnets(params = {})
233
- # @param [Hash] params ({})
234
- def attach_load_balancer_to_subnets(params = {}, options = {})
235
- req = build_request(:attach_load_balancer_to_subnets, params)
236
- req.send_request(options)
237
- end
191
+ # Associates one or more security groups with your load balancer in a
192
+ # virtual private cloud (VPC). The specified security groups override
193
+ # the previously associated security groups.
194
+ #
195
+ # For more information, see [Security Groups for Load Balancers in a
196
+ # VPC][1] in the *Classic Load Balancers Guide*.
197
+ #
198
+ #
199
+ #
200
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-security-groups.html#elb-vpc-security-groups
201
+ #
202
+ # @option params [required, String] :load_balancer_name
203
+ # The name of the load balancer.
204
+ #
205
+ # @option params [required, Array<String>] :security_groups
206
+ # The IDs of the security groups to associate with the load balancer.
207
+ # Note that you cannot specify the name of the security group.
208
+ #
209
+ # @return [Types::ApplySecurityGroupsToLoadBalancerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
210
+ #
211
+ # * {Types::ApplySecurityGroupsToLoadBalancerOutput#security_groups #security_groups} => Array&lt;String&gt;
212
+ #
213
+ # @example Request syntax with placeholder values
214
+ #
215
+ # resp = client.apply_security_groups_to_load_balancer({
216
+ # load_balancer_name: "AccessPointName", # required
217
+ # security_groups: ["SecurityGroupId"], # required
218
+ # })
219
+ #
220
+ # @example Response structure
221
+ #
222
+ # resp.security_groups #=> Array
223
+ # resp.security_groups[0] #=> String
224
+ #
225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/ApplySecurityGroupsToLoadBalancer AWS API Documentation
226
+ #
227
+ # @overload apply_security_groups_to_load_balancer(params = {})
228
+ # @param [Hash] params ({})
229
+ def apply_security_groups_to_load_balancer(params = {}, options = {})
230
+ req = build_request(:apply_security_groups_to_load_balancer, params)
231
+ req.send_request(options)
232
+ end
238
233
 
239
- # Specifies the health check settings to use when evaluating the health
240
- # state of your EC2 instances.
241
- #
242
- # For more information, see [Configure Health Checks for Your Load
243
- # Balancer][1] in the *Classic Load Balancers Guide*.
244
- #
245
- #
246
- #
247
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-healthchecks.html
248
- # @option params [required, String] :load_balancer_name
249
- # The name of the load balancer.
250
- # @option params [required, Types::HealthCheck] :health_check
251
- # The configuration information.
252
- # @return [Types::ConfigureHealthCheckOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
253
- #
254
- # * {Types::ConfigureHealthCheckOutput#health_check #HealthCheck} => Types::HealthCheck
255
- #
256
- # @example Request syntax with placeholder values
257
- # resp = client.configure_health_check({
258
- # load_balancer_name: "AccessPointName", # required
259
- # health_check: { # required
260
- # target: "HealthCheckTarget", # required
261
- # interval: 1, # required
262
- # timeout: 1, # required
263
- # unhealthy_threshold: 1, # required
264
- # healthy_threshold: 1, # required
265
- # },
266
- # })
267
- #
268
- # @example Response structure
269
- # resp.health_check.target #=> String
270
- # resp.health_check.interval #=> Integer
271
- # resp.health_check.timeout #=> Integer
272
- # resp.health_check.unhealthy_threshold #=> Integer
273
- # resp.health_check.healthy_threshold #=> Integer
274
- # @overload configure_health_check(params = {})
275
- # @param [Hash] params ({})
276
- def configure_health_check(params = {}, options = {})
277
- req = build_request(:configure_health_check, params)
278
- req.send_request(options)
279
- end
234
+ # Adds one or more subnets to the set of configured subnets for the
235
+ # specified load balancer.
236
+ #
237
+ # The load balancer evenly distributes requests across all registered
238
+ # subnets. For more information, see [Add or Remove Subnets for Your
239
+ # Load Balancer in a VPC][1] in the *Classic Load Balancers Guide*.
240
+ #
241
+ #
242
+ #
243
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-manage-subnets.html
244
+ #
245
+ # @option params [required, String] :load_balancer_name
246
+ # The name of the load balancer.
247
+ #
248
+ # @option params [required, Array<String>] :subnets
249
+ # The IDs of the subnets to add. You can add only one subnet per
250
+ # Availability Zone.
251
+ #
252
+ # @return [Types::AttachLoadBalancerToSubnetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
253
+ #
254
+ # * {Types::AttachLoadBalancerToSubnetsOutput#subnets #subnets} => Array&lt;String&gt;
255
+ #
256
+ # @example Request syntax with placeholder values
257
+ #
258
+ # resp = client.attach_load_balancer_to_subnets({
259
+ # load_balancer_name: "AccessPointName", # required
260
+ # subnets: ["SubnetId"], # required
261
+ # })
262
+ #
263
+ # @example Response structure
264
+ #
265
+ # resp.subnets #=> Array
266
+ # resp.subnets[0] #=> String
267
+ #
268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/AttachLoadBalancerToSubnets AWS API Documentation
269
+ #
270
+ # @overload attach_load_balancer_to_subnets(params = {})
271
+ # @param [Hash] params ({})
272
+ def attach_load_balancer_to_subnets(params = {}, options = {})
273
+ req = build_request(:attach_load_balancer_to_subnets, params)
274
+ req.send_request(options)
275
+ end
280
276
 
281
- # Generates a stickiness policy with sticky session lifetimes that
282
- # follow that of an application-generated cookie. This policy can be
283
- # associated only with HTTP/HTTPS listeners.
284
- #
285
- # This policy is similar to the policy created by
286
- # CreateLBCookieStickinessPolicy, except that the lifetime of the
287
- # special Elastic Load Balancing cookie, `AWSELB`, follows the lifetime
288
- # of the application-generated cookie specified in the policy
289
- # configuration. The load balancer only inserts a new stickiness cookie
290
- # when the application response includes a new application cookie.
291
- #
292
- # If the application cookie is explicitly removed or expires, the
293
- # session stops being sticky until a new application cookie is issued.
294
- #
295
- # For more information, see [Application-Controlled Session
296
- # Stickiness][1] in the *Classic Load Balancers Guide*.
297
- #
298
- #
299
- #
300
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application
301
- # @option params [required, String] :load_balancer_name
302
- # The name of the load balancer.
303
- # @option params [required, String] :policy_name
304
- # The name of the policy being created. Policy names must consist of
305
- # alphanumeric characters and dashes (-). This name must be unique
306
- # within the set of policies for this load balancer.
307
- # @option params [required, String] :cookie_name
308
- # The name of the application cookie used for stickiness.
309
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
310
- #
311
- # @example Request syntax with placeholder values
312
- # resp = client.create_app_cookie_stickiness_policy({
313
- # load_balancer_name: "AccessPointName", # required
314
- # policy_name: "PolicyName", # required
315
- # cookie_name: "CookieName", # required
316
- # })
317
- # @overload create_app_cookie_stickiness_policy(params = {})
318
- # @param [Hash] params ({})
319
- def create_app_cookie_stickiness_policy(params = {}, options = {})
320
- req = build_request(:create_app_cookie_stickiness_policy, params)
321
- req.send_request(options)
322
- end
277
+ # Specifies the health check settings to use when evaluating the health
278
+ # state of your EC2 instances.
279
+ #
280
+ # For more information, see [Configure Health Checks for Your Load
281
+ # Balancer][1] in the *Classic Load Balancers Guide*.
282
+ #
283
+ #
284
+ #
285
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-healthchecks.html
286
+ #
287
+ # @option params [required, String] :load_balancer_name
288
+ # The name of the load balancer.
289
+ #
290
+ # @option params [required, Types::HealthCheck] :health_check
291
+ # The configuration information.
292
+ #
293
+ # @return [Types::ConfigureHealthCheckOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
294
+ #
295
+ # * {Types::ConfigureHealthCheckOutput#health_check #health_check} => Types::HealthCheck
296
+ #
297
+ # @example Request syntax with placeholder values
298
+ #
299
+ # resp = client.configure_health_check({
300
+ # load_balancer_name: "AccessPointName", # required
301
+ # health_check: { # required
302
+ # target: "HealthCheckTarget", # required
303
+ # interval: 1, # required
304
+ # timeout: 1, # required
305
+ # unhealthy_threshold: 1, # required
306
+ # healthy_threshold: 1, # required
307
+ # },
308
+ # })
309
+ #
310
+ # @example Response structure
311
+ #
312
+ # resp.health_check.target #=> String
313
+ # resp.health_check.interval #=> Integer
314
+ # resp.health_check.timeout #=> Integer
315
+ # resp.health_check.unhealthy_threshold #=> Integer
316
+ # resp.health_check.healthy_threshold #=> Integer
317
+ #
318
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/ConfigureHealthCheck AWS API Documentation
319
+ #
320
+ # @overload configure_health_check(params = {})
321
+ # @param [Hash] params ({})
322
+ def configure_health_check(params = {}, options = {})
323
+ req = build_request(:configure_health_check, params)
324
+ req.send_request(options)
325
+ end
323
326
 
324
- # Generates a stickiness policy with sticky session lifetimes controlled
325
- # by the lifetime of the browser (user-agent) or a specified expiration
326
- # period. This policy can be associated only with HTTP/HTTPS listeners.
327
- #
328
- # When a load balancer implements this policy, the load balancer uses a
329
- # special cookie to track the instance for each request. When the load
330
- # balancer receives a request, it first checks to see if this cookie is
331
- # present in the request. If so, the load balancer sends the request to
332
- # the application server specified in the cookie. If not, the load
333
- # balancer sends the request to a server that is chosen based on the
334
- # existing load-balancing algorithm.
335
- #
336
- # A cookie is inserted into the response for binding subsequent requests
337
- # from the same user to that server. The validity of the cookie is based
338
- # on the cookie expiration time, which is specified in the policy
339
- # configuration.
340
- #
341
- # For more information, see [Duration-Based Session Stickiness][1] in
342
- # the *Classic Load Balancers Guide*.
343
- #
344
- #
345
- #
346
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration
347
- # @option params [required, String] :load_balancer_name
348
- # The name of the load balancer.
349
- # @option params [required, String] :policy_name
350
- # The name of the policy being created. Policy names must consist of
351
- # alphanumeric characters and dashes (-). This name must be unique
352
- # within the set of policies for this load balancer.
353
- # @option params [Integer] :cookie_expiration_period
354
- # The time period, in seconds, after which the cookie should be
355
- # considered stale. If you do not specify this parameter, the default
356
- # value is 0, which indicates that the sticky session should last for
357
- # the duration of the browser session.
358
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
359
- #
360
- # @example Request syntax with placeholder values
361
- # resp = client.create_lb_cookie_stickiness_policy({
362
- # load_balancer_name: "AccessPointName", # required
363
- # policy_name: "PolicyName", # required
364
- # cookie_expiration_period: 1,
365
- # })
366
- # @overload create_lb_cookie_stickiness_policy(params = {})
367
- # @param [Hash] params ({})
368
- def create_lb_cookie_stickiness_policy(params = {}, options = {})
369
- req = build_request(:create_lb_cookie_stickiness_policy, params)
370
- req.send_request(options)
371
- end
327
+ # Generates a stickiness policy with sticky session lifetimes that
328
+ # follow that of an application-generated cookie. This policy can be
329
+ # associated only with HTTP/HTTPS listeners.
330
+ #
331
+ # This policy is similar to the policy created by
332
+ # CreateLBCookieStickinessPolicy, except that the lifetime of the
333
+ # special Elastic Load Balancing cookie, `AWSELB`, follows the lifetime
334
+ # of the application-generated cookie specified in the policy
335
+ # configuration. The load balancer only inserts a new stickiness cookie
336
+ # when the application response includes a new application cookie.
337
+ #
338
+ # If the application cookie is explicitly removed or expires, the
339
+ # session stops being sticky until a new application cookie is issued.
340
+ #
341
+ # For more information, see [Application-Controlled Session
342
+ # Stickiness][1] in the *Classic Load Balancers Guide*.
343
+ #
344
+ #
345
+ #
346
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application
347
+ #
348
+ # @option params [required, String] :load_balancer_name
349
+ # The name of the load balancer.
350
+ #
351
+ # @option params [required, String] :policy_name
352
+ # The name of the policy being created. Policy names must consist of
353
+ # alphanumeric characters and dashes (-). This name must be unique
354
+ # within the set of policies for this load balancer.
355
+ #
356
+ # @option params [required, String] :cookie_name
357
+ # The name of the application cookie used for stickiness.
358
+ #
359
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
360
+ #
361
+ # @example Request syntax with placeholder values
362
+ #
363
+ # resp = client.create_app_cookie_stickiness_policy({
364
+ # load_balancer_name: "AccessPointName", # required
365
+ # policy_name: "PolicyName", # required
366
+ # cookie_name: "CookieName", # required
367
+ # })
368
+ #
369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/CreateAppCookieStickinessPolicy AWS API Documentation
370
+ #
371
+ # @overload create_app_cookie_stickiness_policy(params = {})
372
+ # @param [Hash] params ({})
373
+ def create_app_cookie_stickiness_policy(params = {}, options = {})
374
+ req = build_request(:create_app_cookie_stickiness_policy, params)
375
+ req.send_request(options)
376
+ end
372
377
 
373
- # Creates a Classic load balancer.
374
- #
375
- # You can add listeners, security groups, subnets, and tags when you
376
- # create your load balancer, or you can add them later using
377
- # CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer,
378
- # AttachLoadBalancerToSubnets, and AddTags.
379
- #
380
- # To describe your current load balancers, see DescribeLoadBalancers.
381
- # When you are finished with a load balancer, you can delete it using
382
- # DeleteLoadBalancer.
383
- #
384
- # You can create up to 20 load balancers per region per account. You can
385
- # request an increase for the number of load balancers for your account.
386
- # For more information, see [Limits for Your Classic Load Balancer][1]
387
- # in the *Classic Load Balancers Guide*.
388
- #
389
- #
390
- #
391
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html
392
- # @option params [required, String] :load_balancer_name
393
- # The name of the load balancer.
394
- #
395
- # This name must be unique within your set of load balancers for the
396
- # region, must have a maximum of 32 characters, must contain only
397
- # alphanumeric characters or hyphens, and cannot begin or end with a
398
- # hyphen.
399
- # @option params [required, Array<Types::Listener>] :listeners
400
- # The listeners.
401
- #
402
- # For more information, see [Listeners for Your Classic Load
403
- # Balancer][1] in the *Classic Load Balancers Guide*.
404
- #
405
- #
406
- #
407
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html
408
- # @option params [Array<String>] :availability_zones
409
- # One or more Availability Zones from the same region as the load
410
- # balancer.
411
- #
412
- # You must specify at least one Availability Zone.
413
- #
414
- # You can add more Availability Zones after you create the load balancer
415
- # using EnableAvailabilityZonesForLoadBalancer.
416
- # @option params [Array<String>] :subnets
417
- # The IDs of the subnets in your VPC to attach to the load balancer.
418
- # Specify one subnet per Availability Zone specified in
419
- # `AvailabilityZones`.
420
- # @option params [Array<String>] :security_groups
421
- # The IDs of the security groups to assign to the load balancer.
422
- # @option params [String] :scheme
423
- # The type of a load balancer. Valid only for load balancers in a VPC.
424
- #
425
- # By default, Elastic Load Balancing creates an Internet-facing load
426
- # balancer with a DNS name that resolves to public IP addresses. For
427
- # more information about Internet-facing and Internal load balancers,
428
- # see [Load Balancer Scheme][1] in the *Elastic Load Balancing User
429
- # Guide*.
430
- #
431
- # Specify `internal` to create a load balancer with a DNS name that
432
- # resolves to private IP addresses.
433
- #
434
- #
435
- #
436
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/how-elastic-load-balancing-works.html#load-balancer-scheme
437
- # @option params [Array<Types::Tag>] :tags
438
- # A list of tags to assign to the load balancer.
439
- #
440
- # For more information about tagging your load balancer, see [Tag Your
441
- # Classic Load Balancer][1] in the *Classic Load Balancers Guide*.
442
- #
443
- #
444
- #
445
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html
446
- # @return [Types::CreateAccessPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
447
- #
448
- # * {Types::CreateAccessPointOutput#dns_name #DNSName} => String
449
- #
450
- # @example Request syntax with placeholder values
451
- # resp = client.create_load_balancer({
452
- # load_balancer_name: "AccessPointName", # required
453
- # listeners: [ # required
454
- # {
455
- # protocol: "Protocol", # required
456
- # load_balancer_port: 1, # required
457
- # instance_protocol: "Protocol",
458
- # instance_port: 1, # required
459
- # ssl_certificate_id: "SSLCertificateId",
460
- # },
461
- # ],
462
- # availability_zones: ["AvailabilityZone"],
463
- # subnets: ["SubnetId"],
464
- # security_groups: ["SecurityGroupId"],
465
- # scheme: "LoadBalancerScheme",
466
- # tags: [
467
- # {
468
- # key: "TagKey", # required
469
- # value: "TagValue",
470
- # },
471
- # ],
472
- # })
473
- #
474
- # @example Response structure
475
- # resp.dns_name #=> String
476
- # @overload create_load_balancer(params = {})
477
- # @param [Hash] params ({})
478
- def create_load_balancer(params = {}, options = {})
479
- req = build_request(:create_load_balancer, params)
480
- req.send_request(options)
481
- end
378
+ # Generates a stickiness policy with sticky session lifetimes controlled
379
+ # by the lifetime of the browser (user-agent) or a specified expiration
380
+ # period. This policy can be associated only with HTTP/HTTPS listeners.
381
+ #
382
+ # When a load balancer implements this policy, the load balancer uses a
383
+ # special cookie to track the instance for each request. When the load
384
+ # balancer receives a request, it first checks to see if this cookie is
385
+ # present in the request. If so, the load balancer sends the request to
386
+ # the application server specified in the cookie. If not, the load
387
+ # balancer sends the request to a server that is chosen based on the
388
+ # existing load-balancing algorithm.
389
+ #
390
+ # A cookie is inserted into the response for binding subsequent requests
391
+ # from the same user to that server. The validity of the cookie is based
392
+ # on the cookie expiration time, which is specified in the policy
393
+ # configuration.
394
+ #
395
+ # For more information, see [Duration-Based Session Stickiness][1] in
396
+ # the *Classic Load Balancers Guide*.
397
+ #
398
+ #
399
+ #
400
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration
401
+ #
402
+ # @option params [required, String] :load_balancer_name
403
+ # The name of the load balancer.
404
+ #
405
+ # @option params [required, String] :policy_name
406
+ # The name of the policy being created. Policy names must consist of
407
+ # alphanumeric characters and dashes (-). This name must be unique
408
+ # within the set of policies for this load balancer.
409
+ #
410
+ # @option params [Integer] :cookie_expiration_period
411
+ # The time period, in seconds, after which the cookie should be
412
+ # considered stale. If you do not specify this parameter, the default
413
+ # value is 0, which indicates that the sticky session should last for
414
+ # the duration of the browser session.
415
+ #
416
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
417
+ #
418
+ # @example Request syntax with placeholder values
419
+ #
420
+ # resp = client.create_lb_cookie_stickiness_policy({
421
+ # load_balancer_name: "AccessPointName", # required
422
+ # policy_name: "PolicyName", # required
423
+ # cookie_expiration_period: 1,
424
+ # })
425
+ #
426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/CreateLBCookieStickinessPolicy AWS API Documentation
427
+ #
428
+ # @overload create_lb_cookie_stickiness_policy(params = {})
429
+ # @param [Hash] params ({})
430
+ def create_lb_cookie_stickiness_policy(params = {}, options = {})
431
+ req = build_request(:create_lb_cookie_stickiness_policy, params)
432
+ req.send_request(options)
433
+ end
482
434
 
483
- # Creates one or more listeners for the specified load balancer. If a
484
- # listener with the specified port does not already exist, it is
485
- # created; otherwise, the properties of the new listener must match the
486
- # properties of the existing listener.
487
- #
488
- # For more information, see [Listeners for Your Classic Load
489
- # Balancer][1] in the *Classic Load Balancers Guide*.
490
- #
491
- #
492
- #
493
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html
494
- # @option params [required, String] :load_balancer_name
495
- # The name of the load balancer.
496
- # @option params [required, Array<Types::Listener>] :listeners
497
- # The listeners.
498
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
499
- #
500
- # @example Request syntax with placeholder values
501
- # resp = client.create_load_balancer_listeners({
502
- # load_balancer_name: "AccessPointName", # required
503
- # listeners: [ # required
504
- # {
505
- # protocol: "Protocol", # required
506
- # load_balancer_port: 1, # required
507
- # instance_protocol: "Protocol",
508
- # instance_port: 1, # required
509
- # ssl_certificate_id: "SSLCertificateId",
510
- # },
511
- # ],
512
- # })
513
- # @overload create_load_balancer_listeners(params = {})
514
- # @param [Hash] params ({})
515
- def create_load_balancer_listeners(params = {}, options = {})
516
- req = build_request(:create_load_balancer_listeners, params)
517
- req.send_request(options)
518
- end
435
+ # Creates a Classic load balancer.
436
+ #
437
+ # You can add listeners, security groups, subnets, and tags when you
438
+ # create your load balancer, or you can add them later using
439
+ # CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer,
440
+ # AttachLoadBalancerToSubnets, and AddTags.
441
+ #
442
+ # To describe your current load balancers, see DescribeLoadBalancers.
443
+ # When you are finished with a load balancer, you can delete it using
444
+ # DeleteLoadBalancer.
445
+ #
446
+ # You can create up to 20 load balancers per region per account. You can
447
+ # request an increase for the number of load balancers for your account.
448
+ # For more information, see [Limits for Your Classic Load Balancer][1]
449
+ # in the *Classic Load Balancers Guide*.
450
+ #
451
+ #
452
+ #
453
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html
454
+ #
455
+ # @option params [required, String] :load_balancer_name
456
+ # The name of the load balancer.
457
+ #
458
+ # This name must be unique within your set of load balancers for the
459
+ # region, must have a maximum of 32 characters, must contain only
460
+ # alphanumeric characters or hyphens, and cannot begin or end with a
461
+ # hyphen.
462
+ #
463
+ # @option params [required, Array<Types::Listener>] :listeners
464
+ # The listeners.
465
+ #
466
+ # For more information, see [Listeners for Your Classic Load
467
+ # Balancer][1] in the *Classic Load Balancers Guide*.
468
+ #
469
+ #
470
+ #
471
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html
472
+ #
473
+ # @option params [Array<String>] :availability_zones
474
+ # One or more Availability Zones from the same region as the load
475
+ # balancer.
476
+ #
477
+ # You must specify at least one Availability Zone.
478
+ #
479
+ # You can add more Availability Zones after you create the load balancer
480
+ # using EnableAvailabilityZonesForLoadBalancer.
481
+ #
482
+ # @option params [Array<String>] :subnets
483
+ # The IDs of the subnets in your VPC to attach to the load balancer.
484
+ # Specify one subnet per Availability Zone specified in
485
+ # `AvailabilityZones`.
486
+ #
487
+ # @option params [Array<String>] :security_groups
488
+ # The IDs of the security groups to assign to the load balancer.
489
+ #
490
+ # @option params [String] :scheme
491
+ # The type of a load balancer. Valid only for load balancers in a VPC.
492
+ #
493
+ # By default, Elastic Load Balancing creates an Internet-facing load
494
+ # balancer with a DNS name that resolves to public IP addresses. For
495
+ # more information about Internet-facing and Internal load balancers,
496
+ # see [Load Balancer Scheme][1] in the *Elastic Load Balancing User
497
+ # Guide*.
498
+ #
499
+ # Specify `internal` to create a load balancer with a DNS name that
500
+ # resolves to private IP addresses.
501
+ #
502
+ #
503
+ #
504
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/how-elastic-load-balancing-works.html#load-balancer-scheme
505
+ #
506
+ # @option params [Array<Types::Tag>] :tags
507
+ # A list of tags to assign to the load balancer.
508
+ #
509
+ # For more information about tagging your load balancer, see [Tag Your
510
+ # Classic Load Balancer][1] in the *Classic Load Balancers Guide*.
511
+ #
512
+ #
513
+ #
514
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html
515
+ #
516
+ # @return [Types::CreateAccessPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
517
+ #
518
+ # * {Types::CreateAccessPointOutput#dns_name #dns_name} => String
519
+ #
520
+ # @example Request syntax with placeholder values
521
+ #
522
+ # resp = client.create_load_balancer({
523
+ # load_balancer_name: "AccessPointName", # required
524
+ # listeners: [ # required
525
+ # {
526
+ # protocol: "Protocol", # required
527
+ # load_balancer_port: 1, # required
528
+ # instance_protocol: "Protocol",
529
+ # instance_port: 1, # required
530
+ # ssl_certificate_id: "SSLCertificateId",
531
+ # },
532
+ # ],
533
+ # availability_zones: ["AvailabilityZone"],
534
+ # subnets: ["SubnetId"],
535
+ # security_groups: ["SecurityGroupId"],
536
+ # scheme: "LoadBalancerScheme",
537
+ # tags: [
538
+ # {
539
+ # key: "TagKey", # required
540
+ # value: "TagValue",
541
+ # },
542
+ # ],
543
+ # })
544
+ #
545
+ # @example Response structure
546
+ #
547
+ # resp.dns_name #=> String
548
+ #
549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/CreateLoadBalancer AWS API Documentation
550
+ #
551
+ # @overload create_load_balancer(params = {})
552
+ # @param [Hash] params ({})
553
+ def create_load_balancer(params = {}, options = {})
554
+ req = build_request(:create_load_balancer, params)
555
+ req.send_request(options)
556
+ end
519
557
 
520
- # Creates a policy with the specified attributes for the specified load
521
- # balancer.
522
- #
523
- # Policies are settings that are saved for your load balancer and that
524
- # can be applied to the listener or the application server, depending on
525
- # the policy type.
526
- # @option params [required, String] :load_balancer_name
527
- # The name of the load balancer.
528
- # @option params [required, String] :policy_name
529
- # The name of the load balancer policy to be created. This name must be
530
- # unique within the set of policies for this load balancer.
531
- # @option params [required, String] :policy_type_name
532
- # The name of the base policy type. To get the list of policy types, use
533
- # DescribeLoadBalancerPolicyTypes.
534
- # @option params [Array<Types::PolicyAttribute>] :policy_attributes
535
- # The policy attributes.
536
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
537
- #
538
- # @example Request syntax with placeholder values
539
- # resp = client.create_load_balancer_policy({
540
- # load_balancer_name: "AccessPointName", # required
541
- # policy_name: "PolicyName", # required
542
- # policy_type_name: "PolicyTypeName", # required
543
- # policy_attributes: [
544
- # {
545
- # attribute_name: "AttributeName",
546
- # attribute_value: "AttributeValue",
547
- # },
548
- # ],
549
- # })
550
- # @overload create_load_balancer_policy(params = {})
551
- # @param [Hash] params ({})
552
- def create_load_balancer_policy(params = {}, options = {})
553
- req = build_request(:create_load_balancer_policy, params)
554
- req.send_request(options)
555
- end
558
+ # Creates one or more listeners for the specified load balancer. If a
559
+ # listener with the specified port does not already exist, it is
560
+ # created; otherwise, the properties of the new listener must match the
561
+ # properties of the existing listener.
562
+ #
563
+ # For more information, see [Listeners for Your Classic Load
564
+ # Balancer][1] in the *Classic Load Balancers Guide*.
565
+ #
566
+ #
567
+ #
568
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html
569
+ #
570
+ # @option params [required, String] :load_balancer_name
571
+ # The name of the load balancer.
572
+ #
573
+ # @option params [required, Array<Types::Listener>] :listeners
574
+ # The listeners.
575
+ #
576
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
577
+ #
578
+ # @example Request syntax with placeholder values
579
+ #
580
+ # resp = client.create_load_balancer_listeners({
581
+ # load_balancer_name: "AccessPointName", # required
582
+ # listeners: [ # required
583
+ # {
584
+ # protocol: "Protocol", # required
585
+ # load_balancer_port: 1, # required
586
+ # instance_protocol: "Protocol",
587
+ # instance_port: 1, # required
588
+ # ssl_certificate_id: "SSLCertificateId",
589
+ # },
590
+ # ],
591
+ # })
592
+ #
593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/CreateLoadBalancerListeners AWS API Documentation
594
+ #
595
+ # @overload create_load_balancer_listeners(params = {})
596
+ # @param [Hash] params ({})
597
+ def create_load_balancer_listeners(params = {}, options = {})
598
+ req = build_request(:create_load_balancer_listeners, params)
599
+ req.send_request(options)
600
+ end
556
601
 
557
- # Deletes the specified load balancer.
558
- #
559
- # If you are attempting to recreate a load balancer, you must
560
- # reconfigure all settings. The DNS name associated with a deleted load
561
- # balancer are no longer usable. The name and associated DNS record of
562
- # the deleted load balancer no longer exist and traffic sent to any of
563
- # its IP addresses is no longer delivered to your instances.
564
- #
565
- # If the load balancer does not exist or has already been deleted, the
566
- # call to `DeleteLoadBalancer` still succeeds.
567
- # @option params [required, String] :load_balancer_name
568
- # The name of the load balancer.
569
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
570
- #
571
- # @example Request syntax with placeholder values
572
- # resp = client.delete_load_balancer({
573
- # load_balancer_name: "AccessPointName", # required
574
- # })
575
- # @overload delete_load_balancer(params = {})
576
- # @param [Hash] params ({})
577
- def delete_load_balancer(params = {}, options = {})
578
- req = build_request(:delete_load_balancer, params)
579
- req.send_request(options)
580
- end
602
+ # Creates a policy with the specified attributes for the specified load
603
+ # balancer.
604
+ #
605
+ # Policies are settings that are saved for your load balancer and that
606
+ # can be applied to the listener or the application server, depending on
607
+ # the policy type.
608
+ #
609
+ # @option params [required, String] :load_balancer_name
610
+ # The name of the load balancer.
611
+ #
612
+ # @option params [required, String] :policy_name
613
+ # The name of the load balancer policy to be created. This name must be
614
+ # unique within the set of policies for this load balancer.
615
+ #
616
+ # @option params [required, String] :policy_type_name
617
+ # The name of the base policy type. To get the list of policy types, use
618
+ # DescribeLoadBalancerPolicyTypes.
619
+ #
620
+ # @option params [Array<Types::PolicyAttribute>] :policy_attributes
621
+ # The policy attributes.
622
+ #
623
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
624
+ #
625
+ # @example Request syntax with placeholder values
626
+ #
627
+ # resp = client.create_load_balancer_policy({
628
+ # load_balancer_name: "AccessPointName", # required
629
+ # policy_name: "PolicyName", # required
630
+ # policy_type_name: "PolicyTypeName", # required
631
+ # policy_attributes: [
632
+ # {
633
+ # attribute_name: "AttributeName",
634
+ # attribute_value: "AttributeValue",
635
+ # },
636
+ # ],
637
+ # })
638
+ #
639
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/CreateLoadBalancerPolicy AWS API Documentation
640
+ #
641
+ # @overload create_load_balancer_policy(params = {})
642
+ # @param [Hash] params ({})
643
+ def create_load_balancer_policy(params = {}, options = {})
644
+ req = build_request(:create_load_balancer_policy, params)
645
+ req.send_request(options)
646
+ end
581
647
 
582
- # Deletes the specified listeners from the specified load balancer.
583
- # @option params [required, String] :load_balancer_name
584
- # The name of the load balancer.
585
- # @option params [required, Array<Integer>] :load_balancer_ports
586
- # The client port numbers of the listeners.
587
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
588
- #
589
- # @example Request syntax with placeholder values
590
- # resp = client.delete_load_balancer_listeners({
591
- # load_balancer_name: "AccessPointName", # required
592
- # load_balancer_ports: [1], # required
593
- # })
594
- # @overload delete_load_balancer_listeners(params = {})
595
- # @param [Hash] params ({})
596
- def delete_load_balancer_listeners(params = {}, options = {})
597
- req = build_request(:delete_load_balancer_listeners, params)
598
- req.send_request(options)
599
- end
648
+ # Deletes the specified load balancer.
649
+ #
650
+ # If you are attempting to recreate a load balancer, you must
651
+ # reconfigure all settings. The DNS name associated with a deleted load
652
+ # balancer are no longer usable. The name and associated DNS record of
653
+ # the deleted load balancer no longer exist and traffic sent to any of
654
+ # its IP addresses is no longer delivered to your instances.
655
+ #
656
+ # If the load balancer does not exist or has already been deleted, the
657
+ # call to `DeleteLoadBalancer` still succeeds.
658
+ #
659
+ # @option params [required, String] :load_balancer_name
660
+ # The name of the load balancer.
661
+ #
662
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
663
+ #
664
+ # @example Request syntax with placeholder values
665
+ #
666
+ # resp = client.delete_load_balancer({
667
+ # load_balancer_name: "AccessPointName", # required
668
+ # })
669
+ #
670
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DeleteLoadBalancer AWS API Documentation
671
+ #
672
+ # @overload delete_load_balancer(params = {})
673
+ # @param [Hash] params ({})
674
+ def delete_load_balancer(params = {}, options = {})
675
+ req = build_request(:delete_load_balancer, params)
676
+ req.send_request(options)
677
+ end
600
678
 
601
- # Deletes the specified policy from the specified load balancer. This
602
- # policy must not be enabled for any listeners.
603
- # @option params [required, String] :load_balancer_name
604
- # The name of the load balancer.
605
- # @option params [required, String] :policy_name
606
- # The name of the policy.
607
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
608
- #
609
- # @example Request syntax with placeholder values
610
- # resp = client.delete_load_balancer_policy({
611
- # load_balancer_name: "AccessPointName", # required
612
- # policy_name: "PolicyName", # required
613
- # })
614
- # @overload delete_load_balancer_policy(params = {})
615
- # @param [Hash] params ({})
616
- def delete_load_balancer_policy(params = {}, options = {})
617
- req = build_request(:delete_load_balancer_policy, params)
618
- req.send_request(options)
619
- end
679
+ # Deletes the specified listeners from the specified load balancer.
680
+ #
681
+ # @option params [required, String] :load_balancer_name
682
+ # The name of the load balancer.
683
+ #
684
+ # @option params [required, Array<Integer>] :load_balancer_ports
685
+ # The client port numbers of the listeners.
686
+ #
687
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
688
+ #
689
+ # @example Request syntax with placeholder values
690
+ #
691
+ # resp = client.delete_load_balancer_listeners({
692
+ # load_balancer_name: "AccessPointName", # required
693
+ # load_balancer_ports: [1], # required
694
+ # })
695
+ #
696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DeleteLoadBalancerListeners AWS API Documentation
697
+ #
698
+ # @overload delete_load_balancer_listeners(params = {})
699
+ # @param [Hash] params ({})
700
+ def delete_load_balancer_listeners(params = {}, options = {})
701
+ req = build_request(:delete_load_balancer_listeners, params)
702
+ req.send_request(options)
703
+ end
620
704
 
621
- # Deregisters the specified instances from the specified load balancer.
622
- # After the instance is deregistered, it no longer receives traffic from
623
- # the load balancer.
624
- #
625
- # You can use DescribeLoadBalancers to verify that the instance is
626
- # deregistered from the load balancer.
627
- #
628
- # For more information, see [Register or De-Register EC2 Instances][1]
629
- # in the *Classic Load Balancers Guide*.
630
- #
631
- #
632
- #
633
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html
634
- # @option params [required, String] :load_balancer_name
635
- # The name of the load balancer.
636
- # @option params [required, Array<Types::Instance>] :instances
637
- # The IDs of the instances.
638
- # @return [Types::DeregisterEndPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
639
- #
640
- # * {Types::DeregisterEndPointsOutput#instances #Instances} => Array&lt;Types::Instance&gt;
641
- #
642
- # @example Request syntax with placeholder values
643
- # resp = client.deregister_instances_from_load_balancer({
644
- # load_balancer_name: "AccessPointName", # required
645
- # instances: [ # required
646
- # {
647
- # instance_id: "InstanceId",
648
- # },
649
- # ],
650
- # })
651
- #
652
- # @example Response structure
653
- # resp.instances #=> Array
654
- # resp.instances[0].instance_id #=> String
655
- # @overload deregister_instances_from_load_balancer(params = {})
656
- # @param [Hash] params ({})
657
- def deregister_instances_from_load_balancer(params = {}, options = {})
658
- req = build_request(:deregister_instances_from_load_balancer, params)
659
- req.send_request(options)
660
- end
705
+ # Deletes the specified policy from the specified load balancer. This
706
+ # policy must not be enabled for any listeners.
707
+ #
708
+ # @option params [required, String] :load_balancer_name
709
+ # The name of the load balancer.
710
+ #
711
+ # @option params [required, String] :policy_name
712
+ # The name of the policy.
713
+ #
714
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
715
+ #
716
+ # @example Request syntax with placeholder values
717
+ #
718
+ # resp = client.delete_load_balancer_policy({
719
+ # load_balancer_name: "AccessPointName", # required
720
+ # policy_name: "PolicyName", # required
721
+ # })
722
+ #
723
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DeleteLoadBalancerPolicy AWS API Documentation
724
+ #
725
+ # @overload delete_load_balancer_policy(params = {})
726
+ # @param [Hash] params ({})
727
+ def delete_load_balancer_policy(params = {}, options = {})
728
+ req = build_request(:delete_load_balancer_policy, params)
729
+ req.send_request(options)
730
+ end
661
731
 
662
- # Describes the state of the specified instances with respect to the
663
- # specified load balancer. If no instances are specified, the call
664
- # describes the state of all instances that are currently registered
665
- # with the load balancer. If instances are specified, their state is
666
- # returned even if they are no longer registered with the load balancer.
667
- # The state of terminated instances is not returned.
668
- # @option params [required, String] :load_balancer_name
669
- # The name of the load balancer.
670
- # @option params [Array<Types::Instance>] :instances
671
- # The IDs of the instances.
672
- # @return [Types::DescribeEndPointStateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
673
- #
674
- # * {Types::DescribeEndPointStateOutput#instance_states #InstanceStates} => Array&lt;Types::InstanceState&gt;
675
- #
676
- # @example Request syntax with placeholder values
677
- # resp = client.describe_instance_health({
678
- # load_balancer_name: "AccessPointName", # required
679
- # instances: [
680
- # {
681
- # instance_id: "InstanceId",
682
- # },
683
- # ],
684
- # })
685
- #
686
- # @example Response structure
687
- # resp.instance_states #=> Array
688
- # resp.instance_states[0].instance_id #=> String
689
- # resp.instance_states[0].state #=> String
690
- # resp.instance_states[0].reason_code #=> String
691
- # resp.instance_states[0].description #=> String
692
- # @overload describe_instance_health(params = {})
693
- # @param [Hash] params ({})
694
- def describe_instance_health(params = {}, options = {})
695
- req = build_request(:describe_instance_health, params)
696
- req.send_request(options)
697
- end
732
+ # Deregisters the specified instances from the specified load balancer.
733
+ # After the instance is deregistered, it no longer receives traffic from
734
+ # the load balancer.
735
+ #
736
+ # You can use DescribeLoadBalancers to verify that the instance is
737
+ # deregistered from the load balancer.
738
+ #
739
+ # For more information, see [Register or De-Register EC2 Instances][1]
740
+ # in the *Classic Load Balancers Guide*.
741
+ #
742
+ #
743
+ #
744
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html
745
+ #
746
+ # @option params [required, String] :load_balancer_name
747
+ # The name of the load balancer.
748
+ #
749
+ # @option params [required, Array<Types::Instance>] :instances
750
+ # The IDs of the instances.
751
+ #
752
+ # @return [Types::DeregisterEndPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
753
+ #
754
+ # * {Types::DeregisterEndPointsOutput#instances #instances} => Array&lt;Types::Instance&gt;
755
+ #
756
+ # @example Request syntax with placeholder values
757
+ #
758
+ # resp = client.deregister_instances_from_load_balancer({
759
+ # load_balancer_name: "AccessPointName", # required
760
+ # instances: [ # required
761
+ # {
762
+ # instance_id: "InstanceId",
763
+ # },
764
+ # ],
765
+ # })
766
+ #
767
+ # @example Response structure
768
+ #
769
+ # resp.instances #=> Array
770
+ # resp.instances[0].instance_id #=> String
771
+ #
772
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DeregisterInstancesFromLoadBalancer AWS API Documentation
773
+ #
774
+ # @overload deregister_instances_from_load_balancer(params = {})
775
+ # @param [Hash] params ({})
776
+ def deregister_instances_from_load_balancer(params = {}, options = {})
777
+ req = build_request(:deregister_instances_from_load_balancer, params)
778
+ req.send_request(options)
779
+ end
698
780
 
699
- # Describes the attributes for the specified load balancer.
700
- # @option params [required, String] :load_balancer_name
701
- # The name of the load balancer.
702
- # @return [Types::DescribeLoadBalancerAttributesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
703
- #
704
- # * {Types::DescribeLoadBalancerAttributesOutput#load_balancer_attributes #LoadBalancerAttributes} => Types::LoadBalancerAttributes
705
- #
706
- # @example Request syntax with placeholder values
707
- # resp = client.describe_load_balancer_attributes({
708
- # load_balancer_name: "AccessPointName", # required
709
- # })
710
- #
711
- # @example Response structure
712
- # resp.load_balancer_attributes.cross_zone_load_balancing.enabled #=> Boolean
713
- # resp.load_balancer_attributes.access_log.enabled #=> Boolean
714
- # resp.load_balancer_attributes.access_log.s3_bucket_name #=> String
715
- # resp.load_balancer_attributes.access_log.emit_interval #=> Integer
716
- # resp.load_balancer_attributes.access_log.s3_bucket_prefix #=> String
717
- # resp.load_balancer_attributes.connection_draining.enabled #=> Boolean
718
- # resp.load_balancer_attributes.connection_draining.timeout #=> Integer
719
- # resp.load_balancer_attributes.connection_settings.idle_timeout #=> Integer
720
- # resp.load_balancer_attributes.additional_attributes #=> Array
721
- # resp.load_balancer_attributes.additional_attributes[0].key #=> String
722
- # resp.load_balancer_attributes.additional_attributes[0].value #=> String
723
- # @overload describe_load_balancer_attributes(params = {})
724
- # @param [Hash] params ({})
725
- def describe_load_balancer_attributes(params = {}, options = {})
726
- req = build_request(:describe_load_balancer_attributes, params)
727
- req.send_request(options)
728
- end
781
+ # Describes the state of the specified instances with respect to the
782
+ # specified load balancer. If no instances are specified, the call
783
+ # describes the state of all instances that are currently registered
784
+ # with the load balancer. If instances are specified, their state is
785
+ # returned even if they are no longer registered with the load balancer.
786
+ # The state of terminated instances is not returned.
787
+ #
788
+ # @option params [required, String] :load_balancer_name
789
+ # The name of the load balancer.
790
+ #
791
+ # @option params [Array<Types::Instance>] :instances
792
+ # The IDs of the instances.
793
+ #
794
+ # @return [Types::DescribeEndPointStateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
795
+ #
796
+ # * {Types::DescribeEndPointStateOutput#instance_states #instance_states} => Array&lt;Types::InstanceState&gt;
797
+ #
798
+ # @example Request syntax with placeholder values
799
+ #
800
+ # resp = client.describe_instance_health({
801
+ # load_balancer_name: "AccessPointName", # required
802
+ # instances: [
803
+ # {
804
+ # instance_id: "InstanceId",
805
+ # },
806
+ # ],
807
+ # })
808
+ #
809
+ # @example Response structure
810
+ #
811
+ # resp.instance_states #=> Array
812
+ # resp.instance_states[0].instance_id #=> String
813
+ # resp.instance_states[0].state #=> String
814
+ # resp.instance_states[0].reason_code #=> String
815
+ # resp.instance_states[0].description #=> String
816
+ #
817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DescribeInstanceHealth AWS API Documentation
818
+ #
819
+ # @overload describe_instance_health(params = {})
820
+ # @param [Hash] params ({})
821
+ def describe_instance_health(params = {}, options = {})
822
+ req = build_request(:describe_instance_health, params)
823
+ req.send_request(options)
824
+ end
729
825
 
730
- # Describes the specified policies.
731
- #
732
- # If you specify a load balancer name, the action returns the
733
- # descriptions of all policies created for the load balancer. If you
734
- # specify a policy name associated with your load balancer, the action
735
- # returns the description of that policy. If you don't specify a load
736
- # balancer name, the action returns descriptions of the specified sample
737
- # policies, or descriptions of all sample policies. The names of the
738
- # sample policies have the `ELBSample-` prefix.
739
- # @option params [String] :load_balancer_name
740
- # The name of the load balancer.
741
- # @option params [Array<String>] :policy_names
742
- # The names of the policies.
743
- # @return [Types::DescribeLoadBalancerPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
744
- #
745
- # * {Types::DescribeLoadBalancerPoliciesOutput#policy_descriptions #PolicyDescriptions} => Array&lt;Types::PolicyDescription&gt;
746
- #
747
- # @example Request syntax with placeholder values
748
- # resp = client.describe_load_balancer_policies({
749
- # load_balancer_name: "AccessPointName",
750
- # policy_names: ["PolicyName"],
751
- # })
752
- #
753
- # @example Response structure
754
- # resp.policy_descriptions #=> Array
755
- # resp.policy_descriptions[0].policy_name #=> String
756
- # resp.policy_descriptions[0].policy_type_name #=> String
757
- # resp.policy_descriptions[0].policy_attribute_descriptions #=> Array
758
- # resp.policy_descriptions[0].policy_attribute_descriptions[0].attribute_name #=> String
759
- # resp.policy_descriptions[0].policy_attribute_descriptions[0].attribute_value #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
760
- # @overload describe_load_balancer_policies(params = {})
761
- # @param [Hash] params ({})
762
- def describe_load_balancer_policies(params = {}, options = {})
763
- req = build_request(:describe_load_balancer_policies, params)
764
- req.send_request(options)
765
- end
826
+ # Describes the attributes for the specified load balancer.
827
+ #
828
+ # @option params [required, String] :load_balancer_name
829
+ # The name of the load balancer.
830
+ #
831
+ # @return [Types::DescribeLoadBalancerAttributesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
832
+ #
833
+ # * {Types::DescribeLoadBalancerAttributesOutput#load_balancer_attributes #load_balancer_attributes} => Types::LoadBalancerAttributes
834
+ #
835
+ # @example Request syntax with placeholder values
836
+ #
837
+ # resp = client.describe_load_balancer_attributes({
838
+ # load_balancer_name: "AccessPointName", # required
839
+ # })
840
+ #
841
+ # @example Response structure
842
+ #
843
+ # resp.load_balancer_attributes.cross_zone_load_balancing.enabled #=> Boolean
844
+ # resp.load_balancer_attributes.access_log.enabled #=> Boolean
845
+ # resp.load_balancer_attributes.access_log.s3_bucket_name #=> String
846
+ # resp.load_balancer_attributes.access_log.emit_interval #=> Integer
847
+ # resp.load_balancer_attributes.access_log.s3_bucket_prefix #=> String
848
+ # resp.load_balancer_attributes.connection_draining.enabled #=> Boolean
849
+ # resp.load_balancer_attributes.connection_draining.timeout #=> Integer
850
+ # resp.load_balancer_attributes.connection_settings.idle_timeout #=> Integer
851
+ # resp.load_balancer_attributes.additional_attributes #=> Array
852
+ # resp.load_balancer_attributes.additional_attributes[0].key #=> String
853
+ # resp.load_balancer_attributes.additional_attributes[0].value #=> String
854
+ #
855
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DescribeLoadBalancerAttributes AWS API Documentation
856
+ #
857
+ # @overload describe_load_balancer_attributes(params = {})
858
+ # @param [Hash] params ({})
859
+ def describe_load_balancer_attributes(params = {}, options = {})
860
+ req = build_request(:describe_load_balancer_attributes, params)
861
+ req.send_request(options)
862
+ end
766
863
 
767
- # Describes the specified load balancer policy types or all load
768
- # balancer policy types.
769
- #
770
- # The description of each type indicates how it can be used. For
771
- # example, some policies can be used only with layer 7 listeners, some
772
- # policies can be used only with layer 4 listeners, and some policies
773
- # can be used only with your EC2 instances.
774
- #
775
- # You can use CreateLoadBalancerPolicy to create a policy configuration
776
- # for any of these policy types. Then, depending on the policy type, use
777
- # either SetLoadBalancerPoliciesOfListener or
778
- # SetLoadBalancerPoliciesForBackendServer to set the policy.
779
- # @option params [Array<String>] :policy_type_names
780
- # The names of the policy types. If no names are specified, describes
781
- # all policy types defined by Elastic Load Balancing.
782
- # @return [Types::DescribeLoadBalancerPolicyTypesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
783
- #
784
- # * {Types::DescribeLoadBalancerPolicyTypesOutput#policy_type_descriptions #PolicyTypeDescriptions} => Array&lt;Types::PolicyTypeDescription&gt;
785
- #
786
- # @example Request syntax with placeholder values
787
- # resp = client.describe_load_balancer_policy_types({
788
- # policy_type_names: ["PolicyTypeName"],
789
- # })
790
- #
791
- # @example Response structure
792
- # resp.policy_type_descriptions #=> Array
793
- # resp.policy_type_descriptions[0].policy_type_name #=> String
794
- # resp.policy_type_descriptions[0].description #=> String
795
- # resp.policy_type_descriptions[0].policy_attribute_type_descriptions #=> Array
796
- # resp.policy_type_descriptions[0].policy_attribute_type_descriptions[0].attribute_name #=> String
797
- # resp.policy_type_descriptions[0].policy_attribute_type_descriptions[0].attribute_type #=> String
798
- # resp.policy_type_descriptions[0].policy_attribute_type_descriptions[0].description #=> String
799
- # resp.policy_type_descriptions[0].policy_attribute_type_descriptions[0].default_value #=> String
800
- # resp.policy_type_descriptions[0].policy_attribute_type_descriptions[0].cardinality #=> String
801
- # @overload describe_load_balancer_policy_types(params = {})
802
- # @param [Hash] params ({})
803
- def describe_load_balancer_policy_types(params = {}, options = {})
804
- req = build_request(:describe_load_balancer_policy_types, params)
805
- req.send_request(options)
806
- end
864
+ # Describes the specified policies.
865
+ #
866
+ # If you specify a load balancer name, the action returns the
867
+ # descriptions of all policies created for the load balancer. If you
868
+ # specify a policy name associated with your load balancer, the action
869
+ # returns the description of that policy. If you don't specify a load
870
+ # balancer name, the action returns descriptions of the specified sample
871
+ # policies, or descriptions of all sample policies. The names of the
872
+ # sample policies have the `ELBSample-` prefix.
873
+ #
874
+ # @option params [String] :load_balancer_name
875
+ # The name of the load balancer.
876
+ #
877
+ # @option params [Array<String>] :policy_names
878
+ # The names of the policies.
879
+ #
880
+ # @return [Types::DescribeLoadBalancerPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
881
+ #
882
+ # * {Types::DescribeLoadBalancerPoliciesOutput#policy_descriptions #policy_descriptions} => Array&lt;Types::PolicyDescription&gt;
883
+ #
884
+ # @example Request syntax with placeholder values
885
+ #
886
+ # resp = client.describe_load_balancer_policies({
887
+ # load_balancer_name: "AccessPointName",
888
+ # policy_names: ["PolicyName"],
889
+ # })
890
+ #
891
+ # @example Response structure
892
+ #
893
+ # resp.policy_descriptions #=> Array
894
+ # resp.policy_descriptions[0].policy_name #=> String
895
+ # resp.policy_descriptions[0].policy_type_name #=> String
896
+ # resp.policy_descriptions[0].policy_attribute_descriptions #=> Array
897
+ # resp.policy_descriptions[0].policy_attribute_descriptions[0].attribute_name #=> String
898
+ # resp.policy_descriptions[0].policy_attribute_descriptions[0].attribute_value #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
899
+ #
900
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DescribeLoadBalancerPolicies AWS API Documentation
901
+ #
902
+ # @overload describe_load_balancer_policies(params = {})
903
+ # @param [Hash] params ({})
904
+ def describe_load_balancer_policies(params = {}, options = {})
905
+ req = build_request(:describe_load_balancer_policies, params)
906
+ req.send_request(options)
907
+ end
807
908
 
808
- # Describes the specified the load balancers. If no load balancers are
809
- # specified, the call describes all of your load balancers.
810
- # @option params [Array<String>] :load_balancer_names
811
- # The names of the load balancers.
812
- # @option params [String] :marker
813
- # The marker for the next set of results. (You received this marker from
814
- # a previous call.)
815
- # @option params [Integer] :page_size
816
- # The maximum number of results to return with this call (a number from
817
- # 1 to 400). The default is 400.
818
- # @return [Types::DescribeAccessPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
819
- #
820
- # * {Types::DescribeAccessPointsOutput#load_balancer_descriptions #LoadBalancerDescriptions} => Array&lt;Types::LoadBalancerDescription&gt;
821
- # * {Types::DescribeAccessPointsOutput#next_marker #NextMarker} => String
822
- #
823
- # @example Request syntax with placeholder values
824
- # resp = client.describe_load_balancers({
825
- # load_balancer_names: ["AccessPointName"],
826
- # marker: "Marker",
827
- # page_size: 1,
828
- # })
829
- #
830
- # @example Response structure
831
- # resp.load_balancer_descriptions #=> Array
832
- # resp.load_balancer_descriptions[0].load_balancer_name #=> String
833
- # resp.load_balancer_descriptions[0].dns_name #=> String
834
- # resp.load_balancer_descriptions[0].canonical_hosted_zone_name #=> String
835
- # resp.load_balancer_descriptions[0].canonical_hosted_zone_name_id #=> String
836
- # resp.load_balancer_descriptions[0].listener_descriptions #=> Array
837
- # resp.load_balancer_descriptions[0].listener_descriptions[0].listener.protocol #=> String
838
- # resp.load_balancer_descriptions[0].listener_descriptions[0].listener.load_balancer_port #=> Integer
839
- # resp.load_balancer_descriptions[0].listener_descriptions[0].listener.instance_protocol #=> String
840
- # resp.load_balancer_descriptions[0].listener_descriptions[0].listener.instance_port #=> Integer
841
- # resp.load_balancer_descriptions[0].listener_descriptions[0].listener.ssl_certificate_id #=> String
842
- # resp.load_balancer_descriptions[0].listener_descriptions[0].policy_names #=> Array
843
- # resp.load_balancer_descriptions[0].listener_descriptions[0].policy_names[0] #=> String
844
- # resp.load_balancer_descriptions[0].policies.app_cookie_stickiness_policies #=> Array
845
- # resp.load_balancer_descriptions[0].policies.app_cookie_stickiness_policies[0].policy_name #=> String
846
- # resp.load_balancer_descriptions[0].policies.app_cookie_stickiness_policies[0].cookie_name #=> String
847
- # resp.load_balancer_descriptions[0].policies.lb_cookie_stickiness_policies #=> Array
848
- # resp.load_balancer_descriptions[0].policies.lb_cookie_stickiness_policies[0].policy_name #=> String
849
- # resp.load_balancer_descriptions[0].policies.lb_cookie_stickiness_policies[0].cookie_expiration_period #=> Integer
850
- # resp.load_balancer_descriptions[0].policies.other_policies #=> Array
851
- # resp.load_balancer_descriptions[0].policies.other_policies[0] #=> String
852
- # resp.load_balancer_descriptions[0].backend_server_descriptions #=> Array
853
- # resp.load_balancer_descriptions[0].backend_server_descriptions[0].instance_port #=> Integer
854
- # resp.load_balancer_descriptions[0].backend_server_descriptions[0].policy_names #=> Array
855
- # resp.load_balancer_descriptions[0].backend_server_descriptions[0].policy_names[0] #=> String
856
- # resp.load_balancer_descriptions[0].availability_zones #=> Array
857
- # resp.load_balancer_descriptions[0].availability_zones[0] #=> String
858
- # resp.load_balancer_descriptions[0].subnets #=> Array
859
- # resp.load_balancer_descriptions[0].subnets[0] #=> String
860
- # resp.load_balancer_descriptions[0].vpc_id #=> String
861
- # resp.load_balancer_descriptions[0].instances #=> Array
862
- # resp.load_balancer_descriptions[0].instances[0].instance_id #=> String
863
- # resp.load_balancer_descriptions[0].health_check.target #=> String
864
- # resp.load_balancer_descriptions[0].health_check.interval #=> Integer
865
- # resp.load_balancer_descriptions[0].health_check.timeout #=> Integer
866
- # resp.load_balancer_descriptions[0].health_check.unhealthy_threshold #=> Integer
867
- # resp.load_balancer_descriptions[0].health_check.healthy_threshold #=> Integer
868
- # resp.load_balancer_descriptions[0].source_security_group.owner_alias #=> String
869
- # resp.load_balancer_descriptions[0].source_security_group.group_name #=> String
870
- # resp.load_balancer_descriptions[0].security_groups #=> Array
871
- # resp.load_balancer_descriptions[0].security_groups[0] #=> String
872
- # resp.load_balancer_descriptions[0].created_time #=> Time
873
- # resp.load_balancer_descriptions[0].scheme #=> String
874
- # resp.next_marker #=> String
875
- # @overload describe_load_balancers(params = {})
876
- # @param [Hash] params ({})
877
- def describe_load_balancers(params = {}, options = {})
878
- req = build_request(:describe_load_balancers, params)
879
- req.send_request(options)
880
- end
909
+ # Describes the specified load balancer policy types or all load
910
+ # balancer policy types.
911
+ #
912
+ # The description of each type indicates how it can be used. For
913
+ # example, some policies can be used only with layer 7 listeners, some
914
+ # policies can be used only with layer 4 listeners, and some policies
915
+ # can be used only with your EC2 instances.
916
+ #
917
+ # You can use CreateLoadBalancerPolicy to create a policy configuration
918
+ # for any of these policy types. Then, depending on the policy type, use
919
+ # either SetLoadBalancerPoliciesOfListener or
920
+ # SetLoadBalancerPoliciesForBackendServer to set the policy.
921
+ #
922
+ # @option params [Array<String>] :policy_type_names
923
+ # The names of the policy types. If no names are specified, describes
924
+ # all policy types defined by Elastic Load Balancing.
925
+ #
926
+ # @return [Types::DescribeLoadBalancerPolicyTypesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
927
+ #
928
+ # * {Types::DescribeLoadBalancerPolicyTypesOutput#policy_type_descriptions #policy_type_descriptions} => Array&lt;Types::PolicyTypeDescription&gt;
929
+ #
930
+ # @example Request syntax with placeholder values
931
+ #
932
+ # resp = client.describe_load_balancer_policy_types({
933
+ # policy_type_names: ["PolicyTypeName"],
934
+ # })
935
+ #
936
+ # @example Response structure
937
+ #
938
+ # resp.policy_type_descriptions #=> Array
939
+ # resp.policy_type_descriptions[0].policy_type_name #=> String
940
+ # resp.policy_type_descriptions[0].description #=> String
941
+ # resp.policy_type_descriptions[0].policy_attribute_type_descriptions #=> Array
942
+ # resp.policy_type_descriptions[0].policy_attribute_type_descriptions[0].attribute_name #=> String
943
+ # resp.policy_type_descriptions[0].policy_attribute_type_descriptions[0].attribute_type #=> String
944
+ # resp.policy_type_descriptions[0].policy_attribute_type_descriptions[0].description #=> String
945
+ # resp.policy_type_descriptions[0].policy_attribute_type_descriptions[0].default_value #=> String
946
+ # resp.policy_type_descriptions[0].policy_attribute_type_descriptions[0].cardinality #=> String
947
+ #
948
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DescribeLoadBalancerPolicyTypes AWS API Documentation
949
+ #
950
+ # @overload describe_load_balancer_policy_types(params = {})
951
+ # @param [Hash] params ({})
952
+ def describe_load_balancer_policy_types(params = {}, options = {})
953
+ req = build_request(:describe_load_balancer_policy_types, params)
954
+ req.send_request(options)
955
+ end
881
956
 
882
- # Describes the tags associated with the specified load balancers.
883
- # @option params [required, Array<String>] :load_balancer_names
884
- # The names of the load balancers.
885
- # @return [Types::DescribeTagsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
886
- #
887
- # * {Types::DescribeTagsOutput#tag_descriptions #TagDescriptions} => Array&lt;Types::TagDescription&gt;
888
- #
889
- # @example Request syntax with placeholder values
890
- # resp = client.describe_tags({
891
- # load_balancer_names: ["AccessPointName"], # required
892
- # })
893
- #
894
- # @example Response structure
895
- # resp.tag_descriptions #=> Array
896
- # resp.tag_descriptions[0].load_balancer_name #=> String
897
- # resp.tag_descriptions[0].tags #=> Array
898
- # resp.tag_descriptions[0].tags[0].key #=> String
899
- # resp.tag_descriptions[0].tags[0].value #=> String
900
- # @overload describe_tags(params = {})
901
- # @param [Hash] params ({})
902
- def describe_tags(params = {}, options = {})
903
- req = build_request(:describe_tags, params)
904
- req.send_request(options)
905
- end
957
+ # Describes the specified the load balancers. If no load balancers are
958
+ # specified, the call describes all of your load balancers.
959
+ #
960
+ # @option params [Array<String>] :load_balancer_names
961
+ # The names of the load balancers.
962
+ #
963
+ # @option params [String] :marker
964
+ # The marker for the next set of results. (You received this marker from
965
+ # a previous call.)
966
+ #
967
+ # @option params [Integer] :page_size
968
+ # The maximum number of results to return with this call (a number from
969
+ # 1 to 400). The default is 400.
970
+ #
971
+ # @return [Types::DescribeAccessPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
972
+ #
973
+ # * {Types::DescribeAccessPointsOutput#load_balancer_descriptions #load_balancer_descriptions} => Array&lt;Types::LoadBalancerDescription&gt;
974
+ # * {Types::DescribeAccessPointsOutput#next_marker #next_marker} => String
975
+ #
976
+ # @example Request syntax with placeholder values
977
+ #
978
+ # resp = client.describe_load_balancers({
979
+ # load_balancer_names: ["AccessPointName"],
980
+ # marker: "Marker",
981
+ # page_size: 1,
982
+ # })
983
+ #
984
+ # @example Response structure
985
+ #
986
+ # resp.load_balancer_descriptions #=> Array
987
+ # resp.load_balancer_descriptions[0].load_balancer_name #=> String
988
+ # resp.load_balancer_descriptions[0].dns_name #=> String
989
+ # resp.load_balancer_descriptions[0].canonical_hosted_zone_name #=> String
990
+ # resp.load_balancer_descriptions[0].canonical_hosted_zone_name_id #=> String
991
+ # resp.load_balancer_descriptions[0].listener_descriptions #=> Array
992
+ # resp.load_balancer_descriptions[0].listener_descriptions[0].listener.protocol #=> String
993
+ # resp.load_balancer_descriptions[0].listener_descriptions[0].listener.load_balancer_port #=> Integer
994
+ # resp.load_balancer_descriptions[0].listener_descriptions[0].listener.instance_protocol #=> String
995
+ # resp.load_balancer_descriptions[0].listener_descriptions[0].listener.instance_port #=> Integer
996
+ # resp.load_balancer_descriptions[0].listener_descriptions[0].listener.ssl_certificate_id #=> String
997
+ # resp.load_balancer_descriptions[0].listener_descriptions[0].policy_names #=> Array
998
+ # resp.load_balancer_descriptions[0].listener_descriptions[0].policy_names[0] #=> String
999
+ # resp.load_balancer_descriptions[0].policies.app_cookie_stickiness_policies #=> Array
1000
+ # resp.load_balancer_descriptions[0].policies.app_cookie_stickiness_policies[0].policy_name #=> String
1001
+ # resp.load_balancer_descriptions[0].policies.app_cookie_stickiness_policies[0].cookie_name #=> String
1002
+ # resp.load_balancer_descriptions[0].policies.lb_cookie_stickiness_policies #=> Array
1003
+ # resp.load_balancer_descriptions[0].policies.lb_cookie_stickiness_policies[0].policy_name #=> String
1004
+ # resp.load_balancer_descriptions[0].policies.lb_cookie_stickiness_policies[0].cookie_expiration_period #=> Integer
1005
+ # resp.load_balancer_descriptions[0].policies.other_policies #=> Array
1006
+ # resp.load_balancer_descriptions[0].policies.other_policies[0] #=> String
1007
+ # resp.load_balancer_descriptions[0].backend_server_descriptions #=> Array
1008
+ # resp.load_balancer_descriptions[0].backend_server_descriptions[0].instance_port #=> Integer
1009
+ # resp.load_balancer_descriptions[0].backend_server_descriptions[0].policy_names #=> Array
1010
+ # resp.load_balancer_descriptions[0].backend_server_descriptions[0].policy_names[0] #=> String
1011
+ # resp.load_balancer_descriptions[0].availability_zones #=> Array
1012
+ # resp.load_balancer_descriptions[0].availability_zones[0] #=> String
1013
+ # resp.load_balancer_descriptions[0].subnets #=> Array
1014
+ # resp.load_balancer_descriptions[0].subnets[0] #=> String
1015
+ # resp.load_balancer_descriptions[0].vpc_id #=> String
1016
+ # resp.load_balancer_descriptions[0].instances #=> Array
1017
+ # resp.load_balancer_descriptions[0].instances[0].instance_id #=> String
1018
+ # resp.load_balancer_descriptions[0].health_check.target #=> String
1019
+ # resp.load_balancer_descriptions[0].health_check.interval #=> Integer
1020
+ # resp.load_balancer_descriptions[0].health_check.timeout #=> Integer
1021
+ # resp.load_balancer_descriptions[0].health_check.unhealthy_threshold #=> Integer
1022
+ # resp.load_balancer_descriptions[0].health_check.healthy_threshold #=> Integer
1023
+ # resp.load_balancer_descriptions[0].source_security_group.owner_alias #=> String
1024
+ # resp.load_balancer_descriptions[0].source_security_group.group_name #=> String
1025
+ # resp.load_balancer_descriptions[0].security_groups #=> Array
1026
+ # resp.load_balancer_descriptions[0].security_groups[0] #=> String
1027
+ # resp.load_balancer_descriptions[0].created_time #=> Time
1028
+ # resp.load_balancer_descriptions[0].scheme #=> String
1029
+ # resp.next_marker #=> String
1030
+ #
1031
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DescribeLoadBalancers AWS API Documentation
1032
+ #
1033
+ # @overload describe_load_balancers(params = {})
1034
+ # @param [Hash] params ({})
1035
+ def describe_load_balancers(params = {}, options = {})
1036
+ req = build_request(:describe_load_balancers, params)
1037
+ req.send_request(options)
1038
+ end
906
1039
 
907
- # Removes the specified subnets from the set of configured subnets for
908
- # the load balancer.
909
- #
910
- # After a subnet is removed, all EC2 instances registered with the load
911
- # balancer in the removed subnet go into the `OutOfService` state. Then,
912
- # the load balancer balances the traffic among the remaining routable
913
- # subnets.
914
- # @option params [required, String] :load_balancer_name
915
- # The name of the load balancer.
916
- # @option params [required, Array<String>] :subnets
917
- # The IDs of the subnets.
918
- # @return [Types::DetachLoadBalancerFromSubnetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
919
- #
920
- # * {Types::DetachLoadBalancerFromSubnetsOutput#subnets #Subnets} => Array&lt;String&gt;
921
- #
922
- # @example Request syntax with placeholder values
923
- # resp = client.detach_load_balancer_from_subnets({
924
- # load_balancer_name: "AccessPointName", # required
925
- # subnets: ["SubnetId"], # required
926
- # })
927
- #
928
- # @example Response structure
929
- # resp.subnets #=> Array
930
- # resp.subnets[0] #=> String
931
- # @overload detach_load_balancer_from_subnets(params = {})
932
- # @param [Hash] params ({})
933
- def detach_load_balancer_from_subnets(params = {}, options = {})
934
- req = build_request(:detach_load_balancer_from_subnets, params)
935
- req.send_request(options)
936
- end
1040
+ # Describes the tags associated with the specified load balancers.
1041
+ #
1042
+ # @option params [required, Array<String>] :load_balancer_names
1043
+ # The names of the load balancers.
1044
+ #
1045
+ # @return [Types::DescribeTagsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1046
+ #
1047
+ # * {Types::DescribeTagsOutput#tag_descriptions #tag_descriptions} => Array&lt;Types::TagDescription&gt;
1048
+ #
1049
+ # @example Request syntax with placeholder values
1050
+ #
1051
+ # resp = client.describe_tags({
1052
+ # load_balancer_names: ["AccessPointName"], # required
1053
+ # })
1054
+ #
1055
+ # @example Response structure
1056
+ #
1057
+ # resp.tag_descriptions #=> Array
1058
+ # resp.tag_descriptions[0].load_balancer_name #=> String
1059
+ # resp.tag_descriptions[0].tags #=> Array
1060
+ # resp.tag_descriptions[0].tags[0].key #=> String
1061
+ # resp.tag_descriptions[0].tags[0].value #=> String
1062
+ #
1063
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DescribeTags AWS API Documentation
1064
+ #
1065
+ # @overload describe_tags(params = {})
1066
+ # @param [Hash] params ({})
1067
+ def describe_tags(params = {}, options = {})
1068
+ req = build_request(:describe_tags, params)
1069
+ req.send_request(options)
1070
+ end
937
1071
 
938
- # Removes the specified Availability Zones from the set of Availability
939
- # Zones for the specified load balancer.
940
- #
941
- # There must be at least one Availability Zone registered with a load
942
- # balancer at all times. After an Availability Zone is removed, all
943
- # instances registered with the load balancer that are in the removed
944
- # Availability Zone go into the `OutOfService` state. Then, the load
945
- # balancer attempts to equally balance the traffic among its remaining
946
- # Availability Zones.
947
- #
948
- # For more information, see [Add or Remove Availability Zones][1] in the
949
- # *Classic Load Balancers Guide*.
950
- #
951
- #
952
- #
953
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html
954
- # @option params [required, String] :load_balancer_name
955
- # The name of the load balancer.
956
- # @option params [required, Array<String>] :availability_zones
957
- # The Availability Zones.
958
- # @return [Types::RemoveAvailabilityZonesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
959
- #
960
- # * {Types::RemoveAvailabilityZonesOutput#availability_zones #AvailabilityZones} => Array&lt;String&gt;
961
- #
962
- # @example Request syntax with placeholder values
963
- # resp = client.disable_availability_zones_for_load_balancer({
964
- # load_balancer_name: "AccessPointName", # required
965
- # availability_zones: ["AvailabilityZone"], # required
966
- # })
967
- #
968
- # @example Response structure
969
- # resp.availability_zones #=> Array
970
- # resp.availability_zones[0] #=> String
971
- # @overload disable_availability_zones_for_load_balancer(params = {})
972
- # @param [Hash] params ({})
973
- def disable_availability_zones_for_load_balancer(params = {}, options = {})
974
- req = build_request(:disable_availability_zones_for_load_balancer, params)
975
- req.send_request(options)
976
- end
1072
+ # Removes the specified subnets from the set of configured subnets for
1073
+ # the load balancer.
1074
+ #
1075
+ # After a subnet is removed, all EC2 instances registered with the load
1076
+ # balancer in the removed subnet go into the `OutOfService` state. Then,
1077
+ # the load balancer balances the traffic among the remaining routable
1078
+ # subnets.
1079
+ #
1080
+ # @option params [required, String] :load_balancer_name
1081
+ # The name of the load balancer.
1082
+ #
1083
+ # @option params [required, Array<String>] :subnets
1084
+ # The IDs of the subnets.
1085
+ #
1086
+ # @return [Types::DetachLoadBalancerFromSubnetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1087
+ #
1088
+ # * {Types::DetachLoadBalancerFromSubnetsOutput#subnets #subnets} => Array&lt;String&gt;
1089
+ #
1090
+ # @example Request syntax with placeholder values
1091
+ #
1092
+ # resp = client.detach_load_balancer_from_subnets({
1093
+ # load_balancer_name: "AccessPointName", # required
1094
+ # subnets: ["SubnetId"], # required
1095
+ # })
1096
+ #
1097
+ # @example Response structure
1098
+ #
1099
+ # resp.subnets #=> Array
1100
+ # resp.subnets[0] #=> String
1101
+ #
1102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DetachLoadBalancerFromSubnets AWS API Documentation
1103
+ #
1104
+ # @overload detach_load_balancer_from_subnets(params = {})
1105
+ # @param [Hash] params ({})
1106
+ def detach_load_balancer_from_subnets(params = {}, options = {})
1107
+ req = build_request(:detach_load_balancer_from_subnets, params)
1108
+ req.send_request(options)
1109
+ end
977
1110
 
978
- # Adds the specified Availability Zones to the set of Availability Zones
979
- # for the specified load balancer.
980
- #
981
- # The load balancer evenly distributes requests across all its
982
- # registered Availability Zones that contain instances.
983
- #
984
- # For more information, see [Add or Remove Availability Zones][1] in the
985
- # *Classic Load Balancers Guide*.
986
- #
987
- #
988
- #
989
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html
990
- # @option params [required, String] :load_balancer_name
991
- # The name of the load balancer.
992
- # @option params [required, Array<String>] :availability_zones
993
- # The Availability Zones. These must be in the same region as the load
994
- # balancer.
995
- # @return [Types::AddAvailabilityZonesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
996
- #
997
- # * {Types::AddAvailabilityZonesOutput#availability_zones #AvailabilityZones} => Array&lt;String&gt;
998
- #
999
- # @example Request syntax with placeholder values
1000
- # resp = client.enable_availability_zones_for_load_balancer({
1001
- # load_balancer_name: "AccessPointName", # required
1002
- # availability_zones: ["AvailabilityZone"], # required
1003
- # })
1004
- #
1005
- # @example Response structure
1006
- # resp.availability_zones #=> Array
1007
- # resp.availability_zones[0] #=> String
1008
- # @overload enable_availability_zones_for_load_balancer(params = {})
1009
- # @param [Hash] params ({})
1010
- def enable_availability_zones_for_load_balancer(params = {}, options = {})
1011
- req = build_request(:enable_availability_zones_for_load_balancer, params)
1012
- req.send_request(options)
1013
- end
1111
+ # Removes the specified Availability Zones from the set of Availability
1112
+ # Zones for the specified load balancer.
1113
+ #
1114
+ # There must be at least one Availability Zone registered with a load
1115
+ # balancer at all times. After an Availability Zone is removed, all
1116
+ # instances registered with the load balancer that are in the removed
1117
+ # Availability Zone go into the `OutOfService` state. Then, the load
1118
+ # balancer attempts to equally balance the traffic among its remaining
1119
+ # Availability Zones.
1120
+ #
1121
+ # For more information, see [Add or Remove Availability Zones][1] in the
1122
+ # *Classic Load Balancers Guide*.
1123
+ #
1124
+ #
1125
+ #
1126
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html
1127
+ #
1128
+ # @option params [required, String] :load_balancer_name
1129
+ # The name of the load balancer.
1130
+ #
1131
+ # @option params [required, Array<String>] :availability_zones
1132
+ # The Availability Zones.
1133
+ #
1134
+ # @return [Types::RemoveAvailabilityZonesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1135
+ #
1136
+ # * {Types::RemoveAvailabilityZonesOutput#availability_zones #availability_zones} => Array&lt;String&gt;
1137
+ #
1138
+ # @example Request syntax with placeholder values
1139
+ #
1140
+ # resp = client.disable_availability_zones_for_load_balancer({
1141
+ # load_balancer_name: "AccessPointName", # required
1142
+ # availability_zones: ["AvailabilityZone"], # required
1143
+ # })
1144
+ #
1145
+ # @example Response structure
1146
+ #
1147
+ # resp.availability_zones #=> Array
1148
+ # resp.availability_zones[0] #=> String
1149
+ #
1150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/DisableAvailabilityZonesForLoadBalancer AWS API Documentation
1151
+ #
1152
+ # @overload disable_availability_zones_for_load_balancer(params = {})
1153
+ # @param [Hash] params ({})
1154
+ def disable_availability_zones_for_load_balancer(params = {}, options = {})
1155
+ req = build_request(:disable_availability_zones_for_load_balancer, params)
1156
+ req.send_request(options)
1157
+ end
1014
1158
 
1015
- # Modifies the attributes of the specified load balancer.
1016
- #
1017
- # You can modify the load balancer attributes, such as `AccessLogs`,
1018
- # `ConnectionDraining`, and `CrossZoneLoadBalancing` by either enabling
1019
- # or disabling them. Or, you can modify the load balancer attribute
1020
- # `ConnectionSettings` by specifying an idle connection timeout value
1021
- # for your load balancer.
1022
- #
1023
- # For more information, see the following in the *Classic Load Balancers
1024
- # Guide*\:
1025
- #
1026
- # * [Cross-Zone Load Balancing][1]
1027
- #
1028
- # * [Connection Draining][2]
1029
- #
1030
- # * [Access Logs][3]
1031
- #
1032
- # * [Idle Connection Timeout][4]
1033
- #
1034
- #
1035
- #
1036
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html
1037
- # [2]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html
1038
- # [3]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/access-log-collection.html
1039
- # [4]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html
1040
- # @option params [required, String] :load_balancer_name
1041
- # The name of the load balancer.
1042
- # @option params [required, Types::LoadBalancerAttributes] :load_balancer_attributes
1043
- # The attributes of the load balancer.
1044
- # @return [Types::ModifyLoadBalancerAttributesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1045
- #
1046
- # * {Types::ModifyLoadBalancerAttributesOutput#load_balancer_name #LoadBalancerName} => String
1047
- # * {Types::ModifyLoadBalancerAttributesOutput#load_balancer_attributes #LoadBalancerAttributes} => Types::LoadBalancerAttributes
1048
- #
1049
- # @example Request syntax with placeholder values
1050
- # resp = client.modify_load_balancer_attributes({
1051
- # load_balancer_name: "AccessPointName", # required
1052
- # load_balancer_attributes: { # required
1053
- # cross_zone_load_balancing: {
1054
- # enabled: false, # required
1055
- # },
1056
- # access_log: {
1057
- # enabled: false, # required
1058
- # s3_bucket_name: "S3BucketName",
1059
- # emit_interval: 1,
1060
- # s3_bucket_prefix: "AccessLogPrefix",
1061
- # },
1062
- # connection_draining: {
1063
- # enabled: false, # required
1064
- # timeout: 1,
1065
- # },
1066
- # connection_settings: {
1067
- # idle_timeout: 1, # required
1068
- # },
1069
- # additional_attributes: [
1070
- # {
1071
- # key: "AdditionalAttributeKey",
1072
- # value: "AdditionalAttributeValue",
1073
- # },
1074
- # ],
1075
- # },
1076
- # })
1077
- #
1078
- # @example Response structure
1079
- # resp.load_balancer_name #=> String
1080
- # resp.load_balancer_attributes.cross_zone_load_balancing.enabled #=> Boolean
1081
- # resp.load_balancer_attributes.access_log.enabled #=> Boolean
1082
- # resp.load_balancer_attributes.access_log.s3_bucket_name #=> String
1083
- # resp.load_balancer_attributes.access_log.emit_interval #=> Integer
1084
- # resp.load_balancer_attributes.access_log.s3_bucket_prefix #=> String
1085
- # resp.load_balancer_attributes.connection_draining.enabled #=> Boolean
1086
- # resp.load_balancer_attributes.connection_draining.timeout #=> Integer
1087
- # resp.load_balancer_attributes.connection_settings.idle_timeout #=> Integer
1088
- # resp.load_balancer_attributes.additional_attributes #=> Array
1089
- # resp.load_balancer_attributes.additional_attributes[0].key #=> String
1090
- # resp.load_balancer_attributes.additional_attributes[0].value #=> String
1091
- # @overload modify_load_balancer_attributes(params = {})
1092
- # @param [Hash] params ({})
1093
- def modify_load_balancer_attributes(params = {}, options = {})
1094
- req = build_request(:modify_load_balancer_attributes, params)
1095
- req.send_request(options)
1096
- end
1159
+ # Adds the specified Availability Zones to the set of Availability Zones
1160
+ # for the specified load balancer.
1161
+ #
1162
+ # The load balancer evenly distributes requests across all its
1163
+ # registered Availability Zones that contain instances.
1164
+ #
1165
+ # For more information, see [Add or Remove Availability Zones][1] in the
1166
+ # *Classic Load Balancers Guide*.
1167
+ #
1168
+ #
1169
+ #
1170
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html
1171
+ #
1172
+ # @option params [required, String] :load_balancer_name
1173
+ # The name of the load balancer.
1174
+ #
1175
+ # @option params [required, Array<String>] :availability_zones
1176
+ # The Availability Zones. These must be in the same region as the load
1177
+ # balancer.
1178
+ #
1179
+ # @return [Types::AddAvailabilityZonesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1180
+ #
1181
+ # * {Types::AddAvailabilityZonesOutput#availability_zones #availability_zones} => Array&lt;String&gt;
1182
+ #
1183
+ # @example Request syntax with placeholder values
1184
+ #
1185
+ # resp = client.enable_availability_zones_for_load_balancer({
1186
+ # load_balancer_name: "AccessPointName", # required
1187
+ # availability_zones: ["AvailabilityZone"], # required
1188
+ # })
1189
+ #
1190
+ # @example Response structure
1191
+ #
1192
+ # resp.availability_zones #=> Array
1193
+ # resp.availability_zones[0] #=> String
1194
+ #
1195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/EnableAvailabilityZonesForLoadBalancer AWS API Documentation
1196
+ #
1197
+ # @overload enable_availability_zones_for_load_balancer(params = {})
1198
+ # @param [Hash] params ({})
1199
+ def enable_availability_zones_for_load_balancer(params = {}, options = {})
1200
+ req = build_request(:enable_availability_zones_for_load_balancer, params)
1201
+ req.send_request(options)
1202
+ end
1097
1203
 
1098
- # Adds the specified instances to the specified load balancer.
1099
- #
1100
- # The instance must be a running instance in the same network as the
1101
- # load balancer (EC2-Classic or the same VPC). If you have EC2-Classic
1102
- # instances and a load balancer in a VPC with ClassicLink enabled, you
1103
- # can link the EC2-Classic instances to that VPC and then register the
1104
- # linked EC2-Classic instances with the load balancer in the VPC.
1105
- #
1106
- # Note that `RegisterInstanceWithLoadBalancer` completes when the
1107
- # request has been registered. Instance registration takes a little time
1108
- # to complete. To check the state of the registered instances, use
1109
- # DescribeLoadBalancers or DescribeInstanceHealth.
1110
- #
1111
- # After the instance is registered, it starts receiving traffic and
1112
- # requests from the load balancer. Any instance that is not in one of
1113
- # the Availability Zones registered for the load balancer is moved to
1114
- # the `OutOfService` state. If an Availability Zone is added to the load
1115
- # balancer later, any instances registered with the load balancer move
1116
- # to the `InService` state.
1117
- #
1118
- # To deregister instances from a load balancer, use
1119
- # DeregisterInstancesFromLoadBalancer.
1120
- #
1121
- # For more information, see [Register or De-Register EC2 Instances][1]
1122
- # in the *Classic Load Balancers Guide*.
1123
- #
1124
- #
1125
- #
1126
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html
1127
- # @option params [required, String] :load_balancer_name
1128
- # The name of the load balancer.
1129
- # @option params [required, Array<Types::Instance>] :instances
1130
- # The IDs of the instances.
1131
- # @return [Types::RegisterEndPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1132
- #
1133
- # * {Types::RegisterEndPointsOutput#instances #Instances} => Array&lt;Types::Instance&gt;
1134
- #
1135
- # @example Request syntax with placeholder values
1136
- # resp = client.register_instances_with_load_balancer({
1137
- # load_balancer_name: "AccessPointName", # required
1138
- # instances: [ # required
1139
- # {
1140
- # instance_id: "InstanceId",
1141
- # },
1142
- # ],
1143
- # })
1144
- #
1145
- # @example Response structure
1146
- # resp.instances #=> Array
1147
- # resp.instances[0].instance_id #=> String
1148
- # @overload register_instances_with_load_balancer(params = {})
1149
- # @param [Hash] params ({})
1150
- def register_instances_with_load_balancer(params = {}, options = {})
1151
- req = build_request(:register_instances_with_load_balancer, params)
1152
- req.send_request(options)
1153
- end
1204
+ # Modifies the attributes of the specified load balancer.
1205
+ #
1206
+ # You can modify the load balancer attributes, such as `AccessLogs`,
1207
+ # `ConnectionDraining`, and `CrossZoneLoadBalancing` by either enabling
1208
+ # or disabling them. Or, you can modify the load balancer attribute
1209
+ # `ConnectionSettings` by specifying an idle connection timeout value
1210
+ # for your load balancer.
1211
+ #
1212
+ # For more information, see the following in the *Classic Load Balancers
1213
+ # Guide*\:
1214
+ #
1215
+ # * [Cross-Zone Load Balancing][1]
1216
+ #
1217
+ # * [Connection Draining][2]
1218
+ #
1219
+ # * [Access Logs][3]
1220
+ #
1221
+ # * [Idle Connection Timeout][4]
1222
+ #
1223
+ #
1224
+ #
1225
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html
1226
+ # [2]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html
1227
+ # [3]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/access-log-collection.html
1228
+ # [4]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html
1229
+ #
1230
+ # @option params [required, String] :load_balancer_name
1231
+ # The name of the load balancer.
1232
+ #
1233
+ # @option params [required, Types::LoadBalancerAttributes] :load_balancer_attributes
1234
+ # The attributes of the load balancer.
1235
+ #
1236
+ # @return [Types::ModifyLoadBalancerAttributesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1237
+ #
1238
+ # * {Types::ModifyLoadBalancerAttributesOutput#load_balancer_name #load_balancer_name} => String
1239
+ # * {Types::ModifyLoadBalancerAttributesOutput#load_balancer_attributes #load_balancer_attributes} => Types::LoadBalancerAttributes
1240
+ #
1241
+ # @example Request syntax with placeholder values
1242
+ #
1243
+ # resp = client.modify_load_balancer_attributes({
1244
+ # load_balancer_name: "AccessPointName", # required
1245
+ # load_balancer_attributes: { # required
1246
+ # cross_zone_load_balancing: {
1247
+ # enabled: false, # required
1248
+ # },
1249
+ # access_log: {
1250
+ # enabled: false, # required
1251
+ # s3_bucket_name: "S3BucketName",
1252
+ # emit_interval: 1,
1253
+ # s3_bucket_prefix: "AccessLogPrefix",
1254
+ # },
1255
+ # connection_draining: {
1256
+ # enabled: false, # required
1257
+ # timeout: 1,
1258
+ # },
1259
+ # connection_settings: {
1260
+ # idle_timeout: 1, # required
1261
+ # },
1262
+ # additional_attributes: [
1263
+ # {
1264
+ # key: "AdditionalAttributeKey",
1265
+ # value: "AdditionalAttributeValue",
1266
+ # },
1267
+ # ],
1268
+ # },
1269
+ # })
1270
+ #
1271
+ # @example Response structure
1272
+ #
1273
+ # resp.load_balancer_name #=> String
1274
+ # resp.load_balancer_attributes.cross_zone_load_balancing.enabled #=> Boolean
1275
+ # resp.load_balancer_attributes.access_log.enabled #=> Boolean
1276
+ # resp.load_balancer_attributes.access_log.s3_bucket_name #=> String
1277
+ # resp.load_balancer_attributes.access_log.emit_interval #=> Integer
1278
+ # resp.load_balancer_attributes.access_log.s3_bucket_prefix #=> String
1279
+ # resp.load_balancer_attributes.connection_draining.enabled #=> Boolean
1280
+ # resp.load_balancer_attributes.connection_draining.timeout #=> Integer
1281
+ # resp.load_balancer_attributes.connection_settings.idle_timeout #=> Integer
1282
+ # resp.load_balancer_attributes.additional_attributes #=> Array
1283
+ # resp.load_balancer_attributes.additional_attributes[0].key #=> String
1284
+ # resp.load_balancer_attributes.additional_attributes[0].value #=> String
1285
+ #
1286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/ModifyLoadBalancerAttributes AWS API Documentation
1287
+ #
1288
+ # @overload modify_load_balancer_attributes(params = {})
1289
+ # @param [Hash] params ({})
1290
+ def modify_load_balancer_attributes(params = {}, options = {})
1291
+ req = build_request(:modify_load_balancer_attributes, params)
1292
+ req.send_request(options)
1293
+ end
1154
1294
 
1155
- # Removes one or more tags from the specified load balancer.
1156
- # @option params [required, Array<String>] :load_balancer_names
1157
- # The name of the load balancer. You can specify a maximum of one load
1158
- # balancer name.
1159
- # @option params [required, Array<Types::TagKeyOnly>] :tags
1160
- # The list of tag keys to remove.
1161
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1162
- #
1163
- # @example Request syntax with placeholder values
1164
- # resp = client.remove_tags({
1165
- # load_balancer_names: ["AccessPointName"], # required
1166
- # tags: [ # required
1167
- # {
1168
- # key: "TagKey",
1169
- # },
1170
- # ],
1171
- # })
1172
- # @overload remove_tags(params = {})
1173
- # @param [Hash] params ({})
1174
- def remove_tags(params = {}, options = {})
1175
- req = build_request(:remove_tags, params)
1176
- req.send_request(options)
1177
- end
1295
+ # Adds the specified instances to the specified load balancer.
1296
+ #
1297
+ # The instance must be a running instance in the same network as the
1298
+ # load balancer (EC2-Classic or the same VPC). If you have EC2-Classic
1299
+ # instances and a load balancer in a VPC with ClassicLink enabled, you
1300
+ # can link the EC2-Classic instances to that VPC and then register the
1301
+ # linked EC2-Classic instances with the load balancer in the VPC.
1302
+ #
1303
+ # Note that `RegisterInstanceWithLoadBalancer` completes when the
1304
+ # request has been registered. Instance registration takes a little time
1305
+ # to complete. To check the state of the registered instances, use
1306
+ # DescribeLoadBalancers or DescribeInstanceHealth.
1307
+ #
1308
+ # After the instance is registered, it starts receiving traffic and
1309
+ # requests from the load balancer. Any instance that is not in one of
1310
+ # the Availability Zones registered for the load balancer is moved to
1311
+ # the `OutOfService` state. If an Availability Zone is added to the load
1312
+ # balancer later, any instances registered with the load balancer move
1313
+ # to the `InService` state.
1314
+ #
1315
+ # To deregister instances from a load balancer, use
1316
+ # DeregisterInstancesFromLoadBalancer.
1317
+ #
1318
+ # For more information, see [Register or De-Register EC2 Instances][1]
1319
+ # in the *Classic Load Balancers Guide*.
1320
+ #
1321
+ #
1322
+ #
1323
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html
1324
+ #
1325
+ # @option params [required, String] :load_balancer_name
1326
+ # The name of the load balancer.
1327
+ #
1328
+ # @option params [required, Array<Types::Instance>] :instances
1329
+ # The IDs of the instances.
1330
+ #
1331
+ # @return [Types::RegisterEndPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1332
+ #
1333
+ # * {Types::RegisterEndPointsOutput#instances #instances} => Array&lt;Types::Instance&gt;
1334
+ #
1335
+ # @example Request syntax with placeholder values
1336
+ #
1337
+ # resp = client.register_instances_with_load_balancer({
1338
+ # load_balancer_name: "AccessPointName", # required
1339
+ # instances: [ # required
1340
+ # {
1341
+ # instance_id: "InstanceId",
1342
+ # },
1343
+ # ],
1344
+ # })
1345
+ #
1346
+ # @example Response structure
1347
+ #
1348
+ # resp.instances #=> Array
1349
+ # resp.instances[0].instance_id #=> String
1350
+ #
1351
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/RegisterInstancesWithLoadBalancer AWS API Documentation
1352
+ #
1353
+ # @overload register_instances_with_load_balancer(params = {})
1354
+ # @param [Hash] params ({})
1355
+ def register_instances_with_load_balancer(params = {}, options = {})
1356
+ req = build_request(:register_instances_with_load_balancer, params)
1357
+ req.send_request(options)
1358
+ end
1178
1359
 
1179
- # Sets the certificate that terminates the specified listener's SSL
1180
- # connections. The specified certificate replaces any prior certificate
1181
- # that was used on the same load balancer and port.
1182
- #
1183
- # For more information about updating your SSL certificate, see [Replace
1184
- # the SSL Certificate for Your Load Balancer][1] in the *Classic Load
1185
- # Balancers Guide*.
1186
- #
1187
- #
1188
- #
1189
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-update-ssl-cert.html
1190
- # @option params [required, String] :load_balancer_name
1191
- # The name of the load balancer.
1192
- # @option params [required, Integer] :load_balancer_port
1193
- # The port that uses the specified SSL certificate.
1194
- # @option params [required, String] :ssl_certificate_id
1195
- # The Amazon Resource Name (ARN) of the SSL certificate.
1196
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1197
- #
1198
- # @example Request syntax with placeholder values
1199
- # resp = client.set_load_balancer_listener_ssl_certificate({
1200
- # load_balancer_name: "AccessPointName", # required
1201
- # load_balancer_port: 1, # required
1202
- # ssl_certificate_id: "SSLCertificateId", # required
1203
- # })
1204
- # @overload set_load_balancer_listener_ssl_certificate(params = {})
1205
- # @param [Hash] params ({})
1206
- def set_load_balancer_listener_ssl_certificate(params = {}, options = {})
1207
- req = build_request(:set_load_balancer_listener_ssl_certificate, params)
1208
- req.send_request(options)
1209
- end
1360
+ # Removes one or more tags from the specified load balancer.
1361
+ #
1362
+ # @option params [required, Array<String>] :load_balancer_names
1363
+ # The name of the load balancer. You can specify a maximum of one load
1364
+ # balancer name.
1365
+ #
1366
+ # @option params [required, Array<Types::TagKeyOnly>] :tags
1367
+ # The list of tag keys to remove.
1368
+ #
1369
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1370
+ #
1371
+ # @example Request syntax with placeholder values
1372
+ #
1373
+ # resp = client.remove_tags({
1374
+ # load_balancer_names: ["AccessPointName"], # required
1375
+ # tags: [ # required
1376
+ # {
1377
+ # key: "TagKey",
1378
+ # },
1379
+ # ],
1380
+ # })
1381
+ #
1382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/RemoveTags AWS API Documentation
1383
+ #
1384
+ # @overload remove_tags(params = {})
1385
+ # @param [Hash] params ({})
1386
+ def remove_tags(params = {}, options = {})
1387
+ req = build_request(:remove_tags, params)
1388
+ req.send_request(options)
1389
+ end
1210
1390
 
1211
- # Replaces the set of policies associated with the specified port on
1212
- # which the EC2 instance is listening with a new set of policies. At
1213
- # this time, only the back-end server authentication policy type can be
1214
- # applied to the instance ports; this policy type is composed of
1215
- # multiple public key policies.
1216
- #
1217
- # Each time you use `SetLoadBalancerPoliciesForBackendServer` to enable
1218
- # the policies, use the `PolicyNames` parameter to list the policies
1219
- # that you want to enable.
1220
- #
1221
- # You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to
1222
- # verify that the policy is associated with the EC2 instance.
1223
- #
1224
- # For more information about enabling back-end instance authentication,
1225
- # see [Configure Back-end Instance Authentication][1] in the *Classic
1226
- # Load Balancers Guide*. For more information about Proxy Protocol, see
1227
- # [Configure Proxy Protocol Support][2] in the *Classic Load Balancers
1228
- # Guide*.
1229
- #
1230
- #
1231
- #
1232
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-create-https-ssl-load-balancer.html#configure_backendauth_clt
1233
- # [2]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-proxy-protocol.html
1234
- # @option params [required, String] :load_balancer_name
1235
- # The name of the load balancer.
1236
- # @option params [required, Integer] :instance_port
1237
- # The port number associated with the EC2 instance.
1238
- # @option params [required, Array<String>] :policy_names
1239
- # The names of the policies. If the list is empty, then all current
1240
- # polices are removed from the EC2 instance.
1241
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1242
- #
1243
- # @example Request syntax with placeholder values
1244
- # resp = client.set_load_balancer_policies_for_backend_server({
1245
- # load_balancer_name: "AccessPointName", # required
1246
- # instance_port: 1, # required
1247
- # policy_names: ["PolicyName"], # required
1248
- # })
1249
- # @overload set_load_balancer_policies_for_backend_server(params = {})
1250
- # @param [Hash] params ({})
1251
- def set_load_balancer_policies_for_backend_server(params = {}, options = {})
1252
- req = build_request(:set_load_balancer_policies_for_backend_server, params)
1253
- req.send_request(options)
1254
- end
1391
+ # Sets the certificate that terminates the specified listener's SSL
1392
+ # connections. The specified certificate replaces any prior certificate
1393
+ # that was used on the same load balancer and port.
1394
+ #
1395
+ # For more information about updating your SSL certificate, see [Replace
1396
+ # the SSL Certificate for Your Load Balancer][1] in the *Classic Load
1397
+ # Balancers Guide*.
1398
+ #
1399
+ #
1400
+ #
1401
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-update-ssl-cert.html
1402
+ #
1403
+ # @option params [required, String] :load_balancer_name
1404
+ # The name of the load balancer.
1405
+ #
1406
+ # @option params [required, Integer] :load_balancer_port
1407
+ # The port that uses the specified SSL certificate.
1408
+ #
1409
+ # @option params [required, String] :ssl_certificate_id
1410
+ # The Amazon Resource Name (ARN) of the SSL certificate.
1411
+ #
1412
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1413
+ #
1414
+ # @example Request syntax with placeholder values
1415
+ #
1416
+ # resp = client.set_load_balancer_listener_ssl_certificate({
1417
+ # load_balancer_name: "AccessPointName", # required
1418
+ # load_balancer_port: 1, # required
1419
+ # ssl_certificate_id: "SSLCertificateId", # required
1420
+ # })
1421
+ #
1422
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/SetLoadBalancerListenerSSLCertificate AWS API Documentation
1423
+ #
1424
+ # @overload set_load_balancer_listener_ssl_certificate(params = {})
1425
+ # @param [Hash] params ({})
1426
+ def set_load_balancer_listener_ssl_certificate(params = {}, options = {})
1427
+ req = build_request(:set_load_balancer_listener_ssl_certificate, params)
1428
+ req.send_request(options)
1429
+ end
1255
1430
 
1256
- # Replaces the current set of policies for the specified load balancer
1257
- # port with the specified set of policies.
1258
- #
1259
- # To enable back-end server authentication, use
1260
- # SetLoadBalancerPoliciesForBackendServer.
1261
- #
1262
- # For more information about setting policies, see [Update the SSL
1263
- # Negotiation Configuration][1], [Duration-Based Session Stickiness][2],
1264
- # and [Application-Controlled Session Stickiness][3] in the *Classic
1265
- # Load Balancers Guide*.
1266
- #
1267
- #
1268
- #
1269
- # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/ssl-config-update.html
1270
- # [2]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration
1271
- # [3]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application
1272
- # @option params [required, String] :load_balancer_name
1273
- # The name of the load balancer.
1274
- # @option params [required, Integer] :load_balancer_port
1275
- # The external port of the load balancer.
1276
- # @option params [required, Array<String>] :policy_names
1277
- # The names of the policies. This list must include all policies to be
1278
- # enabled. If you omit a policy that is currently enabled, it is
1279
- # disabled. If the list is empty, all current policies are disabled.
1280
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1281
- #
1282
- # @example Request syntax with placeholder values
1283
- # resp = client.set_load_balancer_policies_of_listener({
1284
- # load_balancer_name: "AccessPointName", # required
1285
- # load_balancer_port: 1, # required
1286
- # policy_names: ["PolicyName"], # required
1287
- # })
1288
- # @overload set_load_balancer_policies_of_listener(params = {})
1289
- # @param [Hash] params ({})
1290
- def set_load_balancer_policies_of_listener(params = {}, options = {})
1291
- req = build_request(:set_load_balancer_policies_of_listener, params)
1292
- req.send_request(options)
1293
- end
1431
+ # Replaces the set of policies associated with the specified port on
1432
+ # which the EC2 instance is listening with a new set of policies. At
1433
+ # this time, only the back-end server authentication policy type can be
1434
+ # applied to the instance ports; this policy type is composed of
1435
+ # multiple public key policies.
1436
+ #
1437
+ # Each time you use `SetLoadBalancerPoliciesForBackendServer` to enable
1438
+ # the policies, use the `PolicyNames` parameter to list the policies
1439
+ # that you want to enable.
1440
+ #
1441
+ # You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to
1442
+ # verify that the policy is associated with the EC2 instance.
1443
+ #
1444
+ # For more information about enabling back-end instance authentication,
1445
+ # see [Configure Back-end Instance Authentication][1] in the *Classic
1446
+ # Load Balancers Guide*. For more information about Proxy Protocol, see
1447
+ # [Configure Proxy Protocol Support][2] in the *Classic Load Balancers
1448
+ # Guide*.
1449
+ #
1450
+ #
1451
+ #
1452
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-create-https-ssl-load-balancer.html#configure_backendauth_clt
1453
+ # [2]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-proxy-protocol.html
1454
+ #
1455
+ # @option params [required, String] :load_balancer_name
1456
+ # The name of the load balancer.
1457
+ #
1458
+ # @option params [required, Integer] :instance_port
1459
+ # The port number associated with the EC2 instance.
1460
+ #
1461
+ # @option params [required, Array<String>] :policy_names
1462
+ # The names of the policies. If the list is empty, then all current
1463
+ # polices are removed from the EC2 instance.
1464
+ #
1465
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1466
+ #
1467
+ # @example Request syntax with placeholder values
1468
+ #
1469
+ # resp = client.set_load_balancer_policies_for_backend_server({
1470
+ # load_balancer_name: "AccessPointName", # required
1471
+ # instance_port: 1, # required
1472
+ # policy_names: ["PolicyName"], # required
1473
+ # })
1474
+ #
1475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/SetLoadBalancerPoliciesForBackendServer AWS API Documentation
1476
+ #
1477
+ # @overload set_load_balancer_policies_for_backend_server(params = {})
1478
+ # @param [Hash] params ({})
1479
+ def set_load_balancer_policies_for_backend_server(params = {}, options = {})
1480
+ req = build_request(:set_load_balancer_policies_for_backend_server, params)
1481
+ req.send_request(options)
1482
+ end
1294
1483
 
1295
- # @!endgroup
1484
+ # Replaces the current set of policies for the specified load balancer
1485
+ # port with the specified set of policies.
1486
+ #
1487
+ # To enable back-end server authentication, use
1488
+ # SetLoadBalancerPoliciesForBackendServer.
1489
+ #
1490
+ # For more information about setting policies, see [Update the SSL
1491
+ # Negotiation Configuration][1], [Duration-Based Session Stickiness][2],
1492
+ # and [Application-Controlled Session Stickiness][3] in the *Classic
1493
+ # Load Balancers Guide*.
1494
+ #
1495
+ #
1496
+ #
1497
+ # [1]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/ssl-config-update.html
1498
+ # [2]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration
1499
+ # [3]: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application
1500
+ #
1501
+ # @option params [required, String] :load_balancer_name
1502
+ # The name of the load balancer.
1503
+ #
1504
+ # @option params [required, Integer] :load_balancer_port
1505
+ # The external port of the load balancer.
1506
+ #
1507
+ # @option params [required, Array<String>] :policy_names
1508
+ # The names of the policies. This list must include all policies to be
1509
+ # enabled. If you omit a policy that is currently enabled, it is
1510
+ # disabled. If the list is empty, all current policies are disabled.
1511
+ #
1512
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1513
+ #
1514
+ # @example Request syntax with placeholder values
1515
+ #
1516
+ # resp = client.set_load_balancer_policies_of_listener({
1517
+ # load_balancer_name: "AccessPointName", # required
1518
+ # load_balancer_port: 1, # required
1519
+ # policy_names: ["PolicyName"], # required
1520
+ # })
1521
+ #
1522
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancing-2012-06-01/SetLoadBalancerPoliciesOfListener AWS API Documentation
1523
+ #
1524
+ # @overload set_load_balancer_policies_of_listener(params = {})
1525
+ # @param [Hash] params ({})
1526
+ def set_load_balancer_policies_of_listener(params = {}, options = {})
1527
+ req = build_request(:set_load_balancer_policies_of_listener, params)
1528
+ req.send_request(options)
1529
+ end
1296
1530
 
1297
- # @param params ({})
1298
- # @api private
1299
- def build_request(operation_name, params = {})
1300
- handlers = @handlers.for(operation_name)
1301
- context = Seahorse::Client::RequestContext.new(
1302
- operation_name: operation_name,
1303
- operation: config.api.operation(operation_name),
1304
- client: self,
1305
- params: params,
1306
- config: config)
1307
- context[:gem_name] = 'aws-sdk-elasticloadbalancing'
1308
- context[:gem_version] = '1.0.0.rc1'
1309
- Seahorse::Client::Request.new(handlers, context)
1310
- end
1531
+ # @!endgroup
1311
1532
 
1312
- # Polls an API operation until a resource enters a desired state.
1313
- #
1314
- # ## Basic Usage
1315
- #
1316
- # A waiter will call an API operation until:
1317
- #
1318
- # * It is successful
1319
- # * It enters a terminal state
1320
- # * It makes the maximum number of attempts
1321
- #
1322
- # In between attempts, the waiter will sleep.
1323
- #
1324
- # # polls in a loop, sleeping between attempts
1325
- # client.waiter_until(waiter_name, params)
1326
- #
1327
- # ## Configuration
1328
- #
1329
- # You can configure the maximum number of polling attempts, and the
1330
- # delay (in seconds) between each polling attempt. You can pass
1331
- # configuration as the final arguments hash.
1332
- #
1333
- # # poll for ~25 seconds
1334
- # client.wait_until(waiter_name, params, {
1335
- # max_attempts: 5,
1336
- # delay: 5,
1337
- # })
1338
- #
1339
- # ## Callbacks
1340
- #
1341
- # You can be notified before each polling attempt and before each
1342
- # delay. If you throw `:success` or `:failure` from these callbacks,
1343
- # it will terminate the waiter.
1344
- #
1345
- # started_at = Time.now
1346
- # client.wait_until(waiter_name, params, {
1347
- #
1348
- # # disable max attempts
1349
- # max_attempts: nil,
1350
- #
1351
- # # poll for 1 hour, instead of a number of attempts
1352
- # before_wait: -> (attempts, response) do
1353
- # throw :failure if Time.now - started_at > 3600
1354
- # end
1355
- # })
1356
- #
1357
- # ## Handling Errors
1358
- #
1359
- # When a waiter is unsuccessful, it will raise an error.
1360
- # All of the failure errors extend from
1361
- # {Aws::Waiters::Errors::WaiterFailed}.
1362
- #
1363
- # begin
1364
- # client.wait_until(...)
1365
- # rescue Aws::Waiters::Errors::WaiterFailed
1366
- # # resource did not enter the desired state in time
1367
- # end
1368
- #
1369
- # ## Valid Waiters
1370
- #
1371
- # The following table lists the valid waiter names, the operations they call,
1372
- # and the default `:delay` and `:max_attempts` values.
1373
- #
1374
- # | waiter_name | params | :delay | :max_attempts |
1375
- # | ----------------------- | --------------------------- | -------- | ------------- |
1376
- # | any_instance_in_service | {#describe_instance_health} | 15 | 40 |
1377
- # | instance_deregistered | {#describe_instance_health} | 15 | 40 |
1378
- # | instance_in_service | {#describe_instance_health} | 15 | 40 |
1379
- #
1380
- # @raise [Errors::FailureStateError] Raised when the waiter terminates
1381
- # because the waiter has entered a state that it will not transition
1382
- # out of, preventing success.
1383
- #
1384
- # @raise [Errors::TooManyAttemptsError] Raised when the configured
1385
- # maximum number of attempts have been made, and the waiter is not
1386
- # yet successful.
1387
- #
1388
- # @raise [Errors::UnexpectedError] Raised when an error is encounted
1389
- # while polling for a resource that is not expected.
1390
- #
1391
- # @raise [Errors::NoSuchWaiterError] Raised when you request to wait
1392
- # for an unknown state.
1393
- #
1394
- # @return [Boolean] Returns `true` if the waiter was successful.
1395
- # @param [Symbol] waiter_name
1396
- # @param [Hash] params ({})
1397
- # @param [Hash] options ({})
1398
- # @option options [Integer] :max_attempts
1399
- # @option options [Integer] :delay
1400
- # @option options [Proc] :before_attempt
1401
- # @option options [Proc] :before_wait
1402
- def wait_until(waiter_name, params = {}, options = {})
1403
- w = waiter(waiter_name, options)
1404
- yield(w.waiter) if block_given? # deprecated
1405
- w.wait(params)
1406
- end
1533
+ # @param params ({})
1534
+ # @api private
1535
+ def build_request(operation_name, params = {})
1536
+ handlers = @handlers.for(operation_name)
1537
+ context = Seahorse::Client::RequestContext.new(
1538
+ operation_name: operation_name,
1539
+ operation: config.api.operation(operation_name),
1540
+ client: self,
1541
+ params: params,
1542
+ config: config)
1543
+ context[:gem_name] = 'aws-sdk-elasticloadbalancing'
1544
+ context[:gem_version] = '1.0.0.rc2'
1545
+ Seahorse::Client::Request.new(handlers, context)
1546
+ end
1407
1547
 
1408
- # @api private
1409
- # @deprecated
1410
- def waiter_names
1411
- waiters.keys
1412
- end
1548
+ # Polls an API operation until a resource enters a desired state.
1549
+ #
1550
+ # ## Basic Usage
1551
+ #
1552
+ # A waiter will call an API operation until:
1553
+ #
1554
+ # * It is successful
1555
+ # * It enters a terminal state
1556
+ # * It makes the maximum number of attempts
1557
+ #
1558
+ # In between attempts, the waiter will sleep.
1559
+ #
1560
+ # # polls in a loop, sleeping between attempts
1561
+ # client.waiter_until(waiter_name, params)
1562
+ #
1563
+ # ## Configuration
1564
+ #
1565
+ # You can configure the maximum number of polling attempts, and the
1566
+ # delay (in seconds) between each polling attempt. You can pass
1567
+ # configuration as the final arguments hash.
1568
+ #
1569
+ # # poll for ~25 seconds
1570
+ # client.wait_until(waiter_name, params, {
1571
+ # max_attempts: 5,
1572
+ # delay: 5,
1573
+ # })
1574
+ #
1575
+ # ## Callbacks
1576
+ #
1577
+ # You can be notified before each polling attempt and before each
1578
+ # delay. If you throw `:success` or `:failure` from these callbacks,
1579
+ # it will terminate the waiter.
1580
+ #
1581
+ # started_at = Time.now
1582
+ # client.wait_until(waiter_name, params, {
1583
+ #
1584
+ # # disable max attempts
1585
+ # max_attempts: nil,
1586
+ #
1587
+ # # poll for 1 hour, instead of a number of attempts
1588
+ # before_wait: -> (attempts, response) do
1589
+ # throw :failure if Time.now - started_at > 3600
1590
+ # end
1591
+ # })
1592
+ #
1593
+ # ## Handling Errors
1594
+ #
1595
+ # When a waiter is unsuccessful, it will raise an error.
1596
+ # All of the failure errors extend from
1597
+ # {Aws::Waiters::Errors::WaiterFailed}.
1598
+ #
1599
+ # begin
1600
+ # client.wait_until(...)
1601
+ # rescue Aws::Waiters::Errors::WaiterFailed
1602
+ # # resource did not enter the desired state in time
1603
+ # end
1604
+ #
1605
+ # ## Valid Waiters
1606
+ #
1607
+ # The following table lists the valid waiter names, the operations they call,
1608
+ # and the default `:delay` and `:max_attempts` values.
1609
+ #
1610
+ # | waiter_name | params | :delay | :max_attempts |
1611
+ # | ----------------------- | --------------------------- | -------- | ------------- |
1612
+ # | any_instance_in_service | {#describe_instance_health} | 15 | 40 |
1613
+ # | instance_deregistered | {#describe_instance_health} | 15 | 40 |
1614
+ # | instance_in_service | {#describe_instance_health} | 15 | 40 |
1615
+ #
1616
+ # @raise [Errors::FailureStateError] Raised when the waiter terminates
1617
+ # because the waiter has entered a state that it will not transition
1618
+ # out of, preventing success.
1619
+ #
1620
+ # @raise [Errors::TooManyAttemptsError] Raised when the configured
1621
+ # maximum number of attempts have been made, and the waiter is not
1622
+ # yet successful.
1623
+ #
1624
+ # @raise [Errors::UnexpectedError] Raised when an error is encounted
1625
+ # while polling for a resource that is not expected.
1626
+ #
1627
+ # @raise [Errors::NoSuchWaiterError] Raised when you request to wait
1628
+ # for an unknown state.
1629
+ #
1630
+ # @return [Boolean] Returns `true` if the waiter was successful.
1631
+ # @param [Symbol] waiter_name
1632
+ # @param [Hash] params ({})
1633
+ # @param [Hash] options ({})
1634
+ # @option options [Integer] :max_attempts
1635
+ # @option options [Integer] :delay
1636
+ # @option options [Proc] :before_attempt
1637
+ # @option options [Proc] :before_wait
1638
+ def wait_until(waiter_name, params = {}, options = {})
1639
+ w = waiter(waiter_name, options)
1640
+ yield(w.waiter) if block_given? # deprecated
1641
+ w.wait(params)
1642
+ end
1413
1643
 
1414
- private
1644
+ # @api private
1645
+ # @deprecated
1646
+ def waiter_names
1647
+ waiters.keys
1648
+ end
1415
1649
 
1416
- # @param [Symbol] waiter_name
1417
- # @param [Hash] options ({})
1418
- def waiter(waiter_name, options = {})
1419
- waiter_class = waiters[waiter_name]
1420
- if waiter_class
1421
- waiter_class.new(options.merge(client: self))
1422
- else
1423
- raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
1424
- end
1425
- end
1650
+ private
1426
1651
 
1427
- def waiters
1428
- {
1429
- instance_deregistered: Waiters::InstanceDeregistered,
1430
- any_instance_in_service: Waiters::AnyInstanceInService,
1431
- instance_in_service: Waiters::InstanceInService
1432
- }
1652
+ # @param [Symbol] waiter_name
1653
+ # @param [Hash] options ({})
1654
+ def waiter(waiter_name, options = {})
1655
+ waiter_class = waiters[waiter_name]
1656
+ if waiter_class
1657
+ waiter_class.new(options.merge(client: self))
1658
+ else
1659
+ raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
1433
1660
  end
1661
+ end
1434
1662
 
1435
- class << self
1663
+ def waiters
1664
+ {
1665
+ any_instance_in_service: Waiters::AnyInstanceInService,
1666
+ instance_deregistered: Waiters::InstanceDeregistered,
1667
+ instance_in_service: Waiters::InstanceInService
1668
+ }
1669
+ end
1436
1670
 
1437
- # @api private
1438
- attr_reader :identifier
1671
+ class << self
1439
1672
 
1440
- # @api private
1441
- def errors_module
1442
- Errors
1443
- end
1673
+ # @api private
1674
+ attr_reader :identifier
1444
1675
 
1676
+ # @api private
1677
+ def errors_module
1678
+ Errors
1445
1679
  end
1680
+
1446
1681
  end
1447
1682
  end
1448
1683
  end