The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Paws-0.42
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::EKS

NAME

Paws::EKS - Perl Interface to AWS Amazon Elastic Kubernetes Service

SYNOPSIS

  use Paws;

  my $obj = Paws->service('EKS');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01

METHODS

CreateCluster

Name => Str
ResourcesVpcConfig => Paws::EKS::VpcConfigRequest
RoleArn => Str
[ClientRequestToken => Str]
[Logging => Paws::EKS::Logging]
[Tags => Paws::EKS::TagMap]
[Version => Str]

Each argument is described in detail in: Paws::EKS::CreateCluster

Returns: a Paws::EKS::CreateClusterResponse instance

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 (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) 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 (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/).

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 (https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html) and Launching Amazon EKS Worker Nodes (https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html) in the Amazon EKS User Guide.

CreateFargateProfile

ClusterName => Str
FargateProfileName => Str
PodExecutionRoleArn => Str
[ClientRequestToken => Str]
[Selectors => ArrayRef[Paws::EKS::FargateProfileSelector]]
[Subnets => ArrayRef[Str|Undef]]
[Tags => Paws::EKS::TagMap]

Each argument is described in detail in: Paws::EKS::CreateFargateProfile

Returns: a Paws::EKS::CreateFargateProfileResponse instance

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 (https://kubernetes.io/docs/admin/authorization/rbac/) (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 (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) 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 (https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html) in the Amazon EKS User Guide.

CreateNodegroup

ClusterName => Str
NodegroupName => Str
NodeRole => Str
Subnets => ArrayRef[Str|Undef]
[AmiType => Str]
[ClientRequestToken => Str]
[DiskSize => Int]
[InstanceTypes => ArrayRef[Str|Undef]]
[Labels => Paws::EKS::LabelsMap]
[ReleaseVersion => Str]
[RemoteAccess => Paws::EKS::RemoteAccessConfig]
[ScalingConfig => Paws::EKS::NodegroupScalingConfig]
[Tags => Paws::EKS::TagMap]
[Version => Str]

Each argument is described in detail in: Paws::EKS::CreateNodegroup

Returns: a Paws::EKS::CreateNodegroupResponse instance

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.

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 (https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) in the Amazon EKS User Guide.

DeleteCluster

Name => Str

Each argument is described in detail in: Paws::EKS::DeleteCluster

Returns: a Paws::EKS::DeleteClusterResponse instance

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 (https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html) 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 andDeleteFargateProfile.

DeleteFargateProfile

ClusterName => Str
FargateProfileName => Str

Each argument is described in detail in: Paws::EKS::DeleteFargateProfile

Returns: a Paws::EKS::DeleteFargateProfileResponse instance

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.

DeleteNodegroup

ClusterName => Str
NodegroupName => Str

Each argument is described in detail in: Paws::EKS::DeleteNodegroup

Returns: a Paws::EKS::DeleteNodegroupResponse instance

Deletes an Amazon EKS node group for a cluster.

DescribeCluster

Name => Str

Each argument is described in detail in: Paws::EKS::DescribeCluster

Returns: a Paws::EKS::DescribeClusterResponse instance

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 (https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html).

The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.

DescribeFargateProfile

ClusterName => Str
FargateProfileName => Str

Each argument is described in detail in: Paws::EKS::DescribeFargateProfile

Returns: a Paws::EKS::DescribeFargateProfileResponse instance

Returns descriptive information about an AWS Fargate profile.

DescribeNodegroup

ClusterName => Str
NodegroupName => Str

Each argument is described in detail in: Paws::EKS::DescribeNodegroup

Returns: a Paws::EKS::DescribeNodegroupResponse instance

Returns descriptive information about an Amazon EKS node group.

DescribeUpdate

Name => Str
UpdateId => Str
[NodegroupName => Str]

Each argument is described in detail in: Paws::EKS::DescribeUpdate

Returns: a Paws::EKS::DescribeUpdateResponse instance

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.

ListClusters

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::EKS::ListClusters

Returns: a Paws::EKS::ListClustersResponse instance

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

ListFargateProfiles

ClusterName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::EKS::ListFargateProfiles

Returns: a Paws::EKS::ListFargateProfilesResponse instance

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

ListNodegroups

ClusterName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::EKS::ListNodegroups

Returns: a Paws::EKS::ListNodegroupsResponse instance

Lists the Amazon EKS node groups associated with the specified cluster in your AWS account in the specified Region.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::EKS::ListTagsForResource

Returns: a Paws::EKS::ListTagsForResourceResponse instance

List the tags for an Amazon EKS resource.

ListUpdates

Name => Str
[MaxResults => Int]
[NextToken => Str]
[NodegroupName => Str]

Each argument is described in detail in: Paws::EKS::ListUpdates

Returns: a Paws::EKS::ListUpdatesResponse instance

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

TagResource

ResourceArn => Str
Tags => Paws::EKS::TagMap

Each argument is described in detail in: Paws::EKS::TagResource

Returns: a Paws::EKS::TagResourceResponse instance

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.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::EKS::UntagResource

Returns: a Paws::EKS::UntagResourceResponse instance

Deletes specified tags from a resource.

UpdateClusterConfig

Name => Str
[ClientRequestToken => Str]
[Logging => Paws::EKS::Logging]
[ResourcesVpcConfig => Paws::EKS::VpcConfigRequest]

Each argument is described in detail in: Paws::EKS::UpdateClusterConfig

Returns: a Paws::EKS::UpdateClusterConfigResponse instance

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 (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/).

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 (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) 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.

UpdateClusterVersion

Name => Str
Version => Str
[ClientRequestToken => Str]

Each argument is described in detail in: Paws::EKS::UpdateClusterVersion

Returns: a Paws::EKS::UpdateClusterVersionResponse instance

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.

UpdateNodegroupConfig

ClusterName => Str
NodegroupName => Str
[ClientRequestToken => Str]
[Labels => Paws::EKS::UpdateLabelsPayload]
[ScalingConfig => Paws::EKS::NodegroupScalingConfig]

Each argument is described in detail in: Paws::EKS::UpdateNodegroupConfig

Returns: a Paws::EKS::UpdateNodegroupConfigResponse instance

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

ClusterName => Str
NodegroupName => Str
[ClientRequestToken => Str]
[Force => Bool]
[ReleaseVersion => Str]
[Version => Str]

Each argument is described in detail in: Paws::EKS::UpdateNodegroupVersion

Returns: a Paws::EKS::UpdateNodegroupVersionResponse instance

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

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 Linux AMI Versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) 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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllClusters(sub { },[MaxResults => Int, NextToken => Str])

ListAllClusters([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - clusters, passing the object as the first parameter, and the string 'clusters' as the second parameter

If not, it will return a a Paws::EKS::ListClustersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllFargateProfiles(sub { },ClusterName => Str, [MaxResults => Int, NextToken => Str])

ListAllFargateProfiles(ClusterName => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - fargateProfileNames, passing the object as the first parameter, and the string 'fargateProfileNames' as the second parameter

If not, it will return a a Paws::EKS::ListFargateProfilesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllNodegroups(sub { },ClusterName => Str, [MaxResults => Int, NextToken => Str])

ListAllNodegroups(ClusterName => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - nodegroups, passing the object as the first parameter, and the string 'nodegroups' as the second parameter

If not, it will return a a Paws::EKS::ListNodegroupsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllUpdates(sub { },Name => Str, [MaxResults => Int, NextToken => Str, NodegroupName => Str])

ListAllUpdates(Name => Str, [MaxResults => Int, NextToken => Str, NodegroupName => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - updateIds, passing the object as the first parameter, and the string 'updateIds' as the second parameter

If not, it will return a a Paws::EKS::ListUpdatesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues