Class: Aws::ElasticLoadBalancingV2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ElasticLoadBalancingV2::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb
Overview
An API client for ElasticLoadBalancingV2. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ElasticLoadBalancingV2::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_listener_certificates(params = {}) ⇒ Types::AddListenerCertificatesOutput
Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.
-
#add_tags(params = {}) ⇒ Struct
Adds the specified tags to the specified Elastic Load Balancing resource.
-
#create_listener(params = {}) ⇒ Types::CreateListenerOutput
Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
-
#create_load_balancer(params = {}) ⇒ Types::CreateLoadBalancerOutput
Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
-
#create_rule(params = {}) ⇒ Types::CreateRuleOutput
Creates a rule for the specified listener.
-
#create_target_group(params = {}) ⇒ Types::CreateTargetGroupOutput
Creates a target group.
-
#delete_listener(params = {}) ⇒ Struct
Deletes the specified listener.
-
#delete_load_balancer(params = {}) ⇒ Struct
Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
-
#delete_rule(params = {}) ⇒ Struct
Deletes the specified rule.
-
#delete_target_group(params = {}) ⇒ Struct
Deletes the specified target group.
-
#deregister_targets(params = {}) ⇒ Struct
Deregisters the specified targets from the specified target group.
-
#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsOutput
Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.
-
#describe_listener_certificates(params = {}) ⇒ Types::DescribeListenerCertificatesOutput
Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.
-
#describe_listeners(params = {}) ⇒ Types::DescribeListenersOutput
Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
-
#describe_load_balancer_attributes(params = {}) ⇒ Types::DescribeLoadBalancerAttributesOutput
Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
-
#describe_load_balancers(params = {}) ⇒ Types::DescribeLoadBalancersOutput
Describes the specified load balancers or all of your load balancers.
-
#describe_rules(params = {}) ⇒ Types::DescribeRulesOutput
Describes the specified rules or the rules for the specified listener.
-
#describe_ssl_policies(params = {}) ⇒ Types::DescribeSSLPoliciesOutput
Describes the specified policies or all policies used for SSL negotiation.
-
#describe_tags(params = {}) ⇒ Types::DescribeTagsOutput
Describes the tags for the specified Elastic Load Balancing resources.
-
#describe_target_group_attributes(params = {}) ⇒ Types::DescribeTargetGroupAttributesOutput
Describes the attributes for the specified target group.
-
#describe_target_groups(params = {}) ⇒ Types::DescribeTargetGroupsOutput
Describes the specified target groups or all of your target groups.
-
#describe_target_health(params = {}) ⇒ Types::DescribeTargetHealthOutput
Describes the health of the specified targets or all of your targets.
-
#modify_listener(params = {}) ⇒ Types::ModifyListenerOutput
Replaces the specified properties of the specified listener.
-
#modify_load_balancer_attributes(params = {}) ⇒ Types::ModifyLoadBalancerAttributesOutput
Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
-
#modify_rule(params = {}) ⇒ Types::ModifyRuleOutput
Replaces the specified properties of the specified rule.
-
#modify_target_group(params = {}) ⇒ Types::ModifyTargetGroupOutput
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
-
#modify_target_group_attributes(params = {}) ⇒ Types::ModifyTargetGroupAttributesOutput
Modifies the specified attributes of the specified target group.
-
#register_targets(params = {}) ⇒ Struct
Registers the specified targets with the specified target group.
-
#remove_listener_certificates(params = {}) ⇒ Struct
Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.
-
#remove_tags(params = {}) ⇒ Struct
Removes the specified tags from the specified Elastic Load Balancing resources.
-
#set_ip_address_type(params = {}) ⇒ Types::SetIpAddressTypeOutput
Sets the type of IP addresses used by the subnets of the specified load balancer.
-
#set_rule_priorities(params = {}) ⇒ Types::SetRulePrioritiesOutput
Sets the priorities of the specified rules.
-
#set_security_groups(params = {}) ⇒ Types::SetSecurityGroupsOutput
Associates the specified security groups with the specified Application Load Balancer.
-
#set_subnets(params = {}) ⇒ Types::SetSubnetsOutput
Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer or Network Load Balancer.
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.
365 366 367 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#add_listener_certificates(params = {}) ⇒ Types::AddListenerCertificatesOutput
Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.
If the certificate in already in the certificate list, the call is successful but the certificate is not added again.
For more information, see HTTPS listeners in the Application Load Balancers Guide or TLS listeners in the Network Load Balancers Guide.
419 420 421 422 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 419 def add_listener_certificates(params = {}, = {}) req = build_request(:add_listener_certificates, params) req.send_request() end |
#add_tags(params = {}) ⇒ Struct
Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, and rules.
Each tag consists of a key and an optional value. If a resource
already has a tag with the same key, AddTags
updates its value.
477 478 479 480 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 477 def (params = {}, = {}) req = build_request(:add_tags, params) req.send_request() end |
#create_listener(params = {}) ⇒ Types::CreateListenerOutput
Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.
793 794 795 796 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 793 def create_listener(params = {}, = {}) req = build_request(:create_listener, params) req.send_request() end |
#create_load_balancer(params = {}) ⇒ Types::CreateLoadBalancerOutput
Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.
1064 1065 1066 1067 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1064 def create_load_balancer(params = {}, = {}) req = build_request(:create_load_balancer, params) req.send_request() end |
#create_rule(params = {}) ⇒ Types::CreateRuleOutput
Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.
Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide.
1325 1326 1327 1328 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1325 def create_rule(params = {}, = {}) req = build_request(:create_rule, params) req.send_request() end |
#create_target_group(params = {}) ⇒ Types::CreateTargetGroupOutput
Creates a target group.
For more information, see the following:
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.
1574 1575 1576 1577 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1574 def create_target_group(params = {}, = {}) req = build_request(:create_target_group, params) req.send_request() end |
#delete_listener(params = {}) ⇒ Struct
Deletes the specified listener.
Alternatively, your listener is deleted when you delete the load balancer to which it is attached.
1608 1609 1610 1611 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1608 def delete_listener(params = {}, = {}) req = build_request(:delete_listener, params) req.send_request() end |
#delete_load_balancer(params = {}) ⇒ Struct
Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners.
You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.
Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.
1650 1651 1652 1653 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1650 def delete_load_balancer(params = {}, = {}) req = build_request(:delete_load_balancer, params) req.send_request() end |
#delete_rule(params = {}) ⇒ Struct
Deletes the specified rule.
You can't delete the default rule.
1683 1684 1685 1686 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1683 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#delete_target_group(params = {}) ⇒ Struct
Deletes the specified target group.
You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks. Deleting a target group does not affect its registered targets. For example, any EC2 instances continue to run until you stop or terminate them.
1720 1721 1722 1723 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1720 def delete_target_group(params = {}, = {}) req = build_request(:delete_target_group, params) req.send_request() end |
#deregister_targets(params = {}) ⇒ Struct
Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
1770 1771 1772 1773 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1770 def deregister_targets(params = {}, = {}) req = build_request(:deregister_targets, params) req.send_request() end |
#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsOutput
Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.
For more information, see the following:
1822 1823 1824 1825 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1822 def describe_account_limits(params = {}, = {}) req = build_request(:describe_account_limits, params) req.send_request() end |
#describe_listener_certificates(params = {}) ⇒ Types::DescribeListenerCertificatesOutput
Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.
If the default certificate is also in the certificate list, it appears
twice in the results (once with IsDefault
set to true and once with
IsDefault
set to false).
For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.
1877 1878 1879 1880 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1877 def describe_listener_certificates(params = {}, = {}) req = build_request(:describe_listener_certificates, params) req.send_request() end |
#describe_listeners(params = {}) ⇒ Types::DescribeListenersOutput
Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2004 2005 2006 2007 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2004 def describe_listeners(params = {}, = {}) req = build_request(:describe_listeners, params) req.send_request() end |
#describe_load_balancer_attributes(params = {}) ⇒ Types::DescribeLoadBalancerAttributesOutput
Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
Load balancer attributes in the Application Load Balancers Guide
Load balancer attributes in the Network Load Balancers Guide
Load balancer attributes in the Gateway Load Balancers Guide
2085 2086 2087 2088 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2085 def describe_load_balancer_attributes(params = {}, = {}) req = build_request(:describe_load_balancer_attributes, params) req.send_request() end |
#describe_load_balancers(params = {}) ⇒ Types::DescribeLoadBalancersOutput
Describes the specified load balancers or all of your load balancers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- load_balancer_available
- load_balancer_exists
- load_balancers_deleted
2204 2205 2206 2207 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2204 def describe_load_balancers(params = {}, = {}) req = build_request(:describe_load_balancers, params) req.send_request() end |
#describe_rules(params = {}) ⇒ Types::DescribeRulesOutput
Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
2345 2346 2347 2348 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2345 def describe_rules(params = {}, = {}) req = build_request(:describe_rules, params) req.send_request() end |
#describe_ssl_policies(params = {}) ⇒ Types::DescribeSSLPoliciesOutput
Describes the specified policies or all policies used for SSL negotiation.
For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide.
2510 2511 2512 2513 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2510 def describe_ssl_policies(params = {}, = {}) req = build_request(:describe_ssl_policies, params) req.send_request() end |
#describe_tags(params = {}) ⇒ Types::DescribeTagsOutput
Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
2576 2577 2578 2579 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2576 def (params = {}, = {}) req = build_request(:describe_tags, params) req.send_request() end |
#describe_target_group_attributes(params = {}) ⇒ Types::DescribeTargetGroupAttributesOutput
Describes the attributes for the specified target group.
For more information, see the following:
Target group attributes in the Application Load Balancers Guide
Target group attributes in the Network Load Balancers Guide
Target group attributes in the Gateway Load Balancers Guide
2652 2653 2654 2655 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2652 def describe_target_group_attributes(params = {}, = {}) req = build_request(:describe_target_group_attributes, params) req.send_request() end |
#describe_target_groups(params = {}) ⇒ Types::DescribeTargetGroupsOutput
Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2762 2763 2764 2765 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2762 def describe_target_groups(params = {}, = {}) req = build_request(:describe_target_groups, params) req.send_request() end |
#describe_target_health(params = {}) ⇒ Types::DescribeTargetHealthOutput
Describes the health of the specified targets or all of your targets.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- target_deregistered
- target_in_service
2880 2881 2882 2883 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2880 def describe_target_health(params = {}, = {}) req = build_request(:describe_target_health, params) req.send_request() end |
#modify_listener(params = {}) ⇒ Types::ModifyListenerOutput
Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.
Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.
To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.
3164 3165 3166 3167 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3164 def modify_listener(params = {}, = {}) req = build_request(:modify_listener, params) req.send_request() end |
#modify_load_balancer_attributes(params = {}) ⇒ Types::ModifyLoadBalancerAttributesOutput
Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.
3338 3339 3340 3341 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3338 def modify_load_balancer_attributes(params = {}, = {}) req = build_request(:modify_load_balancer_attributes, params) req.send_request() end |
#modify_rule(params = {}) ⇒ Types::ModifyRuleOutput
Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged.
To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.
3571 3572 3573 3574 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3571 def modify_rule(params = {}, = {}) req = build_request(:modify_rule, params) req.send_request() end |
#modify_target_group(params = {}) ⇒ Types::ModifyTargetGroupOutput
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
3719 3720 3721 3722 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3719 def modify_target_group(params = {}, = {}) req = build_request(:modify_target_group, params) req.send_request() end |
#modify_target_group_attributes(params = {}) ⇒ Types::ModifyTargetGroupAttributesOutput
Modifies the specified attributes of the specified target group.
3795 3796 3797 3798 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3795 def modify_target_group_attributes(params = {}, = {}) req = build_request(:modify_target_group_attributes, params) req.send_request() end |
#register_targets(params = {}) ⇒ Struct
Registers the specified targets with the specified target group.
If the target is an EC2 instance, it must be in the running
state
when you register it.
By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports.
With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address.
3877 3878 3879 3880 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3877 def register_targets(params = {}, = {}) req = build_request(:register_targets, params) req.send_request() end |
#remove_listener_certificates(params = {}) ⇒ Struct
Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.
3911 3912 3913 3914 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3911 def remove_listener_certificates(params = {}, = {}) req = build_request(:remove_listener_certificates, params) req.send_request() end |
#remove_tags(params = {}) ⇒ Struct
Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
3955 3956 3957 3958 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3955 def (params = {}, = {}) req = build_request(:remove_tags, params) req.send_request() end |
#set_ip_address_type(params = {}) ⇒ Types::SetIpAddressTypeOutput
Sets the type of IP addresses used by the subnets of the specified load balancer.
3991 3992 3993 3994 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3991 def set_ip_address_type(params = {}, = {}) req = build_request(:set_ip_address_type, params) req.send_request() end |
#set_rule_priorities(params = {}) ⇒ Types::SetRulePrioritiesOutput
Sets the priorities of the specified rules.
You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.
4128 4129 4130 4131 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4128 def set_rule_priorities(params = {}, = {}) req = build_request(:set_rule_priorities, params) req.send_request() end |
#set_security_groups(params = {}) ⇒ Types::SetSecurityGroupsOutput
Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.
You can't specify a security group for a Network Load Balancer or Gateway Load Balancer.
4185 4186 4187 4188 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4185 def set_security_groups(params = {}, = {}) req = build_request(:set_security_groups, params) req.send_request() end |
#set_subnets(params = {}) ⇒ Types::SetSubnetsOutput
Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer or Network Load Balancer. The specified subnets replace the previously enabled subnets.
When you specify subnets for a Network Load Balancer, you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.
4311 4312 4313 4314 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4311 def set_subnets(params = {}, = {}) req = build_request(:set_subnets, 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 |
---|---|---|---|
load_balancer_available | #describe_load_balancers | 15 | 40 |
load_balancer_exists | #describe_load_balancers | 15 | 40 |
load_balancers_deleted | #describe_load_balancers | 15 | 40 |
target_deregistered | #describe_target_health | 15 | 40 |
target_in_service | #describe_target_health | 15 | 40 |
4425 4426 4427 4428 4429 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4425 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |