Class: Aws::EKS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::EKS::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb
Overview
An API client for EKS. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::EKS::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
-
#create_addon(params = {}) ⇒ Types::CreateAddonResponse
Creates an Amazon EKS add-on.
-
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates an Amazon EKS control plane.
-
#create_fargate_profile(params = {}) ⇒ Types::CreateFargateProfileResponse
Creates an AWS Fargate profile for your Amazon EKS cluster.
-
#create_nodegroup(params = {}) ⇒ Types::CreateNodegroupResponse
Creates a managed worker node group for an Amazon EKS cluster.
-
#delete_addon(params = {}) ⇒ Types::DeleteAddonResponse
Delete an Amazon EKS add-on.
-
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes the Amazon EKS cluster control plane.
-
#delete_fargate_profile(params = {}) ⇒ Types::DeleteFargateProfileResponse
Deletes an AWS Fargate profile.
-
#delete_nodegroup(params = {}) ⇒ Types::DeleteNodegroupResponse
Deletes an Amazon EKS node group for a cluster.
-
#describe_addon(params = {}) ⇒ Types::DescribeAddonResponse
Describes an Amazon EKS add-on.
-
#describe_addon_versions(params = {}) ⇒ Types::DescribeAddonVersionsResponse
Describes the Kubernetes versions that the add-on can be used with.
-
#describe_cluster(params = {}) ⇒ Types::DescribeClusterResponse
Returns descriptive information about an Amazon EKS cluster.
-
#describe_fargate_profile(params = {}) ⇒ Types::DescribeFargateProfileResponse
Returns descriptive information about an AWS Fargate profile.
-
#describe_nodegroup(params = {}) ⇒ Types::DescribeNodegroupResponse
Returns descriptive information about an Amazon EKS node group.
-
#describe_update(params = {}) ⇒ Types::DescribeUpdateResponse
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
-
#list_addons(params = {}) ⇒ Types::ListAddonsResponse
Lists the available add-ons.
-
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Lists the Amazon EKS clusters in your AWS account in the specified Region.
-
#list_fargate_profiles(params = {}) ⇒ Types::ListFargateProfilesResponse
Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.
-
#list_nodegroups(params = {}) ⇒ Types::ListNodegroupsResponse
Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for an Amazon EKS resource.
-
#list_updates(params = {}) ⇒ Types::ListUpdatesResponse
Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified
resourceArn
. -
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
-
#update_addon(params = {}) ⇒ Types::UpdateAddonResponse
Updates an Amazon EKS add-on.
-
#update_cluster_config(params = {}) ⇒ Types::UpdateClusterConfigResponse
Updates an Amazon EKS cluster configuration.
-
#update_cluster_version(params = {}) ⇒ Types::UpdateClusterVersionResponse
Updates an Amazon EKS cluster to the specified Kubernetes version.
-
#update_nodegroup_config(params = {}) ⇒ Types::UpdateNodegroupConfigResponse
Updates an Amazon EKS managed node group configuration.
-
#update_nodegroup_version(params = {}) ⇒ Types::UpdateNodegroupVersionResponse
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
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.
324 325 326 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#create_addon(params = {}) ⇒ Types::CreateAddonResponse
Creates an Amazon EKS add-on.
Amazon EKS add-ons help to automate the provisioning and lifecycle
management of common operational software for Amazon EKS clusters.
Amazon EKS add-ons can only be used with Amazon EKS clusters running
version 1.18 with platform version eks.3
or later because add-ons
rely on the Server-side Apply Kubernetes feature, which is only
available in Kubernetes 1.18 and later.
434 435 436 437 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 434 def create_addon(params = {}, = {}) req = build_request(:create_addon, params) req.send_request() end |
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates an Amazon EKS control plane.
The Amazon EKS control plane consists of control plane instances that
run the Kubernetes software, such as etcd
and the API server. The
control plane runs in an account managed by AWS, and the Kubernetes
API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS
cluster control plane is single-tenant and unique and runs on its own
set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability
Zones and fronted by an Elastic Load Balancing Network Load Balancer.
Amazon EKS also provisions elastic network interfaces in your VPC
subnets to provide connectivity from the control plane instances to
the worker nodes (for example, to support kubectl exec
, logs
, and
proxy
data flows).
Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.
You can use the endpointPublicAccess
and endpointPrivateAccess
parameters to enable or disable public and private access to your
cluster's Kubernetes API server endpoint. By default, public access
is enabled, and private access is disabled. For more information, see
Amazon EKS Cluster Endpoint Access Control in the Amazon
EKS User Guide .
You can use the logging
parameter to enable or disable exporting the
Kubernetes control plane logs for your cluster to CloudWatch Logs. By
default, cluster control plane logs aren't exported to CloudWatch
Logs. For more information, see Amazon EKS Cluster Control Plane
Logs in the Amazon EKS User Guide .
Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide.
666 667 668 669 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 666 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_fargate_profile(params = {}) ⇒ Types::CreateFargateProfileResponse
Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
When you create a Fargate profile, you must specify a pod execution
role to use with the pods that are scheduled with the profile. This
role is added to the cluster's Kubernetes Role Based Access
Control (RBAC) for authorization so that the kubelet
that is
running on the Fargate infrastructure can register with your Amazon
EKS cluster so that it can appear in your cluster as a node. The pod
execution role also provides IAM permissions to the Fargate
infrastructure to allow read access to Amazon ECR image repositories.
For more information, see Pod Execution Role in the Amazon EKS
User Guide.
Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
If any Fargate profiles in a cluster are in the DELETING
status, you
must wait for that Fargate profile to finish deleting before you can
create any other profiles in that cluster.
For more information, see AWS Fargate Profile in the Amazon EKS User Guide.
802 803 804 805 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 802 def create_fargate_profile(params = {}, = {}) req = build_request(:create_fargate_profile, params) req.send_request() end |
#create_nodegroup(params = {}) ⇒ Types::CreateNodegroupResponse
Creates a managed worker node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Launch template support.
An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide.
1067 1068 1069 1070 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1067 def create_nodegroup(params = {}, = {}) req = build_request(:create_nodegroup, params) req.send_request() end |
#delete_addon(params = {}) ⇒ Types::DeleteAddonResponse
Delete an Amazon EKS add-on.
When you remove the add-on, it will also be deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.
1122 1123 1124 1125 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1122 def delete_addon(params = {}, = {}) req = build_request(:delete_addon, params) req.send_request() end |
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes the Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.
1209 1210 1211 1212 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1209 def delete_cluster(params = {}, = {}) req = build_request(:delete_cluster, params) req.send_request() end |
#delete_fargate_profile(params = {}) ⇒ Types::DeleteFargateProfileResponse
Deletes an AWS Fargate profile.
When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.
Only one Fargate profile in a cluster can be in the DELETING
status
at a time. You must wait for a Fargate profile to finish deleting
before you can delete any other profiles in that cluster.
1265 1266 1267 1268 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1265 def delete_fargate_profile(params = {}, = {}) req = build_request(:delete_fargate_profile, params) req.send_request() end |
#delete_nodegroup(params = {}) ⇒ Types::DeleteNodegroupResponse
Deletes an Amazon EKS node group for a cluster.
1334 1335 1336 1337 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1334 def delete_nodegroup(params = {}, = {}) req = build_request(:delete_nodegroup, params) req.send_request() end |
#describe_addon(params = {}) ⇒ Types::DescribeAddonResponse
Describes an Amazon EKS add-on.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- addon_active
- addon_deleted
1391 1392 1393 1394 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1391 def describe_addon(params = {}, = {}) req = build_request(:describe_addon, params) req.send_request() end |
#describe_addon_versions(params = {}) ⇒ Types::DescribeAddonVersionsResponse
Describes the Kubernetes versions that the add-on can be used with.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1461 1462 1463 1464 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1461 def describe_addon_versions(params = {}, = {}) req = build_request(:describe_addon_versions, params) req.send_request() end |
#describe_cluster(params = {}) ⇒ Types::DescribeClusterResponse
Returns descriptive information about an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by
this operation are required for kubelet
and kubectl
to communicate
with your Kubernetes API server. For more information, see Create a
kubeconfig for Amazon EKS.
ACTIVE
state.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- cluster_active
- cluster_deleted
1575 1576 1577 1578 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1575 def describe_cluster(params = {}, = {}) req = build_request(:describe_cluster, params) req.send_request() end |
#describe_fargate_profile(params = {}) ⇒ Types::DescribeFargateProfileResponse
Returns descriptive information about an AWS Fargate profile.
1621 1622 1623 1624 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1621 def describe_fargate_profile(params = {}, = {}) req = build_request(:describe_fargate_profile, params) req.send_request() end |
#describe_nodegroup(params = {}) ⇒ Types::DescribeNodegroupResponse
Returns descriptive information about an Amazon EKS node group.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- nodegroup_active
- nodegroup_deleted
1695 1696 1697 1698 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1695 def describe_nodegroup(params = {}, = {}) req = build_request(:describe_nodegroup, params) req.send_request() end |
#describe_update(params = {}) ⇒ Types::DescribeUpdateResponse
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
When the status of the update is Succeeded
, the update is complete.
If an update fails, the status is Failed
, and an error detail
explains the reason for the failure.
1756 1757 1758 1759 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1756 def describe_update(params = {}, = {}) req = build_request(:describe_update, params) req.send_request() end |
#list_addons(params = {}) ⇒ Types::ListAddonsResponse
Lists the available add-ons.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1813 1814 1815 1816 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1813 def list_addons(params = {}, = {}) req = build_request(:list_addons, params) req.send_request() end |
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Lists the Amazon EKS clusters in your AWS account in the specified Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1883 1884 1885 1886 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1883 def list_clusters(params = {}, = {}) req = build_request(:list_clusters, params) req.send_request() end |
#list_fargate_profiles(params = {}) ⇒ Types::ListFargateProfilesResponse
Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1938 1939 1940 1941 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1938 def list_fargate_profiles(params = {}, = {}) req = build_request(:list_fargate_profiles, params) req.send_request() end |
#list_nodegroups(params = {}) ⇒ Types::ListNodegroupsResponse
Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region. Self-managed node groups are not listed.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1992 1993 1994 1995 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1992 def list_nodegroups(params = {}, = {}) req = build_request(:list_nodegroups, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for an Amazon EKS resource.
2039 2040 2041 2042 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2039 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_updates(params = {}) ⇒ Types::ListUpdatesResponse
Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2099 2100 2101 2102 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2099 def list_updates(params = {}, = {}) req = build_request(:list_updates, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified
resourceArn
. If existing tags on a resource are not specified in the
request parameters, they are not changed. When a resource is deleted,
the tags associated with that resource are deleted as well. Tags that
you create for Amazon EKS resources do not propagate to any other
resources associated with the cluster. For example, if you tag a
cluster with this operation, that tag does not automatically propagate
to the subnets and worker nodes associated with the cluster.
2136 2137 2138 2139 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2136 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
2164 2165 2166 2167 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2164 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_addon(params = {}) ⇒ Types::UpdateAddonResponse
Updates an Amazon EKS add-on.
2255 2256 2257 2258 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2255 def update_addon(params = {}, = {}) req = build_request(:update_addon, params) req.send_request() end |
#update_cluster_config(params = {}) ⇒ Types::UpdateClusterConfigResponse
Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .
You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .
At this time, you can not update the subnets or security group IDs for an existing cluster.
Cluster updates are asynchronous, and they should finish within a few
minutes. During an update, the cluster status moves to UPDATING
(this status transition is eventually consistent). When the update is
complete (either Failed
or Successful
), the cluster status moves
to Active
.
2375 2376 2377 2378 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2375 def update_cluster_config(params = {}, = {}) req = build_request(:update_cluster_config, params) req.send_request() end |
#update_cluster_version(params = {}) ⇒ Types::UpdateClusterVersionResponse
Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
Cluster updates are asynchronous, and they should finish within a few
minutes. During an update, the cluster status moves to UPDATING
(this status transition is eventually consistent). When the update is
complete (either Failed
or Successful
), the cluster status moves
to Active
.
If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.
2439 2440 2441 2442 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2439 def update_cluster_version(params = {}, = {}) req = build_request(:update_cluster_version, params) req.send_request() end |
#update_nodegroup_config(params = {}) ⇒ Types::UpdateNodegroupConfigResponse
Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.
2515 2516 2517 2518 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2515 def update_nodegroup_config(params = {}, = {}) req = build_request(:update_nodegroup_config, params) req.send_request() end |
#update_nodegroup_version(params = {}) ⇒ Types::UpdateNodegroupVersionResponse
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.
If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.
You cannot roll back a node group to an earlier Kubernetes version or AMI version.
When a node in a managed node group is terminated due to a scaling
action or update, the pods in that node are drained first. Amazon EKS
attempts to drain the nodes gracefully and will fail if it is unable
to do so. You can force
the update if Amazon EKS is unable to drain
the nodes as a result of a pod disruption budget issue.
2646 2647 2648 2649 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2646 def update_nodegroup_version(params = {}, = {}) req = build_request(:update_nodegroup_version, 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 |
---|---|---|---|
addon_active | #describe_addon | 10 | 60 |
addon_deleted | #describe_addon | 10 | 60 |
cluster_active | #describe_cluster | 30 | 40 |
cluster_deleted | #describe_cluster | 30 | 40 |
nodegroup_active | #describe_nodegroup | 30 | 80 |
nodegroup_deleted | #describe_nodegroup | 30 | 40 |
2761 2762 2763 2764 2765 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2761 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |