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
-
#associate_encryption_config(params = {}) ⇒ Types::AssociateEncryptionConfigResponse
Associate encryption configuration to an existing cluster.
-
#associate_identity_provider_config(params = {}) ⇒ Types::AssociateIdentityProviderConfigResponse
Associate an identity provider configuration to a cluster.
-
#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 Fargate profile for your Amazon EKS cluster.
-
#create_nodegroup(params = {}) ⇒ Types::CreateNodegroupResponse
Creates a managed 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 Fargate profile.
-
#delete_nodegroup(params = {}) ⇒ Types::DeleteNodegroupResponse
Deletes an Amazon EKS node group for a cluster.
-
#deregister_cluster(params = {}) ⇒ Types::DeregisterClusterResponse
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
-
#describe_addon(params = {}) ⇒ Types::DescribeAddonResponse
Describes an Amazon EKS add-on.
-
#describe_addon_configuration(params = {}) ⇒ Types::DescribeAddonConfigurationResponse
Returns configuration options.
-
#describe_addon_versions(params = {}) ⇒ Types::DescribeAddonVersionsResponse
Describes the versions for an add-on.
-
#describe_cluster(params = {}) ⇒ Types::DescribeClusterResponse
Returns descriptive information about an Amazon EKS cluster.
-
#describe_fargate_profile(params = {}) ⇒ Types::DescribeFargateProfileResponse
Returns descriptive information about an Fargate profile.
-
#describe_identity_provider_config(params = {}) ⇒ Types::DescribeIdentityProviderConfigResponse
Returns descriptive information about an identity provider configuration.
-
#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 or Amazon EKS add-on.
-
#disassociate_identity_provider_config(params = {}) ⇒ Types::DisassociateIdentityProviderConfigResponse
Disassociates an identity provider configuration from a cluster.
-
#list_addons(params = {}) ⇒ Types::ListAddonsResponse
Lists the available add-ons.
-
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
-
#list_fargate_profiles(params = {}) ⇒ Types::ListFargateProfilesResponse
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.
-
#list_identity_provider_configs(params = {}) ⇒ Types::ListIdentityProviderConfigsResponse
A list of identity provider configurations.
-
#list_nodegroups(params = {}) ⇒ Types::ListNodegroupsResponse
Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services 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 Amazon Web Services account, in the specified Region.
-
#register_cluster(params = {}) ⇒ Types::RegisterClusterResponse
Connects a Kubernetes cluster to the Amazon EKS control plane.
-
#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.
365 366 367 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#associate_encryption_config(params = {}) ⇒ Types::AssociateEncryptionConfigResponse
Associate encryption configuration to an existing cluster.
You can use this API to enable encryption on existing clusters which do not have encryption already enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters.
430 431 432 433 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 430 def associate_encryption_config(params = {}, = {}) req = build_request(:associate_encryption_config, params) req.send_request() end |
#associate_identity_provider_config(params = {}) ⇒ Types::AssociateIdentityProviderConfigResponse
Associate an identity provider configuration to a cluster.
If you want to authenticate identities using an identity provider, you
can create an identity provider configuration and associate it to your
cluster. After configuring authentication to your cluster you can
create Kubernetes roles
and clusterroles
to assign permissions to
the roles, and then bind the roles to the identities using Kubernetes
rolebindings
and clusterrolebindings
. For more information see
Using RBAC Authorization in the Kubernetes documentation.
516 517 518 519 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 516 def associate_identity_provider_config(params = {}, = {}) req = build_request(:associate_identity_provider_config, params) req.send_request() end |
#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. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.
663 664 665 666 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 663 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 Amazon Web Services, and
the Kubernetes API is exposed by the Amazon EKS API server endpoint.
Each Amazon EKS cluster control plane is single tenant and unique. It
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 nodes (for example, to support kubectl exec
, logs
, and proxy
data flows).
Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.
In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.
915 916 917 918 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 915 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_fargate_profile(params = {}) ⇒ Types::CreateFargateProfileResponse
Creates an 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 Fargate Profile in the Amazon EKS User Guide.
1051 1052 1053 1054 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1051 def create_fargate_profile(params = {}, = {}) req = build_request(:create_fargate_profile, params) req.send_request() end |
#create_nodegroup(params = {}) ⇒ Types::CreateNodegroupResponse
Creates a managed 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 Amazon Web Services for an Amazon EKS cluster. For more information, see Managed node groups in the Amazon EKS User Guide.
1353 1354 1355 1356 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1353 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.
1419 1420 1421 1422 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1419 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.
1523 1524 1525 1526 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1523 def delete_cluster(params = {}, = {}) req = build_request(:delete_cluster, params) req.send_request() end |
#delete_fargate_profile(params = {}) ⇒ Types::DeleteFargateProfileResponse
Deletes an 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.
1579 1580 1581 1582 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1579 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.
1654 1655 1656 1657 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1654 def delete_nodegroup(params = {}, = {}) req = build_request(:delete_nodegroup, params) req.send_request() end |
#deregister_cluster(params = {}) ⇒ Types::DeregisterClusterResponse
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
1731 1732 1733 1734 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1731 def deregister_cluster(params = {}, = {}) req = build_request(:deregister_cluster, 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
1793 1794 1795 1796 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1793 def describe_addon(params = {}, = {}) req = build_request(:describe_addon, params) req.send_request() end |
#describe_addon_configuration(params = {}) ⇒ Types::DescribeAddonConfigurationResponse
Returns configuration options.
1839 1840 1841 1842 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1839 def describe_addon_configuration(params = {}, = {}) req = build_request(:describe_addon_configuration, params) req.send_request() end |
#describe_addon_versions(params = {}) ⇒ Types::DescribeAddonVersionsResponse
Describes the versions for an add-on. Information such as the
Kubernetes versions that you can use the add-on with, the owner
,
publisher
, and the type
of the add-on are returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1931 1932 1933 1934 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 1931 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
2062 2063 2064 2065 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2062 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 Fargate profile.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- fargate_profile_active
- fargate_profile_deleted
2114 2115 2116 2117 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2114 def describe_fargate_profile(params = {}, = {}) req = build_request(:describe_fargate_profile, params) req.send_request() end |
#describe_identity_provider_config(params = {}) ⇒ Types::DescribeIdentityProviderConfigResponse
Returns descriptive information about an identity provider configuration.
2164 2165 2166 2167 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2164 def describe_identity_provider_config(params = {}, = {}) req = build_request(:describe_identity_provider_config, 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
2244 2245 2246 2247 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2244 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 or Amazon EKS add-on.
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.
2307 2308 2309 2310 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2307 def describe_update(params = {}, = {}) req = build_request(:describe_update, params) req.send_request() end |
#disassociate_identity_provider_config(params = {}) ⇒ Types::DisassociateIdentityProviderConfigResponse
Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with Amazon Web Services IAM users.
2364 2365 2366 2367 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2364 def disassociate_identity_provider_config(params = {}, = {}) req = build_request(:disassociate_identity_provider_config, 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.
2421 2422 2423 2424 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2421 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 Amazon Web Services account in the specified Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2498 2499 2500 2501 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2498 def list_clusters(params = {}, = {}) req = build_request(:list_clusters, params) req.send_request() end |
#list_fargate_profiles(params = {}) ⇒ Types::ListFargateProfilesResponse
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2553 2554 2555 2556 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2553 def list_fargate_profiles(params = {}, = {}) req = build_request(:list_fargate_profiles, params) req.send_request() end |
#list_identity_provider_configs(params = {}) ⇒ Types::ListIdentityProviderConfigsResponse
A list of identity provider configurations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2608 2609 2610 2611 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2608 def list_identity_provider_configs(params = {}, = {}) req = build_request(:list_identity_provider_configs, params) req.send_request() end |
#list_nodegroups(params = {}) ⇒ Types::ListNodegroupsResponse
Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services 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.
2662 2663 2664 2665 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2662 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.
2709 2710 2711 2712 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2709 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 Amazon Web Services account, in the specified Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2770 2771 2772 2773 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2770 def list_updates(params = {}, = {}) req = build_request(:list_updates, params) req.send_request() end |
#register_cluster(params = {}) ⇒ Types::RegisterClusterResponse
Connects a Kubernetes cluster to the Amazon EKS control plane.
Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.
Cluster connection requires two steps. First, send a
RegisterClusterRequest
to add it to the Amazon EKS control plane.
Second, a Manifest containing the activationID
and
activationCode
must be applied to the Kubernetes cluster through
it's native provider to provide visibility.
After the Manifest is updated and applied, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days, then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.
2890 2891 2892 2893 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2890 def register_cluster(params = {}, = {}) req = build_request(:register_cluster, 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 nodes associated with the cluster.
2927 2928 2929 2930 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2927 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
2955 2956 2957 2958 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 2955 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.
3068 3069 3070 3071 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 3068 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 .
You can't 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
.
3188 3189 3190 3191 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 3188 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.
3252 3253 3254 3255 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 3252 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.
3360 3361 3362 3363 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 3360 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 information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows 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.
3500 3501 3502 3503 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 3500 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 |
fargate_profile_active | #describe_fargate_profile | 10 | 60 |
fargate_profile_deleted | #describe_fargate_profile | 30 | 60 |
nodegroup_active | #describe_nodegroup | 30 | 80 |
nodegroup_deleted | #describe_nodegroup | 30 | 40 |
3617 3618 3619 3620 3621 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/client.rb', line 3617 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |