Class: Aws::ElasticLoadBalancing::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ElasticLoadBalancing::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb
Overview
An API client for ElasticLoadBalancing. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ElasticLoadBalancing::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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 in EC2-Classic or a default VPC.
-
#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 in EC2-Classic or a default VPC.
-
#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.
Instance Method Summary collapse
-
#initialize(options) ⇒ 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.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 385 def initialize(*args) super 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 Balancers Guide.
450 451 452 453 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 450 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 Balancers Guide.
512 513 514 515 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 512 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 Balancers Guide.
575 576 577 578 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 575 def attach_load_balancer_to_subnets(params = {}, = {}) req = build_request(:attach_load_balancer_to_subnets, params) req.send_request() 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 Balancers Guide.
652 653 654 655 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 652 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 Balancers Guide.
715 716 717 718 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 715 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 Balancers Guide.
783 784 785 786 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 783 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 Balancers Guide.
1051 1052 1053 1054 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1051 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 Balancers Guide.
1129 1130 1131 1132 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1129 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.
1225 1226 1227 1228 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1225 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.
1265 1266 1267 1268 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1265 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.
1303 1304 1305 1306 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1303 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.
1341 1342 1343 1344 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1341 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 Balancers Guide.
1416 1417 1418 1419 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1416 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 Balancers Guide.
1461 1462 1463 1464 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1461 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.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- any_instance_in_service
- instance_deregistered
- instance_in_service
1540 1541 1542 1543 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1540 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.
1606 1607 1608 1609 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1606 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.
1679 1680 1681 1682 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1679 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.
1755 1756 1757 1758 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1755 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1943 1944 1945 1946 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 1943 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.
2005 2006 2007 2008 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 2005 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.
2063 2064 2065 2066 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 2063 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 in EC2-Classic or a default VPC.
For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets.
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 Balancers Guide.
2133 2134 2135 2136 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 2133 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 in EC2-Classic or a default VPC.
For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets.
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 Balancers Guide.
2200 2201 2202 2203 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 2200 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 Balancers Guide:
2340 2341 2342 2343 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 2340 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 Balancers Guide.
2434 2435 2436 2437 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 2434 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.
2481 2482 2483 2484 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 2481 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 Balancers Guide.
2532 2533 2534 2535 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 2532 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 Balancers Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancers Guide.
2598 2599 2600 2601 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 2598 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 Balancers Guide.
2658 2659 2660 2661 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 2658 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.wait_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 |
2770 2771 2772 2773 2774 |
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/client.rb', line 2770 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |