Class: Aws::ElasticLoadBalancing::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ElasticLoadBalancing::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-elasticloadbalancing/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#add_tags(params = {}) ⇒ Struct
Adds the specified tags to the specified load balancer.
-
#apply_security_groups_to_load_balancer(params = {}) ⇒ Types::ApplySecurityGroupsToLoadBalancerOutput
Associates one or more security groups with your load balancer in a virtual private cloud (VPC).
-
#attach_load_balancer_to_subnets(params = {}) ⇒ Types::AttachLoadBalancerToSubnetsOutput
Adds one or more subnets to the set of configured subnets for the specified load balancer.
-
#configure_health_check(params = {}) ⇒ Types::ConfigureHealthCheckOutput
Specifies the health check settings to use when evaluating the health state of your EC2 instances.
-
#create_app_cookie_stickiness_policy(params = {}) ⇒ Struct
Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie.
-
#create_lb_cookie_stickiness_policy(params = {}) ⇒ Struct
Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period.
-
#create_load_balancer(params = {}) ⇒ Types::CreateAccessPointOutput
Creates a Classic Load Balancer.
-
#create_load_balancer_listeners(params = {}) ⇒ Struct
Creates one or more listeners for the specified load balancer.
-
#create_load_balancer_policy(params = {}) ⇒ Struct
Creates a policy with the specified attributes for the specified load balancer.
-
#delete_load_balancer(params = {}) ⇒ Struct
Deletes the specified load balancer.
-
#delete_load_balancer_listeners(params = {}) ⇒ Struct
Deletes the specified listeners from the specified load balancer.
-
#delete_load_balancer_policy(params = {}) ⇒ Struct
Deletes the specified policy from the specified load balancer.
-
#deregister_instances_from_load_balancer(params = {}) ⇒ Types::DeregisterEndPointsOutput
Deregisters the specified instances from the specified load balancer.
-
#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsOutput
Describes the current Elastic Load Balancing resource limits for your AWS account.
-
#describe_instance_health(params = {}) ⇒ Types::DescribeEndPointStateOutput
Describes the state of the specified instances with respect to the specified load balancer.
-
#describe_load_balancer_attributes(params = {}) ⇒ Types::DescribeLoadBalancerAttributesOutput
Describes the attributes for the specified load balancer.
-
#describe_load_balancer_policies(params = {}) ⇒ Types::DescribeLoadBalancerPoliciesOutput
Describes the specified policies.
-
#describe_load_balancer_policy_types(params = {}) ⇒ Types::DescribeLoadBalancerPolicyTypesOutput
Describes the specified load balancer policy types or all load balancer policy types.
-
#describe_load_balancers(params = {}) ⇒ Types::DescribeAccessPointsOutput
Describes the specified the load balancers.
-
#describe_tags(params = {}) ⇒ Types::DescribeTagsOutput
Describes the tags associated with the specified load balancers.
-
#detach_load_balancer_from_subnets(params = {}) ⇒ Types::DetachLoadBalancerFromSubnetsOutput
Removes the specified subnets from the set of configured subnets for the load balancer.
-
#disable_availability_zones_for_load_balancer(params = {}) ⇒ Types::RemoveAvailabilityZonesOutput
Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer.
-
#enable_availability_zones_for_load_balancer(params = {}) ⇒ Types::AddAvailabilityZonesOutput
Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer.
-
#modify_load_balancer_attributes(params = {}) ⇒ Types::ModifyLoadBalancerAttributesOutput
Modifies the attributes of the specified load balancer.
-
#register_instances_with_load_balancer(params = {}) ⇒ Types::RegisterEndPointsOutput
Adds the specified instances to the specified load balancer.
-
#remove_tags(params = {}) ⇒ Struct
Removes one or more tags from the specified load balancer.
-
#set_load_balancer_listener_ssl_certificate(params = {}) ⇒ Struct
Sets the certificate that terminates the specified listener’s SSL connections.
-
#set_load_balancer_policies_for_backend_server(params = {}) ⇒ Struct
Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies.
-
#set_load_balancer_policies_of_listener(params = {}) ⇒ Struct
Replaces the current set of policies for the specified load balancer port with the specified set of policies.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(*args) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(*args) ⇒ Client
Returns a new instance of Client.
142 143 144 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 142 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2546 2547 2548 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 2546 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2549 2550 2551 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 2549 def errors_module Errors end |
Instance Method Details
#add_tags(params = {}) ⇒ Struct
Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.
Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, ‘AddTags` updates its value.
For more information, see [Tag Your Classic Load Balancer] in the *Classic Load Balancer Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html
207 208 209 210 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 207 def (params = {}, = {}) req = build_request(:add_tags, params) req.send_request() end |
#apply_security_groups_to_load_balancer(params = {}) ⇒ Types::ApplySecurityGroupsToLoadBalancerOutput
Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.
For more information, see [Security Groups for Load Balancers in a VPC] in the *Classic Load Balancer Guide*.
269 270 271 272 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 269 def apply_security_groups_to_load_balancer(params = {}, = {}) req = build_request(:apply_security_groups_to_load_balancer, params) req.send_request() end |
#attach_load_balancer_to_subnets(params = {}) ⇒ Types::AttachLoadBalancerToSubnetsOutput
Adds one or more subnets to the set of configured subnets for the specified load balancer.
The load balancer evenly distributes requests across all registered subnets. For more information, see [Add or Remove Subnets for Your Load Balancer in a VPC] in the *Classic Load Balancer Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-manage-subnets.html
332 333 334 335 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 332 def attach_load_balancer_to_subnets(params = {}, = {}) req = build_request(:attach_load_balancer_to_subnets, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 2407 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-elasticloadbalancing' context[:gem_version] = '1.0.0' Seahorse::Client::Request.new(handlers, context) end |
#configure_health_check(params = {}) ⇒ Types::ConfigureHealthCheckOutput
Specifies the health check settings to use when evaluating the health state of your EC2 instances.
For more information, see [Configure Health Checks for Your Load Balancer] in the *Classic Load Balancer Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-healthchecks.html
409 410 411 412 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 409 def configure_health_check(params = {}, = {}) req = build_request(:configure_health_check, params) req.send_request() end |
#create_app_cookie_stickiness_policy(params = {}) ⇒ Struct
Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.
This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie, ‘AWSELB`, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.
If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.
For more information, see [Application-Controlled Session Stickiness] in the *Classic Load Balancer Guide*.
471 472 473 474 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 471 def (params = {}, = {}) req = build_request(:create_app_cookie_stickiness_policy, params) req.send_request() end |
#create_lb_cookie_stickiness_policy(params = {}) ⇒ Struct
Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.
When a load balancer implements this policy, the load balancer uses a special cookie to track the instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm.
A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.
For more information, see [Duration-Based Session Stickiness] in the *Classic Load Balancer Guide*.
539 540 541 542 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 539 def (params = {}, = {}) req = build_request(:create_lb_cookie_stickiness_policy, params) req.send_request() end |
#create_load_balancer(params = {}) ⇒ Types::CreateAccessPointOutput
Creates a Classic Load Balancer.
You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags.
To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.
You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see [Limits for Your Classic Load Balancer] in the *Classic Load Balancer Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html
807 808 809 810 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 807 def create_load_balancer(params = {}, = {}) req = build_request(:create_load_balancer, params) req.send_request() end |
#create_load_balancer_listeners(params = {}) ⇒ Struct
Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener.
For more information, see [Listeners for Your Classic Load Balancer] in the *Classic Load Balancer Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html
885 886 887 888 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 885 def create_load_balancer_listeners(params = {}, = {}) req = build_request(:create_load_balancer_listeners, params) req.send_request() end |
#create_load_balancer_policy(params = {}) ⇒ Struct
Creates a policy with the specified attributes for the specified load balancer.
Policies are settings that are saved for your load balancer and that can be applied to the listener or the application server, depending on the policy type.
980 981 982 983 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 980 def create_load_balancer_policy(params = {}, = {}) req = build_request(:create_load_balancer_policy, params) req.send_request() end |
#delete_load_balancer(params = {}) ⇒ Struct
Deletes the specified load balancer.
If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to your instances.
If the load balancer does not exist or has already been deleted, the call to ‘DeleteLoadBalancer` still succeeds.
1020 1021 1022 1023 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1020 def delete_load_balancer(params = {}, = {}) req = build_request(:delete_load_balancer, params) req.send_request() end |
#delete_load_balancer_listeners(params = {}) ⇒ Struct
Deletes the specified listeners from the specified load balancer.
1058 1059 1060 1061 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1058 def delete_load_balancer_listeners(params = {}, = {}) req = build_request(:delete_load_balancer_listeners, params) req.send_request() end |
#delete_load_balancer_policy(params = {}) ⇒ Struct
Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.
1095 1096 1097 1098 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1095 def delete_load_balancer_policy(params = {}, = {}) req = build_request(:delete_load_balancer_policy, params) req.send_request() end |
#deregister_instances_from_load_balancer(params = {}) ⇒ Types::DeregisterEndPointsOutput
Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.
You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.
For more information, see [Register or De-Register EC2 Instances] in the *Classic Load Balancer Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html
1170 1171 1172 1173 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1170 def deregister_instances_from_load_balancer(params = {}, = {}) req = build_request(:deregister_instances_from_load_balancer, params) req.send_request() end |
#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsOutput
Describes the current Elastic Load Balancing resource limits for your AWS account.
For more information, see [Limits for Your Classic Load Balancer] in the *Classic Load Balancer Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html
1215 1216 1217 1218 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1215 def describe_account_limits(params = {}, = {}) req = build_request(:describe_account_limits, params) req.send_request() end |
#describe_instance_health(params = {}) ⇒ Types::DescribeEndPointStateOutput
Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned.
1287 1288 1289 1290 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1287 def describe_instance_health(params = {}, = {}) req = build_request(:describe_instance_health, params) req.send_request() end |
#describe_load_balancer_attributes(params = {}) ⇒ Types::DescribeLoadBalancerAttributesOutput
Describes the attributes for the specified load balancer.
1353 1354 1355 1356 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1353 def describe_load_balancer_attributes(params = {}, = {}) req = build_request(:describe_load_balancer_attributes, params) req.send_request() end |
#describe_load_balancer_policies(params = {}) ⇒ Types::DescribeLoadBalancerPoliciesOutput
Describes the specified policies.
If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don’t specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the ‘ELBSample-` prefix.
1426 1427 1428 1429 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1426 def describe_load_balancer_policies(params = {}, = {}) req = build_request(:describe_load_balancer_policies, params) req.send_request() end |
#describe_load_balancer_policy_types(params = {}) ⇒ Types::DescribeLoadBalancerPolicyTypesOutput
Describes the specified load balancer policy types or all load balancer policy types.
The description of each type indicates how it can be used. For example, some policies can be used only with layer 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your EC2 instances.
You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to set the policy.
1502 1503 1504 1505 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1502 def describe_load_balancer_policy_types(params = {}, = {}) req = build_request(:describe_load_balancer_policy_types, params) req.send_request() end |
#describe_load_balancers(params = {}) ⇒ Types::DescribeAccessPointsOutput
Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
1688 1689 1690 1691 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1688 def describe_load_balancers(params = {}, = {}) req = build_request(:describe_load_balancers, params) req.send_request() end |
#describe_tags(params = {}) ⇒ Types::DescribeTagsOutput
Describes the tags associated with the specified load balancers.
1750 1751 1752 1753 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1750 def (params = {}, = {}) req = build_request(:describe_tags, params) req.send_request() end |
#detach_load_balancer_from_subnets(params = {}) ⇒ Types::DetachLoadBalancerFromSubnetsOutput
Removes the specified subnets from the set of configured subnets for the load balancer.
After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the ‘OutOfService` state. Then, the load balancer balances the traffic among the remaining routable subnets.
1808 1809 1810 1811 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1808 def detach_load_balancer_from_subnets(params = {}, = {}) req = build_request(:detach_load_balancer_from_subnets, params) req.send_request() end |
#disable_availability_zones_for_load_balancer(params = {}) ⇒ Types::RemoveAvailabilityZonesOutput
Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer.
There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the ‘OutOfService` state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones.
For more information, see [Add or Remove Availability Zones] in the *Classic Load Balancer Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html
1875 1876 1877 1878 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1875 def disable_availability_zones_for_load_balancer(params = {}, = {}) req = build_request(:disable_availability_zones_for_load_balancer, params) req.send_request() end |
#enable_availability_zones_for_load_balancer(params = {}) ⇒ Types::AddAvailabilityZonesOutput
Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer.
The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.
For more information, see [Add or Remove Availability Zones] in the *Classic Load Balancer Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html
1940 1941 1942 1943 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 1940 def enable_availability_zones_for_load_balancer(params = {}, = {}) req = build_request(:enable_availability_zones_for_load_balancer, params) req.send_request() end |
#modify_load_balancer_attributes(params = {}) ⇒ Types::ModifyLoadBalancerAttributesOutput
Modifies the attributes of the specified load balancer.
You can modify the load balancer attributes, such as ‘AccessLogs`, `ConnectionDraining`, and `CrossZoneLoadBalancing` by either enabling or disabling them. Or, you can modify the load balancer attribute `ConnectionSettings` by specifying an idle connection timeout value for your load balancer.
For more information, see the following in the *Classic Load Balancer Guide*:
- Cross-Zone Load Balancing][1
- Connection Draining][2
- Access Logs][3
- Idle Connection Timeout][4
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html [2]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html [3]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/access-log-collection.html [4]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html
2080 2081 2082 2083 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 2080 def modify_load_balancer_attributes(params = {}, = {}) req = build_request(:modify_load_balancer_attributes, params) req.send_request() end |
#register_instances_with_load_balancer(params = {}) ⇒ Types::RegisterEndPointsOutput
Adds the specified instances to the specified load balancer.
The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC.
Note that ‘RegisterInstanceWithLoadBalancer` completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth.
After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the ‘OutOfService` state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the `InService` state.
To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.
For more information, see [Register or De-Register EC2 Instances] in the *Classic Load Balancer Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html
2174 2175 2176 2177 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 2174 def register_instances_with_load_balancer(params = {}, = {}) req = build_request(:register_instances_with_load_balancer, params) req.send_request() end |
#remove_tags(params = {}) ⇒ Struct
Removes one or more tags from the specified load balancer.
2221 2222 2223 2224 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 2221 def (params = {}, = {}) req = build_request(:remove_tags, params) req.send_request() end |
#set_load_balancer_listener_ssl_certificate(params = {}) ⇒ Struct
Sets the certificate that terminates the specified listener’s SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.
For more information about updating your SSL certificate, see [Replace the SSL Certificate for Your Load Balancer] in the *Classic Load Balancer Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-update-ssl-cert.html
2272 2273 2274 2275 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 2272 def set_load_balancer_listener_ssl_certificate(params = {}, = {}) req = build_request(:set_load_balancer_listener_ssl_certificate, params) req.send_request() end |
#set_load_balancer_policies_for_backend_server(params = {}) ⇒ Struct
Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies.
Each time you use ‘SetLoadBalancerPoliciesForBackendServer` to enable the policies, use the `PolicyNames` parameter to list the policies that you want to enable.
You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the EC2 instance.
For more information about enabling back-end instance authentication, see [Configure Back-end Instance Authentication] in the *Classic Load Balancer Guide*. For more information about Proxy Protocol, see
- Configure Proxy Protocol Support][2
-
in the *Classic Load Balancer
Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-create-https-ssl-load-balancer.html#configure_backendauth_clt [2]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-proxy-protocol.html
2338 2339 2340 2341 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 2338 def set_load_balancer_policies_for_backend_server(params = {}, = {}) req = build_request(:set_load_balancer_policies_for_backend_server, params) req.send_request() end |
#set_load_balancer_policies_of_listener(params = {}) ⇒ Struct
Replaces the current set of policies for the specified load balancer port with the specified set of policies.
To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer.
For more information about setting policies, see [Update the SSL Negotiation Configuration], [Duration-Based Session Stickiness], and [Application-Controlled Session Stickiness] in the *Classic Load Balancer Guide*.
[1]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/ssl-config-update.html [2]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration [3]: docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application
2398 2399 2400 2401 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 2398 def set_load_balancer_policies_of_listener(params = {}, = {}) req = build_request(:set_load_balancer_policies_of_listener, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
## Basic Usage
A waiter will call an API operation until:
-
It is successful
-
It enters a terminal state
-
It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.waiter_until(waiter_name, params)
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
## Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
## Valid Waiters
The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.
| waiter_name | params | :delay | :max_attempts | | ———————– | ————————— | ——– | ————- | | any_instance_in_service | #describe_instance_health | 15 | 40 | | instance_deregistered | #describe_instance_health | 15 | 40 | | instance_in_service | #describe_instance_health | 15 | 40 |
2510 2511 2512 2513 2514 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 2510 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2518 2519 2520 |
# File 'lib/aws-sdk-elasticloadbalancing/client.rb', line 2518 def waiter_names waiters.keys end |