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.
-
#add_trust_store_revocations(params = {}) ⇒ Types::AddTrustStoreRevocationsOutput
Adds the specified revocation file to the specified trust store.
-
#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.
-
#create_trust_store(params = {}) ⇒ Types::CreateTrustStoreOutput
Creates a trust store.
-
#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_shared_trust_store_association(params = {}) ⇒ Struct
Deletes a shared trust store association.
-
#delete_target_group(params = {}) ⇒ Struct
Deletes the specified target group.
-
#delete_trust_store(params = {}) ⇒ Struct
Deletes a trust store.
-
#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_capacity_reservation(params = {}) ⇒ Types::DescribeCapacityReservationOutput
Describes the capacity reservation status for the specified load balancer.
-
#describe_listener_attributes(params = {}) ⇒ Types::DescribeListenerAttributesOutput
Describes the attributes for the specified listener.
-
#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.
-
#describe_trust_store_associations(params = {}) ⇒ Types::DescribeTrustStoreAssociationsOutput
Describes all resources associated with the specified trust store.
-
#describe_trust_store_revocations(params = {}) ⇒ Types::DescribeTrustStoreRevocationsOutput
Describes the revocation files in use by the specified trust store or revocation files.
-
#describe_trust_stores(params = {}) ⇒ Types::DescribeTrustStoresOutput
Describes all trust stores for the specified account.
-
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyOutput
Retrieves the resource policy for a specified resource.
-
#get_trust_store_ca_certificates_bundle(params = {}) ⇒ Types::GetTrustStoreCaCertificatesBundleOutput
Retrieves the ca certificate bundle.
-
#get_trust_store_revocation_content(params = {}) ⇒ Types::GetTrustStoreRevocationContentOutput
Retrieves the specified revocation file.
-
#modify_capacity_reservation(params = {}) ⇒ Types::ModifyCapacityReservationOutput
Modifies the capacity reservation of the specified load balancer.
-
#modify_ip_pools(params = {}) ⇒ Types::ModifyIpPoolsOutput
[Application Load Balancers] Modify the IP pool associated to a load balancer.
-
#modify_listener(params = {}) ⇒ Types::ModifyListenerOutput
Replaces the specified properties of the specified listener.
-
#modify_listener_attributes(params = {}) ⇒ Types::ModifyListenerAttributesOutput
Modifies the specified attributes 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.
-
#modify_trust_store(params = {}) ⇒ Types::ModifyTrustStoreOutput
Update the ca certificate bundle for the specified trust store.
-
#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.
-
#remove_trust_store_revocations(params = {}) ⇒ Struct
Removes the specified revocation file from the specified trust store.
-
#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 or Network Load Balancer.
-
#set_subnets(params = {}) ⇒ Types::SetSubnetsOutput
Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway 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.
479 480 481 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 479 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 SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.
533 534 535 536 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 533 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, trust stores, 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.
591 592 593 594 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 591 def (params = {}, = {}) req = build_request(:add_tags, params) req.send_request() end |
#add_trust_store_revocations(params = {}) ⇒ Types::AddTrustStoreRevocationsOutput
Adds the specified revocation file to the specified trust store.
634 635 636 637 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 634 def add_trust_store_revocations(params = {}, = {}) req = build_request(:add_trust_store_revocations, 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.
984 985 986 987 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 984 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.
1278 1279 1280 1281 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1278 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 or a dual-stack Network 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 or Listener rules in the Network Load Balancers Guide.
1656 1657 1658 1659 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1656 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.
1912 1913 1914 1915 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1912 def create_target_group(params = {}, = {}) req = build_request(:create_target_group, params) req.send_request() end |
#create_trust_store(params = {}) ⇒ Types::CreateTrustStoreOutput
Creates a trust store.
For more information, see Mutual TLS for Application Load Balancers.
1977 1978 1979 1980 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 1977 def create_trust_store(params = {}, = {}) req = build_request(:create_trust_store, 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.
2011 2012 2013 2014 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2011 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.
2053 2054 2055 2056 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2053 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.
2086 2087 2088 2089 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2086 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#delete_shared_trust_store_association(params = {}) ⇒ Struct
Deletes a shared trust store association.
2122 2123 2124 2125 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2122 def delete_shared_trust_store_association(params = {}, = {}) req = build_request(:delete_shared_trust_store_association, 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.
2159 2160 2161 2162 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2159 def delete_target_group(params = {}, = {}) req = build_request(:delete_target_group, params) req.send_request() end |
#delete_trust_store(params = {}) ⇒ Struct
Deletes a trust store.
2181 2182 2183 2184 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2181 def delete_trust_store(params = {}, = {}) req = build_request(:delete_trust_store, 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.
The load balancer stops sending requests to targets that are deregistering, but uses connection draining to ensure that in-flight traffic completes on the existing connections. This deregistration delay is configured by default but can be updated for each target group.
For more information, see the following:
Deregistration delay in the Application Load Balancers User Guide
Deregistration delay in the Network Load Balancers User Guide
Deregistration delay in the Gateway Load Balancers User Guide
Note: If the specified target does not exist, the action returns successfully.
2258 2259 2260 2261 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2258 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:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2312 2313 2314 2315 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2312 def describe_account_limits(params = {}, = {}) req = build_request(:describe_account_limits, params) req.send_request() end |
#describe_capacity_reservation(params = {}) ⇒ Types::DescribeCapacityReservationOutput
Describes the capacity reservation status for the specified load balancer.
2351 2352 2353 2354 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2351 def describe_capacity_reservation(params = {}, = {}) req = build_request(:describe_capacity_reservation, params) req.send_request() end |
#describe_listener_attributes(params = {}) ⇒ Types::DescribeListenerAttributesOutput
Describes the attributes for the specified listener.
2394 2395 2396 2397 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2394 def describe_listener_attributes(params = {}, = {}) req = build_request(:describe_listener_attributes, 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2451 2452 2453 2454 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2451 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.
2590 2591 2592 2593 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2590 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
2671 2672 2673 2674 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2671 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
2795 2796 2797 2798 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 2795 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 rules.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3028 3029 3030 3031 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3028 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 and Security policies in the Network Load Balancers Guide.
3193 3194 3195 3196 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3193 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.
3259 3260 3261 3262 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3259 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
3335 3336 3337 3338 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3335 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.
3446 3447 3448 3449 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3446 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
3575 3576 3577 3578 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3575 def describe_target_health(params = {}, = {}) req = build_request(:describe_target_health, params) req.send_request() end |
#describe_trust_store_associations(params = {}) ⇒ Types::DescribeTrustStoreAssociationsOutput
Describes all resources associated with the specified trust store.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3617 3618 3619 3620 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3617 def describe_trust_store_associations(params = {}, = {}) req = build_request(:describe_trust_store_associations, params) req.send_request() end |
#describe_trust_store_revocations(params = {}) ⇒ Types::DescribeTrustStoreRevocationsOutput
Describes the revocation files in use by the specified trust store or revocation files.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3667 3668 3669 3670 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3667 def describe_trust_store_revocations(params = {}, = {}) req = build_request(:describe_trust_store_revocations, params) req.send_request() end |
#describe_trust_stores(params = {}) ⇒ Types::DescribeTrustStoresOutput
Describes all trust stores for the specified account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3717 3718 3719 3720 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3717 def describe_trust_stores(params = {}, = {}) req = build_request(:describe_trust_stores, params) req.send_request() end |
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyOutput
Retrieves the resource policy for a specified resource.
3754 3755 3756 3757 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3754 def get_resource_policy(params = {}, = {}) req = build_request(:get_resource_policy, params) req.send_request() end |
#get_trust_store_ca_certificates_bundle(params = {}) ⇒ Types::GetTrustStoreCaCertificatesBundleOutput
Retrieves the ca certificate bundle.
This action returns a pre-signed S3 URI which is active for ten minutes.
3785 3786 3787 3788 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3785 def get_trust_store_ca_certificates_bundle(params = {}, = {}) req = build_request(:get_trust_store_ca_certificates_bundle, params) req.send_request() end |
#get_trust_store_revocation_content(params = {}) ⇒ Types::GetTrustStoreRevocationContentOutput
Retrieves the specified revocation file.
This action returns a pre-signed S3 URI which is active for ten minutes.
3820 3821 3822 3823 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3820 def get_trust_store_revocation_content(params = {}, = {}) req = build_request(:get_trust_store_revocation_content, params) req.send_request() end |
#modify_capacity_reservation(params = {}) ⇒ Types::ModifyCapacityReservationOutput
Modifies the capacity reservation of the specified load balancer.
When modifying capacity reservation, you must include at least one
MinimumLoadBalancerCapacity or ResetCapacityReservation.
3871 3872 3873 3874 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3871 def modify_capacity_reservation(params = {}, = {}) req = build_request(:modify_capacity_reservation, params) req.send_request() end |
#modify_ip_pools(params = {}) ⇒ Types::ModifyIpPoolsOutput
[Application Load Balancers] Modify the IP pool associated to a load balancer.
3910 3911 3912 3913 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 3910 def modify_ip_pools(params = {}, = {}) req = build_request(:modify_ip_pools, 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.
4228 4229 4230 4231 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4228 def modify_listener(params = {}, = {}) req = build_request(:modify_listener, params) req.send_request() end |
#modify_listener_attributes(params = {}) ⇒ Types::ModifyListenerAttributesOutput
Modifies the specified attributes of the specified listener.
4267 4268 4269 4270 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4267 def modify_listener_attributes(params = {}, = {}) req = build_request(:modify_listener_attributes, 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.
4441 4442 4443 4444 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4441 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.
4784 4785 4786 4787 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4784 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.
4936 4937 4938 4939 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 4936 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.
5012 5013 5014 5015 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5012 def modify_target_group_attributes(params = {}, = {}) req = build_request(:modify_target_group_attributes, params) req.send_request() end |
#modify_trust_store(params = {}) ⇒ Types::ModifyTrustStoreOutput
Update the ca certificate bundle for the specified trust store.
5058 5059 5060 5061 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5058 def modify_trust_store(params = {}, = {}) req = build_request(:modify_trust_store, 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.
For more information, see the following:
5150 5151 5152 5153 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5150 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.
5184 5185 5186 5187 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5184 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.
5228 5229 5230 5231 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5228 def (params = {}, = {}) req = build_request(:remove_tags, params) req.send_request() end |
#remove_trust_store_revocations(params = {}) ⇒ Struct
Removes the specified revocation file from the specified trust store.
5254 5255 5256 5257 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5254 def remove_trust_store_revocations(params = {}, = {}) req = build_request(:remove_trust_store_revocations, 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.
5301 5302 5303 5304 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5301 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.
5462 5463 5464 5465 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5462 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 or Network Load Balancer. The specified security groups override the previously associated security groups.
You can't perform this operation on a Network Load Balancer unless you specified a security group for the load balancer when you created it.
You can't associate a security group with a Gateway Load Balancer.
5531 5532 5533 5534 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5531 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, Network Load Balancer or Gateway Load Balancer. The specified subnets replace the previously enabled subnets.
5678 5679 5680 5681 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5678 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 |
5797 5798 5799 5800 5801 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb', line 5797 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |