EKS class

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to stand up or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.

Constructors

EKS({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createAddon({required String addonName, required String clusterName, String? addonVersion, String? clientRequestToken, ResolveConflicts? resolveConflicts, String? serviceAccountRoleArn, Map<String, String>? tags}) → Future<CreateAddonResponse>

Creates an Amazon EKS add-on.

createCluster({required String name, required VpcConfigRequest resourcesVpcConfig, required String roleArn, String? clientRequestToken, List<EncryptionConfig>? encryptionConfig, KubernetesNetworkConfigRequest? kubernetesNetworkConfig, Logging? logging, Map<String, String>? tags, String? version}) → Future<CreateClusterResponse>

Creates an Amazon EKS control plane.

createFargateProfile({required String clusterName, required String fargateProfileName, required String podExecutionRoleArn, String? clientRequestToken, List<FargateProfileSelector>? selectors, List<String>? subnets, Map<String, String>? tags}) → Future<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.

createNodegroup({required String clusterName, required String nodeRole, required String nodegroupName, required List<String> subnets, AMITypes? amiType, CapacityTypes? capacityType, String? clientRequestToken, int? diskSize, List<String>? instanceTypes, Map<String, String>? labels, LaunchTemplateSpecification? launchTemplate, String? releaseVersion, RemoteAccessConfig? remoteAccess, NodegroupScalingConfig? scalingConfig, Map<String, String>? tags, String? version}) → Future<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.

deleteAddon({required String addonName, required String clusterName}) → Future<DeleteAddonResponse>

Delete an Amazon EKS add-on.

deleteCluster({required String name}) → Future<DeleteClusterResponse>

Deletes the Amazon EKS cluster control plane.

deleteFargateProfile({required String clusterName, required String fargateProfileName}) → Future<DeleteFargateProfileResponse>

Deletes an AWS Fargate profile.

deleteNodegroup({required String clusterName, required String nodegroupName}) → Future<DeleteNodegroupResponse>

Deletes an Amazon EKS node group for a cluster.

describeAddon({required String addonName, required String clusterName}) → Future<DescribeAddonResponse>

Describes an Amazon EKS add-on.

describeAddonVersions({String? addonName, String? kubernetesVersion, int? maxResults, String? nextToken}) → Future<DescribeAddonVersionsResponse>

Describes the Kubernetes versions that the add-on can be used with.

describeCluster({required String name}) → Future<DescribeClusterResponse>

Returns descriptive information about an Amazon EKS cluster.

describeFargateProfile({required String clusterName, required String fargateProfileName}) → Future<DescribeFargateProfileResponse>

Returns descriptive information about an AWS Fargate profile.

describeNodegroup({required String clusterName, required String nodegroupName}) → Future<DescribeNodegroupResponse>

Returns descriptive information about an Amazon EKS node group.

describeUpdate({required String name, required String updateId, String? addonName, String? nodegroupName}) → Future<DescribeUpdateResponse>

Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.

listAddons({required String clusterName, int? maxResults, String? nextToken}) → Future<ListAddonsResponse>

Lists the available add-ons.

listClusters({int? maxResults, String? nextToken}) → Future<ListClustersResponse>

Lists the Amazon EKS clusters in your AWS account in the specified Region.

listFargateProfiles({required String clusterName, int? maxResults, String? nextToken}) → Future<ListFargateProfilesResponse>

Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.

listNodegroups({required String clusterName, int? maxResults, String? nextToken}) → Future<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.

listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>

List the tags for an Amazon EKS resource.

listUpdates({required String name, String? addonName, int? maxResults, String? nextToken, String? nodegroupName}) → Future<ListUpdatesResponse>

Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>

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.

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

Deletes specified tags from a resource.

updateAddon({required String addonName, required String clusterName, String? addonVersion, String? clientRequestToken, ResolveConflicts? resolveConflicts, String? serviceAccountRoleArn}) → Future<UpdateAddonResponse>

Updates an Amazon EKS add-on.

updateClusterConfig({required String name, String? clientRequestToken, Logging? logging, VpcConfigRequest? resourcesVpcConfig}) → Future<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.

updateClusterVersion({required String name, required String version, String? clientRequestToken}) → Future<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.

updateNodegroupConfig({required String clusterName, required String nodegroupName, String? clientRequestToken, UpdateLabelsPayload? labels, NodegroupScalingConfig? scalingConfig}) → Future<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.

updateNodegroupVersion({required String clusterName, required String nodegroupName, String? clientRequestToken, bool? force, LaunchTemplateSpecification? launchTemplate, String? releaseVersion, String? version}) → Future<UpdateNodegroupVersionResponse>

Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

Operators

operator ==(Object other) → bool

The equality operator.

inherited