There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Code examples for Amazon EKS using AWS SDKs
The following code examples show you how to use Amazon Elastic Kubernetes Service with an AWS software development kit (SDK).
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
*Scenarios* are code examples that show you how to accomplish specific tasks by calling multiple functions within a service or combined with other AWS services.
**More resources**
+ **[ Amazon EKS User Guide](https://docs.aws.amazon.com/eks/latest/userguide/what-is-eks.html)** – More information about Amazon EKS.
+ **[Amazon EKS API Reference](https://docs.aws.amazon.com/eks/latest/APIReference/Welcome.html)** – Details about all available Amazon EKS actions.
+ **[AWS Developer Center](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23eks)** – Code examples that you can filter by category or full-text search.
+ **[AWS SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples)** – GitHub repo with complete code in preferred languages. Includes instructions for setting up and running the code.
**Contents**
+ [Basics](eks_code_examples_basics.md)
+ [Actions](eks_code_examples_actions.md)
+ [`CreateCluster`](eks_example_eks_CreateCluster_section.md)
+ [`CreateFargateProfile`](eks_example_eks_CreateFargateProfile_section.md)
+ [`CreateNodegroup`](eks_example_eks_CreateNodegroup_section.md)
+ [`DeleteCluster`](eks_example_eks_DeleteCluster_section.md)
+ [`DeleteFargateProfile`](eks_example_eks_DeleteFargateProfile_section.md)
+ [`DeleteNodegroup`](eks_example_eks_DeleteNodegroup_section.md)
+ [`DescribeCluster`](eks_example_eks_DescribeCluster_section.md)
+ [`DescribeFargateProfile`](eks_example_eks_DescribeFargateProfile_section.md)
+ [`DescribeNodegroup`](eks_example_eks_DescribeNodegroup_section.md)
+ [`DescribeUpdate`](eks_example_eks_DescribeUpdate_section.md)
+ [`ListClusters`](eks_example_eks_ListClusters_section.md)
+ [`ListFargateProfiles`](eks_example_eks_ListFargateProfiles_section.md)
+ [`ListNodegroups`](eks_example_eks_ListNodegroups_section.md)
+ [`ListTagsForResource`](eks_example_eks_ListTagsForResource_section.md)
+ [`ListUpdates`](eks_example_eks_ListUpdates_section.md)
+ [`TagResource`](eks_example_eks_TagResource_section.md)
+ [`UntagResource`](eks_example_eks_UntagResource_section.md)
+ [`UpdateClusterConfig`](eks_example_eks_UpdateClusterConfig_section.md)
+ [`UpdateClusterVersion`](eks_example_eks_UpdateClusterVersion_section.md)
+ [Scenarios](eks_code_examples_scenarios.md)
+ [Getting started with Amazon EKS](eks_example_eks_GettingStarted_034_section.md)
# Basic examples for Amazon EKS using AWS SDKs
The following code examples show how to use the basics of Amazon Elastic Kubernetes Service with AWS SDKs.
**Contents**
+ [Actions](eks_code_examples_actions.md)
+ [`CreateCluster`](eks_example_eks_CreateCluster_section.md)
+ [`CreateFargateProfile`](eks_example_eks_CreateFargateProfile_section.md)
+ [`CreateNodegroup`](eks_example_eks_CreateNodegroup_section.md)
+ [`DeleteCluster`](eks_example_eks_DeleteCluster_section.md)
+ [`DeleteFargateProfile`](eks_example_eks_DeleteFargateProfile_section.md)
+ [`DeleteNodegroup`](eks_example_eks_DeleteNodegroup_section.md)
+ [`DescribeCluster`](eks_example_eks_DescribeCluster_section.md)
+ [`DescribeFargateProfile`](eks_example_eks_DescribeFargateProfile_section.md)
+ [`DescribeNodegroup`](eks_example_eks_DescribeNodegroup_section.md)
+ [`DescribeUpdate`](eks_example_eks_DescribeUpdate_section.md)
+ [`ListClusters`](eks_example_eks_ListClusters_section.md)
+ [`ListFargateProfiles`](eks_example_eks_ListFargateProfiles_section.md)
+ [`ListNodegroups`](eks_example_eks_ListNodegroups_section.md)
+ [`ListTagsForResource`](eks_example_eks_ListTagsForResource_section.md)
+ [`ListUpdates`](eks_example_eks_ListUpdates_section.md)
+ [`TagResource`](eks_example_eks_TagResource_section.md)
+ [`UntagResource`](eks_example_eks_UntagResource_section.md)
+ [`UpdateClusterConfig`](eks_example_eks_UpdateClusterConfig_section.md)
+ [`UpdateClusterVersion`](eks_example_eks_UpdateClusterVersion_section.md)
# Actions for Amazon EKS using AWS SDKs
The following code examples demonstrate how to perform individual Amazon EKS actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
These excerpts call the Amazon EKS API and are code excerpts from larger programs that must be run in context. You can see actions in context in [Scenarios for Amazon EKS using AWS SDKs](eks_code_examples_scenarios.md).
The following examples include only the most commonly used actions. For a complete list, see the [Amazon Elastic Kubernetes Service API Reference](https://docs.aws.amazon.com/eks/latest/APIReference/Welcome.html).
**Topics**
+ [`CreateCluster`](eks_example_eks_CreateCluster_section.md)
+ [`CreateFargateProfile`](eks_example_eks_CreateFargateProfile_section.md)
+ [`CreateNodegroup`](eks_example_eks_CreateNodegroup_section.md)
+ [`DeleteCluster`](eks_example_eks_DeleteCluster_section.md)
+ [`DeleteFargateProfile`](eks_example_eks_DeleteFargateProfile_section.md)
+ [`DeleteNodegroup`](eks_example_eks_DeleteNodegroup_section.md)
+ [`DescribeCluster`](eks_example_eks_DescribeCluster_section.md)
+ [`DescribeFargateProfile`](eks_example_eks_DescribeFargateProfile_section.md)
+ [`DescribeNodegroup`](eks_example_eks_DescribeNodegroup_section.md)
+ [`DescribeUpdate`](eks_example_eks_DescribeUpdate_section.md)
+ [`ListClusters`](eks_example_eks_ListClusters_section.md)
+ [`ListFargateProfiles`](eks_example_eks_ListFargateProfiles_section.md)
+ [`ListNodegroups`](eks_example_eks_ListNodegroups_section.md)
+ [`ListTagsForResource`](eks_example_eks_ListTagsForResource_section.md)
+ [`ListUpdates`](eks_example_eks_ListUpdates_section.md)
+ [`TagResource`](eks_example_eks_TagResource_section.md)
+ [`UntagResource`](eks_example_eks_UntagResource_section.md)
+ [`UpdateClusterConfig`](eks_example_eks_UpdateClusterConfig_section.md)
+ [`UpdateClusterVersion`](eks_example_eks_UpdateClusterVersion_section.md)
# Use `CreateCluster` with an AWS SDK or CLI
The following code examples show how to use `CreateCluster`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon EKS](eks_example_eks_GettingStarted_034_section.md)
------
#### [ CLI ]
**AWS CLI**
**To create a new cluster**
This example command creates a cluster named `prod` in your default region.
Command:
```
aws eks create-cluster --name prod \
--role-arn arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI \
--resources-vpc-config subnetIds=subnet-6782e71e,subnet-e7e761ac,securityGroupIds=sg-6979fe18
```
Output:
```
{
"cluster": {
"name": "prod",
"arn": "arn:aws:eks:us-west-2:012345678910:cluster/prod",
"createdAt": 1527808069.147,
"version": "1.10",
"roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI",
"resourcesVpcConfig": {
"subnetIds": [
"subnet-6782e71e",
"subnet-e7e761ac"
],
"securityGroupIds": [
"sg-6979fe18"
],
"vpcId": "vpc-950809ec"
},
"status": "CREATING",
"certificateAuthority": {}
}
}
```
**To create a new cluster with private endpoint access and logging enabled**
This example command creates a cluster named `example` in your default region with public endpoint access disabled, private endpoint access enabled, and all logging types enabled.
Command:
```
aws eks create-cluster --name example --kubernetes-version 1.12 \
--role-arn arn:aws:iam::012345678910:role/example-cluster-ServiceRole-1XWBQWYSFRE2Q \
--resources-vpc-config subnetIds=subnet-0a188dccd2f9a632f,subnet-09290d93da4278664,subnet-0f21dd86e0e91134a,subnet-0173dead68481a583,subnet-051f70a57ed6fcab6,subnet-01322339c5c7de9b4,securityGroupIds=sg-0c5b580845a031c10,endpointPublicAccess=false,endpointPrivateAccess=true \
--logging '{"clusterLogging":[{"types":["api","audit","authenticator","controllerManager","scheduler"],"enabled":true}]}'
```
Output:
```
{
"cluster": {
"name": "example",
"arn": "arn:aws:eks:us-west-2:012345678910:cluster/example",
"createdAt": 1565804921.901,
"version": "1.12",
"roleArn": "arn:aws:iam::012345678910:role/example-cluster-ServiceRole-1XWBQWYSFRE2Q",
"resourcesVpcConfig": {
"subnetIds": [
"subnet-0a188dccd2f9a632f",
"subnet-09290d93da4278664",
"subnet-0f21dd86e0e91134a",
"subnet-0173dead68481a583",
"subnet-051f70a57ed6fcab6",
"subnet-01322339c5c7de9b4"
],
"securityGroupIds": [
"sg-0c5b580845a031c10"
],
"vpcId": "vpc-0f622c01f68d4afec",
"endpointPublicAccess": false,
"endpointPrivateAccess": true
},
"logging": {
"clusterLogging": [
{
"types": [
"api",
"audit",
"authenticator",
"controllerManager",
"scheduler"
],
"enabled": true
}
]
},
"status": "CREATING",
"certificateAuthority": {},
"platformVersion": "eks.3"
}
}
```
+ For API details, see [CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-cluster.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates a new cluster called 'prod'.**
```
New-EKSCluster -Name prod -ResourcesVpcConfig @{SubnetIds=@("subnet-0a1b2c3d","subnet-3a2b1c0d");SecurityGroupIds="sg-6979fe18"} -RoleArn "arn:aws:iam::012345678901:role/eks-service-role"
```
**Output:**
```
Arn : arn:aws:eks:us-west-2:012345678901:cluster/prod
CertificateAuthority : Amazon.EKS.Model.Certificate
ClientRequestToken :
CreatedAt : 12/10/2018 9:25:31 PM
Endpoint :
Name : prod
PlatformVersion : eks.3
ResourcesVpcConfig : Amazon.EKS.Model.VpcConfigResponse
RoleArn : arn:aws:iam::012345678901:role/eks-service-role
Status : CREATING
Version : 1.10
```
+ For API details, see [CreateCluster](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates a new cluster called 'prod'.**
```
New-EKSCluster -Name prod -ResourcesVpcConfig @{SubnetIds=@("subnet-0a1b2c3d","subnet-3a2b1c0d");SecurityGroupIds="sg-6979fe18"} -RoleArn "arn:aws:iam::012345678901:role/eks-service-role"
```
**Output:**
```
Arn : arn:aws:eks:us-west-2:012345678901:cluster/prod
CertificateAuthority : Amazon.EKS.Model.Certificate
ClientRequestToken :
CreatedAt : 12/10/2018 9:25:31 PM
Endpoint :
Name : prod
PlatformVersion : eks.3
ResourcesVpcConfig : Amazon.EKS.Model.VpcConfigResponse
RoleArn : arn:aws:iam::012345678901:role/eks-service-role
Status : CREATING
Version : 1.10
```
+ For API details, see [CreateCluster](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/eks#code-examples).
```
async fn make_cluster(
client: &aws_sdk_eks::Client,
name: &str,
arn: &str,
subnet_ids: Vec,
) -> Result<(), aws_sdk_eks::Error> {
let cluster = client
.create_cluster()
.name(name)
.role_arn(arn)
.resources_vpc_config(
VpcConfigRequest::builder()
.set_subnet_ids(Some(subnet_ids))
.build(),
)
.send()
.await?;
println!("cluster created: {:?}", cluster);
Ok(())
}
```
+ For API details, see [CreateCluster](https://docs.rs/aws-sdk-eks/latest/aws_sdk_eks/client/struct.Client.html#method.create_cluster) in *AWS SDK for Rust API reference*.
------
# Use `CreateFargateProfile` with a CLI
The following code examples show how to use `CreateFargateProfile`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: Create EKS Fargate Profile for a selector with a namespace**
The following `create-fargate-profile` example creates an EKS Fargate Profile for a selector with a namespace.
```
aws eks create-fargate-profile \
--cluster-name my-eks-cluster \
--pod-execution-role-arn arn:aws:iam::111122223333:role/role-name \
--fargate-profile-name my-fargate-profile \
--selectors '[{"namespace": "default"}]'
```
Output:
```
{
"fargateProfile": {
"fargateProfileName": "my-fargate-profile",
"fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/a2c72bca-318e-abe8-8ed1-27c6d4892e9e",
"clusterName": "my-eks-cluster",
"createdAt": "2024-03-19T12:38:47.368000-04:00",
"podExecutionRoleArn": "arn:aws:iam::111122223333:role/role-name",
"subnets": [
"subnet-09d912bb63ef21b9a",
"subnet-04ad87f71c6e5ab4d",
"subnet-0e2907431c9988b72"
],
"selectors": [
{
"namespace": "default"
}
],
"status": "CREATING",
"tags": {}
}
}
```
For more information, see [AWS Fargate profile - Creating a Fargate profile](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile) in the *Amazon EKS User Guide*.
**Example 2: Create EKS Fargate Profile for a selector with a namespace and labels**
The following `create-fargate-profile` example creates an EKS Fargate Profile for a selector with a namespace and labels.
```
aws eks create-fargate-profile \
--cluster-name my-eks-cluster \
--pod-execution-role-arn arn:aws:iam::111122223333:role/role-name \
--fargate-profile-name my-fargate-profile \
--selectors '[{"namespace": "default", "labels": {"labelname1": "labelvalue1"}}]'
```
Output:
```
{
"fargateProfile": {
"fargateProfileName": "my-fargate-profile",
"fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/88c72bc7-e8a4-fa34-44e4-2f1397224bb3",
"clusterName": "my-eks-cluster",
"createdAt": "2024-03-19T12:33:48.125000-04:00",
"podExecutionRoleArn": "arn:aws:iam::111122223333:role/role-name",
"subnets": [
"subnet-09d912bb63ef21b9a",
"subnet-04ad87f71c6e5ab4d",
"subnet-0e2907431c9988b72"
],
"selectors": [
{
"namespace": "default",
"labels": {
"labelname1": "labelvalue1"
}
}
],
"status": "CREATING",
"tags": {}
}
}
```
For more information, see [AWS Fargate profile - Creating a Fargate profile](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile) in the *Amazon EKS User Guide*.
**Example 3: Create EKS Fargate Profile for a selector with a namespace and labels, along with IDs of subnets to launch a Pod into.**
The following `create-fargate-profile` example create EKS Fargate Profile for a selector with a namespace and labels, along with IDs of subnets to launch a Pod into.
```
aws eks create-fargate-profile \
--cluster-name my-eks-cluster \
--pod-execution-role-arn arn:aws:iam::111122223333:role/role-name \
--fargate-profile-name my-fargate-profile \
--selectors '[{"namespace": "default", "labels": {"labelname1": "labelvalue1"}}]' \
--subnets '["subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72"]'
```
Output:
```
{
"fargateProfile": {
"fargateProfileName": "my-fargate-profile",
"fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/e8c72bc8-e87b-5eb6-57cb-ed4fe57577e3",
"clusterName": "my-eks-cluster",
"createdAt": "2024-03-19T12:35:58.640000-04:00",
"podExecutionRoleArn": "arn:aws:iam::111122223333:role/role-name",
"subnets": [
"subnet-09d912bb63ef21b9a",
"subnet-04ad87f71c6e5ab4d",
"subnet-0e2907431c9988b72"
],
"selectors": [
{
"namespace": "default",
"labels": {
"labelname1": "labelvalue1"
}
}
],
"status": "CREATING",
"tags": {}
}
}
```
For more information, see [AWS Fargate profile - Creating a Fargate profile](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile) in the *Amazon EKS User Guide*.
**Example 4: Create EKS Fargate Profile for a selector with multiple namespace and labels, along with IDs of subnets to launch a Pod into**
The following `create-fargate-profile` example creates an EKS Fargate Profile for a selector with multiple namespace and labels, along with IDs of subnets to launch a Pod into.
```
aws eks create-fargate-profile \
--cluster-name my-eks-cluster \
--pod-execution-role-arn arn:aws:iam::111122223333:role/role-name \
--fargate-profile-name my-fargate-profile \
--selectors '[{"namespace": "default1", "labels": {"labelname1": "labelvalue1", "labelname2": "labelvalue2"}}, {"namespace": "default2", "labels": {"labelname1": "labelvalue1", "labelname2": "labelvalue2"}}]' \
--subnets '["subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72"]' \
--tags '{"eks-fargate-profile-key-1": "value-1" , "eks-fargate-profile-key-2": "value-2"}'
```
Output:
```
{
"fargateProfile": {
"fargateProfileName": "my-fargate-profile",
"fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/4cc72bbf-b766-8ee6-8d29-e62748feb3cd",
"clusterName": "my-eks-cluster",
"createdAt": "2024-03-19T12:15:55.271000-04:00",
"podExecutionRoleArn": "arn:aws:iam::111122223333:role/role-name",
"subnets": [
"subnet-09d912bb63ef21b9a",
"subnet-04ad87f71c6e5ab4d",
"subnet-0e2907431c9988b72"
],
"selectors": [
{
"namespace": "default1",
"labels": {
"labelname2": "labelvalue2",
"labelname1": "labelvalue1"
}
},
{
"namespace": "default2",
"labels": {
"labelname2": "labelvalue2",
"labelname1": "labelvalue1"
}
}
],
"status": "CREATING",
"tags": {
"eks-fargate-profile-key-2": "value-2",
"eks-fargate-profile-key-1": "value-1"
}
}
}
```
For more information, see [AWS Fargate profile - Creating a Fargate profile](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile) in the *Amazon EKS User Guide*.
**Example 5: Create EKS Fargate Profile with a wildcard selector for namespaces and labels, along with IDs of subnets to launch a Pod into**
The following `create-fargate-profile` example creates an EKS Fargate Profile for a selector with multiple namespace and labels, along with IDs of subnets to launch a Pod into.
```
aws eks create-fargate-profile \
--cluster-name my-eks-cluster \
--pod-execution-role-arn arn:aws:iam::111122223333:role/role-name \
--fargate-profile-name my-fargate-profile \
--selectors '[{"namespace": "prod*", "labels": {"labelname*?": "*value1"}}, {"namespace": "*dev*", "labels": {"labelname*?": "*value*"}}]' \
--subnets '["subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72"]' \
--tags '{"eks-fargate-profile-key-1": "value-1" , "eks-fargate-profile-key-2": "value-2"}'
```
Output:
```
{
"fargateProfile": {
"fargateProfileName": "my-fargate-profile",
"fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/e8c72bd6-5966-0bfe-b77b-1802893e5a6f",
"clusterName": "my-eks-cluster",
"createdAt": "2024-03-19T13:05:20.550000-04:00",
"podExecutionRoleArn": "arn:aws:iam::111122223333:role/role-name",
"subnets": [
"subnet-09d912bb63ef21b9a",
"subnet-04ad87f71c6e5ab4d",
"subnet-0e2907431c9988b72"
],
"selectors": [
{
"namespace": "prod*",
"labels": {
"labelname*?": "*value1"
}
},
{
"namespace": "*dev*",
"labels": {
"labelname*?": "*value*"
}
}
],
"status": "CREATING",
"tags": {
"eks-fargate-profile-key-2": "value-2",
"eks-fargate-profile-key-1": "value-1"
}
}
}
```
For more information, see [AWS Fargate profile - Creating a Fargate profile](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile) in the *Amazon EKS User Guide*.
+ For API details, see [CreateFargateProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-fargate-profile.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet 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 schedule pods on Fargate infrastructure. **
```
New-EKSFargateProfile -FargateProfileName EKSFargateProfile -ClusterName TEST -Subnet "subnet-02f6ff500ff2067a0", "subnet-0cd976f08d5fbfaae" -PodExecutionRoleArn arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole -Selector @{Namespace="default"}
```
**Output:**
```
ClusterName : TEST
CreatedAt : 12/26/2019 12:38:21 PM
FargateProfileArn : arn:aws:eks:us-east-2:012345678912:fargateprofile/TEST/EKSFargateProfile/20b7a11b-8292-41c1-bc56-ffa5e60f6224
FargateProfileName : EKSFargateProfile
PodExecutionRoleArn : arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole
Selectors : {Amazon.EKS.Model.FargateProfileSelector}
Status : CREATING
Subnets : {subnet-0cd976f08d5fbfaae, subnet-02f6ff500ff2067a0}
Tags : {}
```
+ For API details, see [CreateFargateProfile](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet 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 schedule pods on Fargate infrastructure. **
```
New-EKSFargateProfile -FargateProfileName EKSFargateProfile -ClusterName TEST -Subnet "subnet-02f6ff500ff2067a0", "subnet-0cd976f08d5fbfaae" -PodExecutionRoleArn arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole -Selector @{Namespace="default"}
```
**Output:**
```
ClusterName : TEST
CreatedAt : 12/26/2019 12:38:21 PM
FargateProfileArn : arn:aws:eks:us-east-2:012345678912:fargateprofile/TEST/EKSFargateProfile/20b7a11b-8292-41c1-bc56-ffa5e60f6224
FargateProfileName : EKSFargateProfile
PodExecutionRoleArn : arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole
Selectors : {Amazon.EKS.Model.FargateProfileSelector}
Status : CREATING
Subnets : {subnet-0cd976f08d5fbfaae, subnet-02f6ff500ff2067a0}
Tags : {}
```
+ For API details, see [CreateFargateProfile](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `CreateNodegroup` with a CLI
The following code examples show how to use `CreateNodegroup`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon EKS](eks_example_eks_GettingStarted_034_section.md)
------
#### [ CLI ]
**AWS CLI**
**Example 1: Creates a managed node group for an Amazon EKS cluster**
The following `create-nodegroup` example creates a managed node group for an Amazon EKS cluster.
```
aws eks create-nodegroup \
--cluster-name my-eks-cluster \
--nodegroup-name my-eks-nodegroup \
--node-role arn:aws:iam::111122223333:role/role-name \
--subnets "subnet-0e2907431c9988b72" "subnet-04ad87f71c6e5ab4d" "subnet-09d912bb63ef21b9a" \
--scaling-config minSize=1,maxSize=3,desiredSize=1 \
--region us-east-2
```
Output:
```
{
"nodegroup": {
"nodegroupName": "my-eks-nodegroup",
"nodegroupArn": "arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-nodegroup/bac7550f-b8b8-5fbb-4f3e-7502a931119e",
"clusterName": "my-eks-cluster",
"version": "1.26",
"releaseVersion": "1.26.12-20240329",
"createdAt": "2024-04-04T13:19:32.260000-04:00",
"modifiedAt": "2024-04-04T13:19:32.260000-04:00",
"status": "CREATING",
"capacityType": "ON_DEMAND",
"scalingConfig": {
"minSize": 1,
"maxSize": 3,
"desiredSize": 1
},
"instanceTypes": [
"t3.medium"
],
"subnets": [
"subnet-0e2907431c9988b72, subnet-04ad87f71c6e5ab4d, subnet-09d912bb63ef21b9a"
],
"amiType": "AL2_x86_64",
"nodeRole": "arn:aws:iam::111122223333:role/role-name",
"diskSize": 20,
"health": {
"issues": []
},
"updateConfig": {
"maxUnavailable": 1
},
"tags": {}
}
}
```
For more information, see [Creating a managed node group](https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html) in the *Amazon EKS User Guide*.
**Example 2: Creates a managed node group for an Amazon EKS cluster with custom instance-types and disk-size**
The following `create-nodegroup` example creates a managed node group for an Amazon EKS cluster with custom instance-types and disk-size.
```
aws eks create-nodegroup \
--cluster-name my-eks-cluster \
--nodegroup-name my-eks-nodegroup \
--node-role arn:aws:iam::111122223333:role/role-name \
--subnets "subnet-0e2907431c9988b72" "subnet-04ad87f71c6e5ab4d" "subnet-09d912bb63ef21b9a" \
--scaling-config minSize=1,maxSize=3,desiredSize=1 \
--capacity-type ON_DEMAND \
--instance-types 'm5.large' \
--disk-size 50 \
--region us-east-2
```
Output:
```
{
"nodegroup": {
"nodegroupName": "my-eks-nodegroup",
"nodegroupArn": "arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-nodegroup/c0c7551b-e4f9-73d9-992c-a450fdb82322",
"clusterName": "my-eks-cluster",
"version": "1.26",
"releaseVersion": "1.26.12-20240329",
"createdAt": "2024-04-04T13:46:07.595000-04:00",
"modifiedAt": "2024-04-04T13:46:07.595000-04:00",
"status": "CREATING",
"capacityType": "ON_DEMAND",
"scalingConfig": {
"minSize": 1,
"maxSize": 3,
"desiredSize": 1
},
"instanceTypes": [
"m5.large"
],
"subnets": [
"subnet-0e2907431c9988b72",
"subnet-04ad87f71c6e5ab4d",
"subnet-09d912bb63ef21b9a"
],
"amiType": "AL2_x86_64",
"nodeRole": "arn:aws:iam::111122223333:role/role-name",
"diskSize": 50,
"health": {
"issues": []
},
"updateConfig": {
"maxUnavailable": 1
},
"tags": {}
}
}
```
For more information, see [Creating a managed node group](https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html) in the *Amazon EKS User Guide*.
**Example 3: Creates a managed node group for an Amazon EKS cluster with custom instance-types, disk-size, ami-type, capacity-type, update-config, labels, taints and tags.**
The following `create-nodegroup` example creates a managed node group for an Amazon EKS cluster with custom instance-types, disk-size, ami-type, capacity-type, update-config, labels, taints and tags.
```
aws eks create-nodegroup \
--cluster-name my-eks-cluster \
--nodegroup-name my-eks-nodegroup \
--node-role arn:aws:iam::111122223333:role/role-name \
--subnets "subnet-0e2907431c9988b72" "subnet-04ad87f71c6e5ab4d" "subnet-09d912bb63ef21b9a" \
--scaling-config minSize=1,maxSize=5,desiredSize=4 \
--instance-types 't3.large' \
--disk-size 50 \
--ami-type AL2_x86_64 \
--capacity-type SPOT \
--update-config maxUnavailable=2 \
--labels '{"my-eks-nodegroup-label-1": "value-1" , "my-eks-nodegroup-label-2": "value-2"}' \
--taints '{"key": "taint-key-1" , "value": "taint-value-1", "effect": "NO_EXECUTE"}' \
--tags '{"my-eks-nodegroup-key-1": "value-1" , "my-eks-nodegroup-key-2": "value-2"}'
```
Output:
```
{
"nodegroup": {
"nodegroupName": "my-eks-nodegroup",
"nodegroupArn": "arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-nodegroup/88c75524-97af-0cb9-a9c5-7c0423ab5314",
"clusterName": "my-eks-cluster",
"version": "1.26",
"releaseVersion": "1.26.12-20240329",
"createdAt": "2024-04-04T14:05:07.940000-04:00",
"modifiedAt": "2024-04-04T14:05:07.940000-04:00",
"status": "CREATING",
"capacityType": "SPOT",
"scalingConfig": {
"minSize": 1,
"maxSize": 5,
"desiredSize": 4
},
"instanceTypes": [
"t3.large"
],
"subnets": [
"subnet-0e2907431c9988b72",
"subnet-04ad87f71c6e5ab4d",
"subnet-09d912bb63ef21b9a"
],
"amiType": "AL2_x86_64",
"nodeRole": "arn:aws:iam::111122223333:role/role-name",
"labels": {
"my-eks-nodegroup-label-2": "value-2",
"my-eks-nodegroup-label-1": "value-1"
},
"taints": [
{
"key": "taint-key-1",
"value": "taint-value-1",
"effect": "NO_EXECUTE"
}
],
"diskSize": 50,
"health": {
"issues": []
},
"updateConfig": {
"maxUnavailable": 2
},
"tags": {
"my-eks-nodegroup-key-1": "value-1",
"my-eks-nodegroup-key-2": "value-2"
}
}
}
```
For more information, see [Creating a managed node group](https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html) in the *Amazon EKS User Guide*.
+ For API details, see [CreateNodegroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-nodegroup.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet 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. **
```
New-EKSNodeGroup -NodeGroupName "ProdEKSNodeGroup" -AmiType "AL2_x86_64" -DiskSize 40 -ClusterName "PROD" -ScalingConfig_DesiredSize 2 -ScalingConfig_MinSize 2 -ScalingConfig_MaxSize 5 -InstanceType t3.large -NodeRole "arn:aws:iam::012345678912:role/NodeInstanceRole" -Subnet "subnet-0d1a9fff35efa7691","subnet-0a3f4928edbc224d4"
```
**Output:**
```
AmiType : AL2_x86_64
ClusterName : PROD
CreatedAt : 12/25/2019 10:16:45 AM
DiskSize : 40
Health : Amazon.EKS.Model.NodegroupHealth
InstanceTypes : {t3.large}
Labels : {}
ModifiedAt : 12/25/2019 10:16:45 AM
NodegroupArn : arn:aws:eks:us-west-2:012345678912:nodegroup/PROD/ProdEKSNodeGroup/7eb79e47-82b6-04d9-e984-95110db6fa85
NodegroupName : ProdEKSNodeGroup
NodeRole : arn:aws:iam::012345678912:role/NodeInstanceRole
ReleaseVersion : 1.14.7-20190927
RemoteAccess :
Resources :
ScalingConfig : Amazon.EKS.Model.NodegroupScalingConfig
Status : CREATING
Subnets : {subnet-0d1a9fff35efa7691, subnet-0a3f4928edbc224d4}
Tags : {}
Version : 1.14
```
+ For API details, see [CreateNodegroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet 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. **
```
New-EKSNodeGroup -NodeGroupName "ProdEKSNodeGroup" -AmiType "AL2_x86_64" -DiskSize 40 -ClusterName "PROD" -ScalingConfig_DesiredSize 2 -ScalingConfig_MinSize 2 -ScalingConfig_MaxSize 5 -InstanceType t3.large -NodeRole "arn:aws:iam::012345678912:role/NodeInstanceRole" -Subnet "subnet-0d1a9fff35efa7691","subnet-0a3f4928edbc224d4"
```
**Output:**
```
AmiType : AL2_x86_64
ClusterName : PROD
CreatedAt : 12/25/2019 10:16:45 AM
DiskSize : 40
Health : Amazon.EKS.Model.NodegroupHealth
InstanceTypes : {t3.large}
Labels : {}
ModifiedAt : 12/25/2019 10:16:45 AM
NodegroupArn : arn:aws:eks:us-west-2:012345678912:nodegroup/PROD/ProdEKSNodeGroup/7eb79e47-82b6-04d9-e984-95110db6fa85
NodegroupName : ProdEKSNodeGroup
NodeRole : arn:aws:iam::012345678912:role/NodeInstanceRole
ReleaseVersion : 1.14.7-20190927
RemoteAccess :
Resources :
ScalingConfig : Amazon.EKS.Model.NodegroupScalingConfig
Status : CREATING
Subnets : {subnet-0d1a9fff35efa7691, subnet-0a3f4928edbc224d4}
Tags : {}
Version : 1.14
```
+ For API details, see [CreateNodegroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeleteCluster` with an AWS SDK or CLI
The following code examples show how to use `DeleteCluster`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon EKS](eks_example_eks_GettingStarted_034_section.md)
------
#### [ CLI ]
**AWS CLI**
**Delete an Amazon EKS cluster control plane**
The following `delete-cluster` example deletes an Amazon EKS cluster control plane.
```
aws eks delete-cluster \
--name my-eks-cluster
```
Output:
```
{
"cluster": {
"name": "my-eks-cluster",
"arn": "arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster",
"createdAt": "2024-03-14T11:31:44.348000-04:00",
"version": "1.27",
"endpoint": "https://DALSJ343KE23J3RN45653DSKJTT647TYD.yl4.us-east-2.eks.amazonaws.com",
"roleArn": "arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-cluster-ServiceRole-zMF6CBakwwbW",
"resourcesVpcConfig": {
"subnetIds": [
"subnet-0fb75d2d8401716e7",
"subnet-02184492f67a3d0f9",
"subnet-04098063527aab776",
"subnet-0e2907431c9988b72",
"subnet-04ad87f71c6e5ab4d",
"subnet-09d912bb63ef21b9a"
],
"securityGroupIds": [
"sg-0c1327f6270afbb36"
],
"clusterSecurityGroupId": "sg-01c84d09d70f39a7f",
"vpcId": "vpc-0012b8e1cc0abb17d",
"endpointPublicAccess": true,
"endpointPrivateAccess": true,
"publicAccessCidrs": [
"0.0.0.0/0"
]
},
"kubernetesNetworkConfig": {
"serviceIpv4Cidr": "10.100.0.0/16",
"ipFamily": "ipv4"
},
"logging": {
"clusterLogging": [
{
"types": [
"api",
"audit",
"authenticator",
"controllerManager",
"scheduler"
],
"enabled": true
}
]
},
"identity": {
"oidc": {
"issuer": "https://oidc.eks.us-east-2.amazonaws.com/id/DALSJ343KE23J3RN45653DSKJTT647TYD"
}
},
"status": "DELETING",
"certificateAuthority": {
"data": "XXX_CA_DATA_XXX"
},
"platformVersion": "eks.16",
"tags": {
"aws:cloudformation:stack-name": "eksctl-my-eks-cluster-cluster",
"alpha.eksctl.io/cluster-name": "my-eks-cluster",
"karpenter.sh/discovery": "my-eks-cluster",
"aws:cloudformation:stack-id": "arn:aws:cloudformation:us-east-2:111122223333:stack/eksctl-my-eks-cluster-cluster/e752ea00-e217-11ee-beae-0a9599c8c7ed",
"auto-delete": "no",
"eksctl.cluster.k8s.io/v1alpha1/cluster-name": "my-eks-cluster",
"EKS-Cluster-Name": "my-eks-cluster",
"alpha.eksctl.io/cluster-oidc-enabled": "true",
"aws:cloudformation:logical-id": "ControlPlane",
"alpha.eksctl.io/eksctl-version": "0.173.0-dev+a7ee89342.2024-03-01T03:40:57Z",
"Name": "eksctl-my-eks-cluster-cluster/ControlPlane"
},
"accessConfig": {
"authenticationMode": "API_AND_CONFIG_MAP"
}
}
}
```
For more information, see [Deleting an Amazon EKS cluster](https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html) in the *Amazon EKS User Guide*.
+ For API details, see [DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-cluster.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet deletes the Amazon EKS cluster control plane.**
```
Remove-EKSCluster -Name "DEV-KUBE-CL"
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSCluster (DeleteCluster)" on target "DEV-KUBE-CL".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Arn : arn:aws:eks:us-west-2:012345678912:cluster/DEV-KUBE-CL
CertificateAuthority : Amazon.EKS.Model.Certificate
ClientRequestToken :
CreatedAt : 12/25/2019 9:33:25 AM
Endpoint : https://02E6D31E3E4F8C15D7BE7F58D527776A.yl4.us-west-2.eks.amazonaws.com
Identity : Amazon.EKS.Model.Identity
Logging : Amazon.EKS.Model.Logging
Name : DEV-KUBE-CL
PlatformVersion : eks.7
ResourcesVpcConfig : Amazon.EKS.Model.VpcConfigResponse
RoleArn : arn:aws:iam::012345678912:role/eks-iam-role
Status : DELETING
Tags : {}
Version : 1.14
```
+ For API details, see [DeleteCluster](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet deletes the Amazon EKS cluster control plane.**
```
Remove-EKSCluster -Name "DEV-KUBE-CL"
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSCluster (DeleteCluster)" on target "DEV-KUBE-CL".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Arn : arn:aws:eks:us-west-2:012345678912:cluster/DEV-KUBE-CL
CertificateAuthority : Amazon.EKS.Model.Certificate
ClientRequestToken :
CreatedAt : 12/25/2019 9:33:25 AM
Endpoint : https://02E6D31E3E4F8C15D7BE7F58D527776A.yl4.us-west-2.eks.amazonaws.com
Identity : Amazon.EKS.Model.Identity
Logging : Amazon.EKS.Model.Logging
Name : DEV-KUBE-CL
PlatformVersion : eks.7
ResourcesVpcConfig : Amazon.EKS.Model.VpcConfigResponse
RoleArn : arn:aws:iam::012345678912:role/eks-iam-role
Status : DELETING
Tags : {}
Version : 1.14
```
+ For API details, see [DeleteCluster](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/eks#code-examples).
```
async fn remove_cluster(
client: &aws_sdk_eks::Client,
name: &str,
) -> Result<(), aws_sdk_eks::Error> {
let cluster_deleted = client.delete_cluster().name(name).send().await?;
println!("cluster deleted: {:?}", cluster_deleted);
Ok(())
}
```
+ For API details, see [DeleteCluster](https://docs.rs/aws-sdk-eks/latest/aws_sdk_eks/client/struct.Client.html#method.delete_cluster) in *AWS SDK for Rust API reference*.
------
# Use `DeleteFargateProfile` with a CLI
The following code examples show how to use `DeleteFargateProfile`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: Create EKS Fargate Profile for a selector with a namespace**
The following `delete-fargate-profile` example creates an EKS Fargate Profile for a selector with a namespace.
```
aws eks delete-fargate-profile \
--cluster-name my-eks-cluster \
--fargate-profile-name my-fargate-profile
```
Output:
```
{
"fargateProfile": {
"fargateProfileName": "my-fargate-profile",
"fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/1ac72bb3-3fc6-2631-f1e1-98bff53bed62",
"clusterName": "my-eks-cluster",
"createdAt": "2024-03-19T11:48:39.975000-04:00",
"podExecutionRoleArn": "arn:aws:iam::111122223333:role/role-name",
"subnets": [
"subnet-09d912bb63ef21b9a",
"subnet-04ad87f71c6e5ab4d",
"subnet-0e2907431c9988b72"
],
"selectors": [
{
"namespace": "default",
"labels": {
"foo": "bar"
}
}
],
"status": "DELETING",
"tags": {}
}
}
```
For more information, see [AWS Fargate profile - Deleting a Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#delete-fargate-profile) in the *Amazon EKS User Guide*.
+ For API details, see [DeleteFargateProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-fargate-profile.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet deletes an AWS Fargate profile. When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. **
```
Remove-EKSFargateProfile -FargateProfileName "EKSFargate" -ClusterName "TEST"
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSFargateProfile (DeleteFargateProfile)" on target "EKSFargate".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
ClusterName : TEST
CreatedAt : 12/26/2019 12:34:47 PM
FargateProfileArn : arn:aws:eks:us-east-2:012345678912:fargateprofile/TEST/EKSFargate/42b7a119-e16b-a279-ce97-bdf303adec92
FargateProfileName : EKSFargate
PodExecutionRoleArn : arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole
Selectors : {Amazon.EKS.Model.FargateProfileSelector}
Status : DELETING
Subnets : {subnet-0cd976f08d5fbfaae, subnet-02f6ff500ff2067a0}
Tags : {}
```
+ For API details, see [DeleteFargateProfile](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet deletes an AWS Fargate profile. When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. **
```
Remove-EKSFargateProfile -FargateProfileName "EKSFargate" -ClusterName "TEST"
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSFargateProfile (DeleteFargateProfile)" on target "EKSFargate".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
ClusterName : TEST
CreatedAt : 12/26/2019 12:34:47 PM
FargateProfileArn : arn:aws:eks:us-east-2:012345678912:fargateprofile/TEST/EKSFargate/42b7a119-e16b-a279-ce97-bdf303adec92
FargateProfileName : EKSFargate
PodExecutionRoleArn : arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole
Selectors : {Amazon.EKS.Model.FargateProfileSelector}
Status : DELETING
Subnets : {subnet-0cd976f08d5fbfaae, subnet-02f6ff500ff2067a0}
Tags : {}
```
+ For API details, see [DeleteFargateProfile](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeleteNodegroup` with a CLI
The following code examples show how to use `DeleteNodegroup`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon EKS](eks_example_eks_GettingStarted_034_section.md)
------
#### [ CLI ]
**AWS CLI**
**Example 1: Delete a managed node group for an Amazon EKS cluster**
The following `delete-nodegroup` example deletes a managed node group for an Amazon EKS cluster.
```
aws eks delete-nodegroup \
--cluster-name my-eks-cluster \
--nodegroup-name my-eks-nodegroup
```
Output:
```
{
"nodegroup": {
"nodegroupName": "my-eks-nodegroup",
"nodegroupArn": "arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-nodegroup/1ec75f5f-0e21-dcc0-b46e-f9c442685cd8",
"clusterName": "my-eks-cluster",
"version": "1.26",
"releaseVersion": "1.26.12-20240329",
"createdAt": "2024-04-08T13:25:15.033000-04:00",
"modifiedAt": "2024-04-08T13:25:31.252000-04:00",
"status": "DELETING",
"capacityType": "SPOT",
"scalingConfig": {
"minSize": 1,
"maxSize": 5,
"desiredSize": 4
},
"instanceTypes": [
"t3.large"
],
"subnets": [
"subnet-0e2907431c9988b72",
"subnet-04ad87f71c6e5ab4d",
"subnet-09d912bb63ef21b9a"
],
"amiType": "AL2_x86_64",
"nodeRole": "arn:aws:iam::111122223333:role/role-name",
"labels": {
"my-eks-nodegroup-label-2": "value-2",
"my-eks-nodegroup-label-1": "value-1"
},
"taints": [
{
"key": "taint-key-1",
"value": "taint-value-1",
"effect": "NO_EXECUTE"
}
],
"diskSize": 50,
"health": {
"issues": []
},
"updateConfig": {
"maxUnavailable": 2
},
"tags": {
"my-eks-nodegroup-key-1": "value-1",
"my-eks-nodegroup-key-2": "value-2"
}
}
}
```
+ For API details, see [DeleteNodegroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-nodegroup.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet deletes an Amazon EKS node group for a cluster.**
```
Remove-EKSNodegroup -NodegroupName "ProdEKSNodeGroup" -ClusterName "PROD"
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSNodegroup (DeleteNodegroup)" on target "ProdEKSNodeGroup".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
AmiType : AL2_x86_64
ClusterName : PROD
CreatedAt : 12/25/2019 10:16:45 AM
DiskSize : 40
Health : Amazon.EKS.Model.NodegroupHealth
InstanceTypes : {t3.large}
Labels : {}
ModifiedAt : 12/25/2019 11:01:16 AM
NodegroupArn : arn:aws:eks:us-west-2:012345678912:nodegroup/PROD/ProdEKSNodeGroup/7eb79e47-82b6-04d9-e984-95110db6fa85
NodegroupName : ProdEKSNodeGroup
NodeRole : arn:aws:iam::012345678912:role/NodeInstanceRole
ReleaseVersion : 1.14.7-20190927
RemoteAccess :
Resources : Amazon.EKS.Model.NodegroupResources
ScalingConfig : Amazon.EKS.Model.NodegroupScalingConfig
Status : DELETING
Subnets : {subnet-0d1a9fff35efa7691, subnet-0a3f4928edbc224d4}
Tags : {}
Version : 1.14
```
+ For API details, see [DeleteNodegroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet deletes an Amazon EKS node group for a cluster.**
```
Remove-EKSNodegroup -NodegroupName "ProdEKSNodeGroup" -ClusterName "PROD"
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSNodegroup (DeleteNodegroup)" on target "ProdEKSNodeGroup".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
AmiType : AL2_x86_64
ClusterName : PROD
CreatedAt : 12/25/2019 10:16:45 AM
DiskSize : 40
Health : Amazon.EKS.Model.NodegroupHealth
InstanceTypes : {t3.large}
Labels : {}
ModifiedAt : 12/25/2019 11:01:16 AM
NodegroupArn : arn:aws:eks:us-west-2:012345678912:nodegroup/PROD/ProdEKSNodeGroup/7eb79e47-82b6-04d9-e984-95110db6fa85
NodegroupName : ProdEKSNodeGroup
NodeRole : arn:aws:iam::012345678912:role/NodeInstanceRole
ReleaseVersion : 1.14.7-20190927
RemoteAccess :
Resources : Amazon.EKS.Model.NodegroupResources
ScalingConfig : Amazon.EKS.Model.NodegroupScalingConfig
Status : DELETING
Subnets : {subnet-0d1a9fff35efa7691, subnet-0a3f4928edbc224d4}
Tags : {}
Version : 1.14
```
+ For API details, see [DeleteNodegroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeCluster` with a CLI
The following code examples show how to use `DescribeCluster`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon EKS](eks_example_eks_GettingStarted_034_section.md)
------
#### [ CLI ]
**AWS CLI**
**Describe actively running EKS addon in your Amazon EKS cluster**
The following `describe-cluster` example actively running EKS addon in your Amazon EKS cluster.
```
aws eks describe-cluster \
--name my-eks-cluster
```
Output:
```
{
"cluster": {
"name": "my-eks-cluster",
"arn": "arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster",
"createdAt": "2024-03-14T11:31:44.348000-04:00",
"version": "1.26",
"endpoint": "https://JSA79429HJDASKJDJ8223829MNDNASW.yl4.us-east-2.eks.amazonaws.com",
"roleArn": "arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-cluster-ServiceRole-zMF6CBakwwbW",
"resourcesVpcConfig": {
"subnetIds": [
"subnet-0fb75d2d8401716e7",
"subnet-02184492f67a3d0f9",
"subnet-04098063527aab776",
"subnet-0e2907431c9988b72",
"subnet-04ad87f71c6e5ab4d",
"subnet-09d912bb63ef21b9a"
],
"securityGroupIds": [
"sg-0c1327f6270afbb36"
],
"clusterSecurityGroupId": "sg-01c84d09d70f39a7f",
"vpcId": "vpc-0012b8e1cc0abb17d",
"endpointPublicAccess": true,
"endpointPrivateAccess": true,
"publicAccessCidrs": [
"22.19.18.2/32"
]
},
"kubernetesNetworkConfig": {
"serviceIpv4Cidr": "10.100.0.0/16",
"ipFamily": "ipv4"
},
"logging": {
"clusterLogging": [
{
"types": [
"api",
"audit",
"authenticator",
"controllerManager",
"scheduler"
],
"enabled": true
}
]
},
"identity": {
"oidc": {
"issuer": "https://oidc.eks.us-east-2.amazonaws.com/id/JSA79429HJDASKJDJ8223829MNDNASW"
}
},
"status": "ACTIVE",
"certificateAuthority": {
"data": "CA_DATA_STRING..."
},
"platformVersion": "eks.14",
"tags": {
"aws:cloudformation:stack-name": "eksctl-my-eks-cluster-cluster",
"alpha.eksctl.io/cluster-name": "my-eks-cluster",
"karpenter.sh/discovery": "my-eks-cluster",
"aws:cloudformation:stack-id": "arn:aws:cloudformation:us-east-2:111122223333:stack/eksctl-my-eks-cluster-cluster/e752ea00-e217-11ee-beae-0a9599c8c7ed",
"auto-delete": "no",
"eksctl.cluster.k8s.io/v1alpha1/cluster-name": "my-eks-cluster",
"EKS-Cluster-Name": "my-eks-cluster",
"alpha.eksctl.io/cluster-oidc-enabled": "true",
"aws:cloudformation:logical-id": "ControlPlane",
"alpha.eksctl.io/eksctl-version": "0.173.0-dev+a7ee89342.2024-03-01T03:40:57Z",
"Name": "eksctl-my-eks-cluster-cluster/ControlPlane"
},
"health": {
"issues": []
},
"accessConfig": {
"authenticationMode": "API_AND_CONFIG_MAP"
}
}
}
```
+ For API details, see [DescribeCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-cluster.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet returns descriptive information about an Amazon EKS cluster.**
```
Get-EKSCluster -Name "PROD"
```
**Output:**
```
Arn : arn:aws:eks:us-west-2:012345678912:cluster/PROD
CertificateAuthority : Amazon.EKS.Model.Certificate
ClientRequestToken :
CreatedAt : 12/25/2019 6:46:17 AM
Endpoint : https://669608765450FBBE54D1D78A3D71B72C.gr8.us-west-2.eks.amazonaws.com
Identity : Amazon.EKS.Model.Identity
Logging : Amazon.EKS.Model.Logging
Name : PROD
PlatformVersion : eks.7
ResourcesVpcConfig : Amazon.EKS.Model.VpcConfigResponse
RoleArn : arn:aws:iam::012345678912:role/eks-iam-role
Status : ACTIVE
Tags : {}
Version : 1.14
```
+ For API details, see [DescribeCluster](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet returns descriptive information about an Amazon EKS cluster.**
```
Get-EKSCluster -Name "PROD"
```
**Output:**
```
Arn : arn:aws:eks:us-west-2:012345678912:cluster/PROD
CertificateAuthority : Amazon.EKS.Model.Certificate
ClientRequestToken :
CreatedAt : 12/25/2019 6:46:17 AM
Endpoint : https://669608765450FBBE54D1D78A3D71B72C.gr8.us-west-2.eks.amazonaws.com
Identity : Amazon.EKS.Model.Identity
Logging : Amazon.EKS.Model.Logging
Name : PROD
PlatformVersion : eks.7
ResourcesVpcConfig : Amazon.EKS.Model.VpcConfigResponse
RoleArn : arn:aws:iam::012345678912:role/eks-iam-role
Status : ACTIVE
Tags : {}
Version : 1.14
```
+ For API details, see [DescribeCluster](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeFargateProfile` with a CLI
The following code examples show how to use `DescribeFargateProfile`.
------
#### [ CLI ]
**AWS CLI**
**Describe a Fargate profile**
The following `describe-fargate-profile` example describes a Fargate profile.
```
aws eks describe-fargate-profile \
--cluster-name my-eks-cluster \
--fargate-profile-name my-fargate-profile
```
Output:
```
{
"fargateProfile": {
"fargateProfileName": "my-fargate-profile",
"fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/96c766ce-43d2-f9c9-954c-647334391198",
"clusterName": "my-eks-cluster",
"createdAt": "2024-04-11T10:42:52.486000-04:00",
"podExecutionRoleArn": "arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-farga-FargatePodExecutionRole-1htfAaJdJUEO",
"subnets": [
"subnet-09d912bb63ef21b9a",
"subnet-04ad87f71c6e5ab4d",
"subnet-0e2907431c9988b72"
],
"selectors": [
{
"namespace": "prod*",
"labels": {
"labelname*?": "*value1"
}
},
{
"namespace": "*dev*",
"labels": {
"labelname*?": "*value*"
}
}
],
"status": "ACTIVE",
"tags": {
"eks-fargate-profile-key-2": "value-2",
"eks-fargate-profile-key-1": "value-1"
}
}
}
```
+ For API details, see [DescribeFargateProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-fargate-profile.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet returns descriptive information about an AWS Fargate profile.**
```
Get-EKSFargateProfile -FargateProfileName "EKSFargate" -ClusterName "TEST"
```
**Output:**
```
ClusterName : TEST
CreatedAt : 12/26/2019 12:34:47 PM
FargateProfileArn : arn:aws:eks:us-east-2:012345678912:fargateprofile/TEST/EKSFargate/42b7a119-e16b-a279-ce97-bdf303adec92
FargateProfileName : EKSFargate
PodExecutionRoleArn : arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole
Selectors : {Amazon.EKS.Model.FargateProfileSelector}
Status : ACTIVE
Subnets : {subnet-0cd976f08d5fbfaae, subnet-02f6ff500ff2067a0}
Tags : {}
```
+ For API details, see [DescribeFargateProfile](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet returns descriptive information about an AWS Fargate profile.**
```
Get-EKSFargateProfile -FargateProfileName "EKSFargate" -ClusterName "TEST"
```
**Output:**
```
ClusterName : TEST
CreatedAt : 12/26/2019 12:34:47 PM
FargateProfileArn : arn:aws:eks:us-east-2:012345678912:fargateprofile/TEST/EKSFargate/42b7a119-e16b-a279-ce97-bdf303adec92
FargateProfileName : EKSFargate
PodExecutionRoleArn : arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole
Selectors : {Amazon.EKS.Model.FargateProfileSelector}
Status : ACTIVE
Subnets : {subnet-0cd976f08d5fbfaae, subnet-02f6ff500ff2067a0}
Tags : {}
```
+ For API details, see [DescribeFargateProfile](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeNodegroup` with a CLI
The following code examples show how to use `DescribeNodegroup`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon EKS](eks_example_eks_GettingStarted_034_section.md)
------
#### [ CLI ]
**AWS CLI**
**Describe a managed node group for an Amazon EKS cluster**
The following `describe-nodegroup` example describes a managed node group for an Amazon EKS cluster.
```
aws eks describe-nodegroup \
--cluster-name my-eks-cluster \
--nodegroup-name my-eks-nodegroup
```
Output:
```
{
"nodegroup": {
"nodegroupName": "my-eks-nodegroup",
"nodegroupArn": "arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-nodegroup/a8c75f2f-df78-a72f-4063-4b69af3de5b1",
"clusterName": "my-eks-cluster",
"version": "1.26",
"releaseVersion": "1.26.12-20240329",
"createdAt": "2024-04-08T11:42:10.555000-04:00",
"modifiedAt": "2024-04-08T11:44:12.402000-04:00",
"status": "ACTIVE",
"capacityType": "ON_DEMAND",
"scalingConfig": {
"minSize": 1,
"maxSize": 3,
"desiredSize": 1
},
"instanceTypes": [
"t3.medium"
],
"subnets": [
"subnet-0e2907431c9988b72",
"subnet-04ad87f71c6e5ab4d",
"subnet-09d912bb63ef21b9a"
],
"amiType": "AL2_x86_64",
"nodeRole": "arn:aws:iam::111122223333:role/role-name",
"labels": {},
"resources": {
"autoScalingGroups": [
{
"name": "eks-my-eks-nodegroup-a8c75f2f-df78-a72f-4063-4b69af3de5b1"
}
]
},
"diskSize": 20,
"health": {
"issues": []
},
"updateConfig": {
"maxUnavailable": 1
},
"tags": {}
}
}
```
+ For API details, see [DescribeNodegroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-nodegroup.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet returns descriptive information about an Amazon EKS node group.**
```
Get-EKSNodegroup -NodegroupName "ProdEKSNodeGroup" -ClusterName "PROD"
```
**Output:**
```
AmiType : AL2_x86_64
ClusterName : PROD
CreatedAt : 12/25/2019 10:16:45 AM
DiskSize : 40
Health : Amazon.EKS.Model.NodegroupHealth
InstanceTypes : {t3.large}
Labels : {}
ModifiedAt : 12/25/2019 10:16:45 AM
NodegroupArn : arn:aws:eks:us-west-2:012345678912:nodegroup/PROD/ProdEKSNodeGroup/7eb79e47-82b6-04d9-e984-95110db6fa85
NodegroupName : ProdEKSNodeGroup
NodeRole : arn:aws:iam::012345678912:role/NodeInstanceRole
ReleaseVersion : 1.14.7-20190927
RemoteAccess :
Resources :
ScalingConfig : Amazon.EKS.Model.NodegroupScalingConfig
Status : CREATING
Subnets : {subnet-0d1a9fff35efa7691, subnet-0a3f4928edbc224d4}
Tags : {}
Version : 1.14
```
+ For API details, see [DescribeNodegroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet returns descriptive information about an Amazon EKS node group.**
```
Get-EKSNodegroup -NodegroupName "ProdEKSNodeGroup" -ClusterName "PROD"
```
**Output:**
```
AmiType : AL2_x86_64
ClusterName : PROD
CreatedAt : 12/25/2019 10:16:45 AM
DiskSize : 40
Health : Amazon.EKS.Model.NodegroupHealth
InstanceTypes : {t3.large}
Labels : {}
ModifiedAt : 12/25/2019 10:16:45 AM
NodegroupArn : arn:aws:eks:us-west-2:012345678912:nodegroup/PROD/ProdEKSNodeGroup/7eb79e47-82b6-04d9-e984-95110db6fa85
NodegroupName : ProdEKSNodeGroup
NodeRole : arn:aws:iam::012345678912:role/NodeInstanceRole
ReleaseVersion : 1.14.7-20190927
RemoteAccess :
Resources :
ScalingConfig : Amazon.EKS.Model.NodegroupScalingConfig
Status : CREATING
Subnets : {subnet-0d1a9fff35efa7691, subnet-0a3f4928edbc224d4}
Tags : {}
Version : 1.14
```
+ For API details, see [DescribeNodegroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeUpdate` with a CLI
The following code examples show how to use `DescribeUpdate`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To describe an update for a cluster**
The following `describe-update` example describes an update for a cluster named.
```
aws eks describe-update \
--name my-eks-cluster \
--update-id 10bddb13-a71b-425a-b0a6-71cd03e59161
```
Output:
```
{
"update": {
"id": "10bddb13-a71b-425a-b0a6-71cd03e59161",
"status": "Successful",
"type": "EndpointAccessUpdate",
"params": [
{
"type": "EndpointPublicAccess",
"value": "false"
},
{
"type": "EndpointPrivateAccess",
"value": "true"
}
],
"createdAt": "2024-03-14T10:01:26.297000-04:00",
"errors": []
}
}
```
For more information, see [Updating an Amazon EKS cluster Kubernetes version](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html) in the *Amazon EKS User Guide*.
**Example 2: To describe an update for a cluster**
The following `describe-update` example describes an update for a cluster named.
```
aws eks describe-update \
--name my-eks-cluster \
--update-id e4994991-4c0f-475a-a040-427e6da52966
```
Output:
```
{
"update": {
"id": "e4994991-4c0f-475a-a040-427e6da52966",
"status": "Successful",
"type": "AssociateEncryptionConfig",
"params": [
{
"type": "EncryptionConfig",
"value": "[{\"resources\":[\"secrets\"],\"provider\":{\"keyArn\":\"arn:aws:kms:region-code:account:key/key\"}}]"
}
],
"createdAt": "2024-03-14T11:01:26.297000-04:00",
"errors": []
}
}
```
For more information, see [Updating an Amazon EKS cluster Kubernetes version](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html) in the *Amazon EKS User Guide*.
**Example 3: To describe an update for a cluster**
The following `describe-update` example describes an update for a cluster named.
```
aws eks describe-update \
--name my-eks-cluster \
--update-id b5f0ba18-9a87-4450-b5a0-825e6e84496f
```
Output:
```
{
"update": {
"id": "b5f0ba18-9a87-4450-b5a0-825e6e84496f",
"status": "Successful",
"type": "VersionUpdate",
"params": [
{
"type": "Version",
"value": "1.29"
},
{
"type": "PlatformVersion",
"value": "eks.1"
}
],
"createdAt": "2024-03-14T12:05:26.297000-04:00",
"errors": []
}
}
```
For more information, see [Updating an Amazon EKS cluster Kubernetes version](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html) in the *Amazon EKS User Guide*.
+ For API details, see [DescribeUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-update.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet returns descriptive information about an update against your Amazon EKS cluster or associated managed node group. **
```
Get-EKSUpdate -Name "PROD" -UpdateId "ee708232-7d2e-4ed7-9270-d0b5176f0726"
```
**Output:**
```
CreatedAt : 12/25/2019 5:03:07 PM
Errors : {}
Id : ee708232-7d2e-4ed7-9270-d0b5176f0726
Params : {Amazon.EKS.Model.UpdateParam}
Status : Successful
Type : LoggingUpdate
```
+ For API details, see [DescribeUpdate](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet returns descriptive information about an update against your Amazon EKS cluster or associated managed node group. **
```
Get-EKSUpdate -Name "PROD" -UpdateId "ee708232-7d2e-4ed7-9270-d0b5176f0726"
```
**Output:**
```
CreatedAt : 12/25/2019 5:03:07 PM
Errors : {}
Id : ee708232-7d2e-4ed7-9270-d0b5176f0726
Params : {Amazon.EKS.Model.UpdateParam}
Status : Successful
Type : LoggingUpdate
```
+ For API details, see [DescribeUpdate](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListClusters` with a CLI
The following code examples show how to use `ListClusters`.
------
#### [ CLI ]
**AWS CLI**
**To list all the installed add-ons in your Amazon EKS cluster named `my-eks-cluster`**
The following `list-clusters` example lists all the installed add-ons in your Amazon EKS cluster named my-eks-cluster.
```
aws eks list-clusters
```
Output:
```
{
"clusters": [
"prod",
"qa",
"stage",
"my-eks-cluster"
]
}
```
+ For API details, see [ListClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-clusters.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet lists the Amazon EKS clusters in your AWS account in the specified Region.**
```
Get-EKSClusterList
```
**Output:**
```
PROD
```
+ For API details, see [ListClusters](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet lists the Amazon EKS clusters in your AWS account in the specified Region.**
```
Get-EKSClusterList
```
**Output:**
```
PROD
```
+ For API details, see [ListClusters](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListFargateProfiles` with a CLI
The following code examples show how to use `ListFargateProfiles`.
------
#### [ CLI ]
**AWS CLI**
**To list all the fargate profiles in your Amazon EKS cluster named `my-eks-cluster`**
The following `list-fargate-profiles` example lists all the fargate profiles in your Amazon EKS cluster named my-eks-cluster.
```
aws eks list-fargate-profiles \
--cluster-name my-eks-cluster
```
Output:
```
{
"fargateProfileNames": [
"my-fargate-profile"
]
}
```
+ For API details, see [ListFargateProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-fargate-profiles.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.**
```
Get-EKSFargateProfileList -ClusterName "TEST"
```
**Output:**
```
EKSFargate
EKSFargateProfile
```
+ For API details, see [ListFargateProfiles](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.**
```
Get-EKSFargateProfileList -ClusterName "TEST"
```
**Output:**
```
EKSFargate
EKSFargateProfile
```
+ For API details, see [ListFargateProfiles](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListNodegroups` with a CLI
The following code examples show how to use `ListNodegroups`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon EKS](eks_example_eks_GettingStarted_034_section.md)
------
#### [ CLI ]
**AWS CLI**
**List all the node groups in an Amazon EKS cluster**
The following `list-nodegroups` example list all the node groups in an Amazon EKS cluster.
```
aws eks list-nodegroups \
--cluster-name my-eks-cluster
```
Output:
```
{
"nodegroups": [
"my-eks-managed-node-group",
"my-eks-nodegroup"
]
}
```
+ For API details, see [ListNodegroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-nodegroups.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet lists the Amazon EKS node groups associated with the specified cluster in your AWS account in the specified Region. **
```
Get-EKSNodegroupList -ClusterName PROD
```
**Output:**
```
ProdEKSNodeGroup
```
+ For API details, see [ListNodegroups](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet lists the Amazon EKS node groups associated with the specified cluster in your AWS account in the specified Region. **
```
Get-EKSNodegroupList -ClusterName PROD
```
**Output:**
```
ProdEKSNodeGroup
```
+ For API details, see [ListNodegroups](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListTagsForResource` with a CLI
The following code examples show how to use `ListTagsForResource`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To list all the tags for an Amazon EKS Cluster ARN**
The following `list-tags-for-resource` example lists all the tags for an Amazon EKS Cluster ARN.
```
aws eks list-tags-for-resource \
--resource-arn arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster
```
Output:
```
{
"tags": {
"aws:cloudformation:stack-name": "eksctl-my-eks-cluster-cluster",
"alpha.eksctl.io/cluster-name": "my-eks-cluster",
"karpenter.sh/discovery": "my-eks-cluster",
"aws:cloudformation:stack-id": "arn:aws:cloudformation:us-east-2:111122223333:stack/eksctl-my-eks-cluster-cluster/e752ea00-e217-11ee-beae-0a9599c8c7ed",
"auto-delete": "no",
"eksctl.cluster.k8s.io/v1alpha1/cluster-name": "my-eks-cluster",
"EKS-Cluster-Name": "my-eks-cluster",
"alpha.eksctl.io/cluster-oidc-enabled": "true",
"aws:cloudformation:logical-id": "ControlPlane",
"alpha.eksctl.io/eksctl-version": "0.173.0-dev+a7ee89342.2024-03-01T03:40:57Z",
"Name": "eksctl-my-eks-cluster-cluster/ControlPlane"
}
}
```
**Example 2: To list all the tags for an Amazon EKS Node group ARN**
The following `list-tags-for-resource` example lists all the tags for an Amazon EKS Node group ARN.
```
aws eks list-tags-for-resource \
--resource-arn arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-managed-node-group/60c71ed2-2cfb-020f-a5f4-ad32477f198c
```
Output:
```
{
"tags": {
"aws:cloudformation:stack-name": "eksctl-my-eks-cluster-nodegroup-my-eks-managed-node-group",
"aws:cloudformation:stack-id": "arn:aws:cloudformation:us-east-2:111122223333:stack/eksctl-my-eks-cluster-nodegroup-my-eks-managed-node-group/eaa20310-e219-11ee-b851-0ab9ad8228ff",
"eksctl.cluster.k8s.io/v1alpha1/cluster-name": "my-eks-cluster",
"EKS-Cluster-Name": "my-eks-cluster",
"alpha.eksctl.io/nodegroup-type": "managed",
"NodeGroup Name 1": "my-eks-managed-node-group",
"k8s.io/cluster-autoscaler/enabled": "true",
"nodegroup-role": "worker",
"alpha.eksctl.io/cluster-name": "my-eks-cluster",
"alpha.eksctl.io/nodegroup-name": "my-eks-managed-node-group",
"karpenter.sh/discovery": "my-eks-cluster",
"NodeGroup Name 2": "AmazonLinux-Linux-Managed-NG-v1-26-v1",
"auto-delete": "no",
"k8s.io/cluster-autoscaler/my-eks-cluster": "owned",
"aws:cloudformation:logical-id": "ManagedNodeGroup",
"alpha.eksctl.io/eksctl-version": "0.173.0-dev+a7ee89342.2024-03-01T03:40:57Z"
}
}
```
**Example 3: To list all the tags on an Amazon EKS Fargate profil ARNe**
The following `list-tags-for-resource` example lists all the tags for an Amazon EKS Fargate profile ARN.
```
aws eks list-tags-for-resource \
--resource-arn arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/d6c76780-e541-0725-c816-36754cab734b
```
Output:
```
{
"tags": {
"eks-fargate-profile-key-2": "value-2",
"eks-fargate-profile-key-1": "value-1"
}
}
```
**Example 4: To list all the tags for an Amazon EKS Add-on ARN**
The following `list-tags-for-resource` example lists all the tags for an Amazon EKS Add-on ARN.
```
aws eks list-tags-for-resource \
--resource-arn arn:aws:eks:us-east-2:111122223333:addon/my-eks-cluster/vpc-cni/0ec71efc-98dd-3203-60b0-4b939b2a5e5f
```
Output:
```
{
"tags": {
"eks-addon-key-2": "value-2",
"eks-addon-key-1": "value-1"
}
}
```
**Example 5: To list all the tags for an Amazon EKS OIDC identity provider ARN**
The following `list-tags-for-resource` example lists all the tags for an Amazon EKS OIDC identity provider ARN.
```
aws eks list-tags-for-resource \
--resource-arn arn:aws:eks:us-east-2:111122223333:identityproviderconfig/my-eks-cluster/oidc/my-identity-provider/8ac76722-78e4-cec1-ed76-d49eea058622
```
Output:
```
{
"tags": {
"my-identity-provider": "test"
}
}
```
+ For API details, see [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-tags-for-resource.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet list the tags for an Amazon EKS resource. **
```
Get-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD"
```
**Output:**
```
Key Value
--- -----
Name EKSPRODCLUSTER
```
+ For API details, see [ListTagsForResource](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet list the tags for an Amazon EKS resource. **
```
Get-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD"
```
**Output:**
```
Key Value
--- -----
Name EKSPRODCLUSTER
```
+ For API details, see [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListUpdates` with a CLI
The following code examples show how to use `ListUpdates`.
------
#### [ CLI ]
**AWS CLI**
**To list the updates for a cluster**
This example command lists the current updates for a cluster named `example` in your default region.
Command:
```
aws eks list-updates --name example
```
Output:
```
{
"updateIds": [
"10bddb13-a71b-425a-b0a6-71cd03e59161"
]
}
```
+ For API details, see [ListUpdates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-updates.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.**
```
Get-EKSUpdateList -Name "PROD"
```
**Output:**
```
ee708232-7d2e-4ed7-9270-d0b5176f0726
```
+ For API details, see [ListUpdates](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.**
```
Get-EKSUpdateList -Name "PROD"
```
**Output:**
```
ee708232-7d2e-4ed7-9270-d0b5176f0726
```
+ For API details, see [ListUpdates](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `TagResource` with a CLI
The following code examples show how to use `TagResource`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To add the specified tags to an Amazon EKS Cluster**
The following `tag-resource` example adds the specified tags to an Amazon EKS Cluster.
```
aws eks tag-resource \
--resource-arn arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster \
--tag 'my-eks-cluster-test-1=test-value-1,my-eks-cluster-dev-1=dev-value-2'
```
This command produces no output.
**Example 2: To add the specified tags to an Amazon EKS Node group**
The following `tag-resource` example adds the specified tags to an Amazon EKS Node group.
```
aws eks tag-resource \
--resource-arn arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-managed-node-group/60c71ed2-2cfb-020f-a5f4-ad32477f198c \
--tag 'my-eks-nodegroup-test-1=test-value-1,my-eks-nodegroup-dev-1=dev-value-2'
```
This command produces no output.
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/tag-resource.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet associates the specified tags to a resource with the specified resourceArn. **
```
Add-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD" -Tag @{Name = "EKSPRODCLUSTER"}
```
+ For API details, see [TagResource](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet associates the specified tags to a resource with the specified resourceArn. **
```
Add-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD" -Tag @{Name = "EKSPRODCLUSTER"}
```
+ For API details, see [TagResource](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `UntagResource` with a CLI
The following code examples show how to use `UntagResource`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To deletes the specified tags from an Amazon EKS Cluster**
The following `untag-resource` example deletes the specified tags from an Amazon EKS Cluster.
```
aws eks untag-resource \
--resource-arn arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster \
--tag-keys "my-eks-cluster-test-1" "my-eks-cluster-dev-1"
```
This command produces no output.
**Example 2: To deletes the specified tags from an Amazon EKS Node group**
The following `untag-resource` example deletes the specified tags from an Amazon EKS Node group.
```
aws eks untag-resource \
--resource-arn arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-managed-node-group/60c71ed2-2cfb-020f-a5f4-ad32477f198c \
--tag-keys "my-eks-nodegroup-test-1" "my-eks-nodegroup-dev-1"
```
This command produces no output.
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/untag-resource.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet deletes specified tags from an EKS resource.**
```
Remove-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD" -TagKey "Name"
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSResourceTag (UntagResource)" on target "arn:aws:eks:us-west-2:012345678912:cluster/PROD".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ For API details, see [UntagResource](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet deletes specified tags from an EKS resource.**
```
Remove-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD" -TagKey "Name"
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSResourceTag (UntagResource)" on target "arn:aws:eks:us-west-2:012345678912:cluster/PROD".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ For API details, see [UntagResource](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `UpdateClusterConfig` with a CLI
The following code examples show how to use `UpdateClusterConfig`.
------
#### [ CLI ]
**AWS CLI**
**To update cluster endpoint access**
This example command updates a cluster to disable endpoint public access and enable private endpoint access.
Command:
```
aws eks update-cluster-config --name example \
--resources-vpc-config endpointPublicAccess=false,endpointPrivateAccess=true
```
Output:
```
{
"update": {
"id": "ec883c93-2e9e-407c-a22f-8f6fa6e67d4f",
"status": "InProgress",
"type": "EndpointAccessUpdate",
"params": [
{
"type": "EndpointPublicAccess",
"value": "false"
},
{
"type": "EndpointPrivateAccess",
"value": "true"
}
],
"createdAt": 1565806986.506,
"errors": []
}
}
```
**To enable logging for a cluster**
This example command enables all cluster control plane logging types for a cluster named `example`.
Command:
```
aws eks update-cluster-config --name example \
--logging '{"clusterLogging":[{"types":["api","audit","authenticator","controllerManager","scheduler"],"enabled":true}]}'
```
Output:
```
{
"update": {
"id": "7551c64b-1d27-4b1e-9f8e-c45f056eb6fd",
"status": "InProgress",
"type": "LoggingUpdate",
"params": [
{
"type": "ClusterLogging",
"value": "{\"clusterLogging\":[{\"types\":[\"api\",\"audit\",\"authenticator\",\"controllerManager\",\"scheduler\"],\"enabled\":true}]}"
}
],
"createdAt": 1565807210.37,
"errors": []
}
}
```
+ For API details, see [UpdateClusterConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-cluster-config.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update.**
```
Update-EKSClusterConfig -Name "PROD" -Logging_ClusterLogging @{Types="api","audit","authenticator","controllerManager","scheduler",Enabled="True"}
```
**Output:**
```
CreatedAt : 12/25/2019 5:03:07 PM
Errors : {}
Id : ee708232-7d2e-4ed7-9270-d0b5176f0726
Params : {Amazon.EKS.Model.UpdateParam}
Status : InProgress
Type : LoggingUpdate
```
+ For API details, see [UpdateClusterConfig](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update.**
```
Update-EKSClusterConfig -Name "PROD" -Logging_ClusterLogging @{Types="api","audit","authenticator","controllerManager","scheduler",Enabled="True"}
```
**Output:**
```
CreatedAt : 12/25/2019 5:03:07 PM
Errors : {}
Id : ee708232-7d2e-4ed7-9270-d0b5176f0726
Params : {Amazon.EKS.Model.UpdateParam}
Status : InProgress
Type : LoggingUpdate
```
+ For API details, see [UpdateClusterConfig](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `UpdateClusterVersion` with a CLI
The following code examples show how to use `UpdateClusterVersion`.
------
#### [ CLI ]
**AWS CLI**
**To updates an Amazon EKS cluster named `my-eks-cluster` to the specified Kubernetes version**
The following `update-cluster-version` example updates an Amazon EKS cluster to the specified Kubernetes version.
```
aws eks update-cluster-version \
--name my-eks-cluster \
--kubernetes-version 1.27
```
Output:
```
{
"update": {
"id": "e4091a28-ea14-48fd-a8c7-975aeb469e8a",
"status": "InProgress",
"type": "VersionUpdate",
"params": [
{
"type": "Version",
"value": "1.27"
},
{
"type": "PlatformVersion",
"value": "eks.16"
}
],
"createdAt": "2024-04-12T16:56:01.082000-04:00",
"errors": []
}
}
```
For more information, see [Updating an Amazon EKS cluster Kubernetes version](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html) in the *Amazon EKS User Guide*.
+ For API details, see [UpdateClusterVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-cluster-version.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This cmdlet updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update.**
```
Update-EKSClusterVersion -Name "PROD-KUBE-CL" -Version 1.14
```
**Output:**
```
CreatedAt : 12/26/2019 9:50:37 AM
Errors : {}
Id : ef186eff-3b3a-4c25-bcfc-3dcdf9e898a8
Params : {Amazon.EKS.Model.UpdateParam, Amazon.EKS.Model.UpdateParam}
Status : InProgress
Type : VersionUpdate
```
+ For API details, see [UpdateClusterVersion](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This cmdlet updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update.**
```
Update-EKSClusterVersion -Name "PROD-KUBE-CL" -Version 1.14
```
**Output:**
```
CreatedAt : 12/26/2019 9:50:37 AM
Errors : {}
Id : ef186eff-3b3a-4c25-bcfc-3dcdf9e898a8
Params : {Amazon.EKS.Model.UpdateParam, Amazon.EKS.Model.UpdateParam}
Status : InProgress
Type : VersionUpdate
```
+ For API details, see [UpdateClusterVersion](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Scenarios for Amazon EKS using AWS SDKs
The following code examples show you how to implement common scenarios in Amazon EKS with AWS SDKs. These scenarios show you how to accomplish specific tasks by calling multiple functions within Amazon EKS or combined with other AWS services. Each scenario includes a link to the complete source code, where you can find instructions on how to set up and run the code.
Scenarios target an intermediate level of experience to help you understand service actions in context.
**Topics**
+ [Getting started with Amazon EKS](eks_example_eks_GettingStarted_034_section.md)
# Getting started with Amazon EKS
The following code example shows how to:
+ Create a VPC for your EKS cluster
+ Create IAM roles for your EKS cluster
+ Create your EKS cluster
+ Configure kubectl to communicate with your cluster
+ Create a managed node group
+ Clean up resources
------
#### [ Bash ]
**AWS CLI with Bash script**
There's more on GitHub. Find the complete example and learn how to set up and run in the [Sample developer tutorials](https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/034-eks-gs) repository.
```
#!/bin/bash
# Amazon EKS Cluster Creation Script (v2)
# This script creates an Amazon EKS cluster with a managed node group using the AWS CLI
# Set up logging
LOG_FILE="eks-cluster-creation-v2.log"
exec > >(tee -a "$LOG_FILE") 2>&1
echo "Starting Amazon EKS cluster creation script at $(date)"
echo "All commands and outputs will be logged to $LOG_FILE"
# Error handling function
handle_error() {
echo "ERROR: $1"
echo "Attempting to clean up resources..."
cleanup_resources
exit 1
}
# Function to check command success
check_command() {
if [ $? -ne 0 ] || echo "$1" | grep -i "error" > /dev/null; then
handle_error "$1"
fi
}
# Function to check if kubectl is installed
check_kubectl() {
if ! command -v kubectl &> /dev/null; then
echo "WARNING: kubectl is not installed or not in your PATH."
echo ""
echo "To install kubectl, follow these instructions based on your operating system:"
echo ""
echo "For Linux:"
echo " 1. Download the latest release:"
echo " curl -LO \"https://dl.k8s.io/release/\$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl\""
echo ""
echo " 2. Make the kubectl binary executable:"
echo " chmod +x ./kubectl"
echo ""
echo " 3. Move the binary to your PATH:"
echo " sudo mv ./kubectl /usr/local/bin/kubectl"
echo ""
echo "For macOS:"
echo " 1. Using Homebrew:"
echo " brew install kubectl"
echo " or"
echo " 2. Using curl:"
echo " curl -LO \"https://dl.k8s.io/release/\$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl\""
echo " chmod +x ./kubectl"
echo " sudo mv ./kubectl /usr/local/bin/kubectl"
echo ""
echo "For Windows:"
echo " 1. Using curl:"
echo " curl -LO \"https://dl.k8s.io/release/v1.28.0/bin/windows/amd64/kubectl.exe\""
echo " Add the binary to your PATH"
echo " or"
echo " 2. Using Chocolatey:"
echo " choco install kubernetes-cli"
echo ""
echo "After installation, verify with: kubectl version --client"
echo ""
return 1
fi
return 0
}
# Generate a random identifier for resource names
RANDOM_ID=$(LC_ALL=C tr -dc 'a-z0-9' < /dev/urandom | fold -w 6 | head -n 1)
STACK_NAME="eks-vpc-stack-${RANDOM_ID}"
CLUSTER_NAME="eks-cluster-${RANDOM_ID}"
NODEGROUP_NAME="eks-nodegroup-${RANDOM_ID}"
CLUSTER_ROLE_NAME="EKSClusterRole-${RANDOM_ID}"
NODE_ROLE_NAME="EKSNodeRole-${RANDOM_ID}"
echo "Using the following resource names:"
echo "- VPC Stack: $STACK_NAME"
echo "- EKS Cluster: $CLUSTER_NAME"
echo "- Node Group: $NODEGROUP_NAME"
echo "- Cluster IAM Role: $CLUSTER_ROLE_NAME"
echo "- Node IAM Role: $NODE_ROLE_NAME"
# Array to track created resources for cleanup
declare -a CREATED_RESOURCES
# Function to clean up resources
cleanup_resources() {
echo "Cleaning up resources in reverse order..."
# Check if node group exists and delete it
if aws eks list-nodegroups --cluster-name "$CLUSTER_NAME" --query "nodegroups[?contains(@,'$NODEGROUP_NAME')]" --output text 2>/dev/null | grep -q "$NODEGROUP_NAME"; then
echo "Deleting node group: $NODEGROUP_NAME"
aws eks delete-nodegroup --cluster-name "$CLUSTER_NAME" --nodegroup-name "$NODEGROUP_NAME"
echo "Waiting for node group deletion to complete..."
aws eks wait nodegroup-deleted --cluster-name "$CLUSTER_NAME" --nodegroup-name "$NODEGROUP_NAME"
echo "Node group deleted successfully."
fi
# Check if cluster exists and delete it
if aws eks describe-cluster --name "$CLUSTER_NAME" 2>/dev/null; then
echo "Deleting cluster: $CLUSTER_NAME"
aws eks delete-cluster --name "$CLUSTER_NAME"
echo "Waiting for cluster deletion to complete (this may take several minutes)..."
aws eks wait cluster-deleted --name "$CLUSTER_NAME"
echo "Cluster deleted successfully."
fi
# Check if CloudFormation stack exists and delete it
if aws cloudformation describe-stacks --stack-name "$STACK_NAME" 2>/dev/null; then
echo "Deleting CloudFormation stack: $STACK_NAME"
aws cloudformation delete-stack --stack-name "$STACK_NAME"
echo "Waiting for CloudFormation stack deletion to complete..."
aws cloudformation wait stack-delete-complete --stack-name "$STACK_NAME"
echo "CloudFormation stack deleted successfully."
fi
# Clean up IAM roles
if aws iam get-role --role-name "$NODE_ROLE_NAME" 2>/dev/null; then
echo "Detaching policies from node role: $NODE_ROLE_NAME"
aws iam detach-role-policy --policy-arn arn:aws:iam::aws:policy/AmazonEKSWorkerNodePolicy --role-name "$NODE_ROLE_NAME"
aws iam detach-role-policy --policy-arn arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryReadOnly --role-name "$NODE_ROLE_NAME"
aws iam detach-role-policy --policy-arn arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy --role-name "$NODE_ROLE_NAME"
echo "Deleting node role: $NODE_ROLE_NAME"
aws iam delete-role --role-name "$NODE_ROLE_NAME"
echo "Node role deleted successfully."
fi
if aws iam get-role --role-name "$CLUSTER_ROLE_NAME" 2>/dev/null; then
echo "Detaching policies from cluster role: $CLUSTER_ROLE_NAME"
aws iam detach-role-policy --policy-arn arn:aws:iam::aws:policy/AmazonEKSClusterPolicy --role-name "$CLUSTER_ROLE_NAME"
echo "Deleting cluster role: $CLUSTER_ROLE_NAME"
aws iam delete-role --role-name "$CLUSTER_ROLE_NAME"
echo "Cluster role deleted successfully."
fi
echo "Cleanup complete."
}
# Trap to ensure cleanup on script exit
trap 'echo "Script interrupted. Cleaning up resources..."; cleanup_resources; exit 1' SIGINT SIGTERM
# Verify AWS CLI configuration
echo "Verifying AWS CLI configuration..."
AWS_ACCOUNT_INFO=$(aws sts get-caller-identity)
check_command "$AWS_ACCOUNT_INFO"
echo "AWS CLI is properly configured."
# Step 1: Create VPC using CloudFormation
echo "Step 1: Creating VPC with CloudFormation..."
echo "Creating CloudFormation stack: $STACK_NAME"
# Create the CloudFormation stack
CF_CREATE_OUTPUT=$(aws cloudformation create-stack \
--stack-name "$STACK_NAME" \
--template-url https://s3.us-west-2.amazonaws.com/amazon-eks/cloudformation/2020-10-29/amazon-eks-vpc-private-subnets.yaml)
check_command "$CF_CREATE_OUTPUT"
CREATED_RESOURCES+=("CloudFormation Stack: $STACK_NAME")
echo "Waiting for CloudFormation stack to complete (this may take a few minutes)..."
aws cloudformation wait stack-create-complete --stack-name "$STACK_NAME"
if [ $? -ne 0 ]; then
handle_error "CloudFormation stack creation failed"
fi
echo "CloudFormation stack created successfully."
# Step 2: Create IAM roles for EKS
echo "Step 2: Creating IAM roles for EKS..."
# Create cluster role trust policy
echo "Creating cluster role trust policy..."
cat > eks-cluster-role-trust-policy.json << EOF
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "eks.amazonaws.com"
},
"Action": "sts:AssumeRole"
}
]
}
EOF
# Create cluster role
echo "Creating cluster IAM role: $CLUSTER_ROLE_NAME"
CLUSTER_ROLE_OUTPUT=$(aws iam create-role \
--role-name "$CLUSTER_ROLE_NAME" \
--assume-role-policy-document file://"eks-cluster-role-trust-policy.json")
check_command "$CLUSTER_ROLE_OUTPUT"
CREATED_RESOURCES+=("IAM Role: $CLUSTER_ROLE_NAME")
# Attach policy to cluster role
echo "Attaching EKS cluster policy to role..."
ATTACH_CLUSTER_POLICY_OUTPUT=$(aws iam attach-role-policy \
--policy-arn arn:aws:iam::aws:policy/AmazonEKSClusterPolicy \
--role-name "$CLUSTER_ROLE_NAME")
check_command "$ATTACH_CLUSTER_POLICY_OUTPUT"
# Create node role trust policy
echo "Creating node role trust policy..."
cat > node-role-trust-policy.json << EOF
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "ec2.amazonaws.com"
},
"Action": "sts:AssumeRole"
}
]
}
EOF
# Create node role
echo "Creating node IAM role: $NODE_ROLE_NAME"
NODE_ROLE_OUTPUT=$(aws iam create-role \
--role-name "$NODE_ROLE_NAME" \
--assume-role-policy-document file://"node-role-trust-policy.json")
check_command "$NODE_ROLE_OUTPUT"
CREATED_RESOURCES+=("IAM Role: $NODE_ROLE_NAME")
# Attach policies to node role
echo "Attaching EKS node policies to role..."
ATTACH_NODE_POLICY1_OUTPUT=$(aws iam attach-role-policy \
--policy-arn arn:aws:iam::aws:policy/AmazonEKSWorkerNodePolicy \
--role-name "$NODE_ROLE_NAME")
check_command "$ATTACH_NODE_POLICY1_OUTPUT"
ATTACH_NODE_POLICY2_OUTPUT=$(aws iam attach-role-policy \
--policy-arn arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryReadOnly \
--role-name "$NODE_ROLE_NAME")
check_command "$ATTACH_NODE_POLICY2_OUTPUT"
ATTACH_NODE_POLICY3_OUTPUT=$(aws iam attach-role-policy \
--policy-arn arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy \
--role-name "$NODE_ROLE_NAME")
check_command "$ATTACH_NODE_POLICY3_OUTPUT"
# Step 3: Get VPC and subnet information
echo "Step 3: Getting VPC and subnet information..."
VPC_ID=$(aws cloudformation describe-stacks \
--stack-name "$STACK_NAME" \
--query "Stacks[0].Outputs[?OutputKey=='VpcId'].OutputValue" \
--output text)
if [ -z "$VPC_ID" ]; then
handle_error "Failed to get VPC ID from CloudFormation stack"
fi
echo "VPC ID: $VPC_ID"
SUBNET_IDS=$(aws cloudformation describe-stacks \
--stack-name "$STACK_NAME" \
--query "Stacks[0].Outputs[?OutputKey=='SubnetIds'].OutputValue" \
--output text)
if [ -z "$SUBNET_IDS" ]; then
handle_error "Failed to get Subnet IDs from CloudFormation stack"
fi
echo "Subnet IDs: $SUBNET_IDS"
SECURITY_GROUP_ID=$(aws cloudformation describe-stacks \
--stack-name "$STACK_NAME" \
--query "Stacks[0].Outputs[?OutputKey=='SecurityGroups'].OutputValue" \
--output text)
if [ -z "$SECURITY_GROUP_ID" ]; then
handle_error "Failed to get Security Group ID from CloudFormation stack"
fi
echo "Security Group ID: $SECURITY_GROUP_ID"
# Step 4: Create EKS cluster
echo "Step 4: Creating EKS cluster: $CLUSTER_NAME"
CLUSTER_ROLE_ARN=$(aws iam get-role --role-name "$CLUSTER_ROLE_NAME" --query "Role.Arn" --output text)
if [ -z "$CLUSTER_ROLE_ARN" ]; then
handle_error "Failed to get Cluster Role ARN"
fi
echo "Creating EKS cluster (this will take 10-15 minutes)..."
CREATE_CLUSTER_OUTPUT=$(aws eks create-cluster \
--name "$CLUSTER_NAME" \
--role-arn "$CLUSTER_ROLE_ARN" \
--resources-vpc-config subnetIds="$SUBNET_IDS",securityGroupIds="$SECURITY_GROUP_ID")
check_command "$CREATE_CLUSTER_OUTPUT"
CREATED_RESOURCES+=("EKS Cluster: $CLUSTER_NAME")
echo "Waiting for EKS cluster to become active (this may take 10-15 minutes)..."
aws eks wait cluster-active --name "$CLUSTER_NAME"
if [ $? -ne 0 ]; then
handle_error "Cluster creation failed or timed out"
fi
echo "EKS cluster is now active."
# Step 5: Configure kubectl
echo "Step 5: Configuring kubectl to communicate with the cluster..."
# Check if kubectl is installed
if ! check_kubectl; then
echo "Will skip kubectl configuration steps but continue with the script."
echo "You can manually configure kubectl later with: aws eks update-kubeconfig --name \"$CLUSTER_NAME\""
else
UPDATE_KUBECONFIG_OUTPUT=$(aws eks update-kubeconfig --name "$CLUSTER_NAME")
check_command "$UPDATE_KUBECONFIG_OUTPUT"
echo "kubectl configured successfully."
# Test kubectl configuration
echo "Testing kubectl configuration..."
KUBECTL_TEST_OUTPUT=$(kubectl get svc 2>&1)
if [ $? -ne 0 ]; then
echo "Warning: kubectl configuration test failed. This might be due to permissions or network issues."
echo "Error details: $KUBECTL_TEST_OUTPUT"
echo "Continuing with script execution..."
else
echo "$KUBECTL_TEST_OUTPUT"
echo "kubectl configuration test successful."
fi
fi
# Step 6: Create managed node group
echo "Step 6: Creating managed node group: $NODEGROUP_NAME"
NODE_ROLE_ARN=$(aws iam get-role --role-name "$NODE_ROLE_NAME" --query "Role.Arn" --output text)
if [ -z "$NODE_ROLE_ARN" ]; then
handle_error "Failed to get Node Role ARN"
fi
# Convert comma-separated subnet IDs to space-separated for the create-nodegroup command
SUBNET_IDS_ARRAY=(${SUBNET_IDS//,/ })
echo "Creating managed node group (this will take 5-10 minutes)..."
CREATE_NODEGROUP_OUTPUT=$(aws eks create-nodegroup \
--cluster-name "$CLUSTER_NAME" \
--nodegroup-name "$NODEGROUP_NAME" \
--node-role "$NODE_ROLE_ARN" \
--subnets "${SUBNET_IDS_ARRAY[@]}")
check_command "$CREATE_NODEGROUP_OUTPUT"
CREATED_RESOURCES+=("EKS Node Group: $NODEGROUP_NAME")
echo "Waiting for node group to become active (this may take 5-10 minutes)..."
aws eks wait nodegroup-active --cluster-name "$CLUSTER_NAME" --nodegroup-name "$NODEGROUP_NAME"
if [ $? -ne 0 ]; then
handle_error "Node group creation failed or timed out"
fi
echo "Node group is now active."
# Step 7: Verify nodes
echo "Step 7: Verifying nodes..."
echo "Waiting for nodes to register with the cluster (this may take a few minutes)..."
sleep 60 # Give nodes more time to register
# Check if kubectl is installed before attempting to use it
if ! check_kubectl; then
echo "Cannot verify nodes without kubectl. Skipping this step."
echo "You can manually verify nodes after installing kubectl with: kubectl get nodes"
else
NODES_OUTPUT=$(kubectl get nodes 2>&1)
if [ $? -ne 0 ]; then
echo "Warning: Unable to get nodes. This might be due to permissions or the nodes are still registering."
echo "Error details: $NODES_OUTPUT"
echo "Continuing with script execution..."
else
echo "$NODES_OUTPUT"
echo "Nodes verified successfully."
fi
fi
# Step 8: View resources
echo "Step 8: Viewing cluster resources..."
echo "Cluster information:"
CLUSTER_INFO=$(aws eks describe-cluster --name "$CLUSTER_NAME")
echo "$CLUSTER_INFO"
echo "Node group information:"
NODEGROUP_INFO=$(aws eks describe-nodegroup --cluster-name "$CLUSTER_NAME" --nodegroup-name "$NODEGROUP_NAME")
echo "$NODEGROUP_INFO"
echo "Kubernetes resources:"
if ! check_kubectl; then
echo "Cannot list Kubernetes resources without kubectl. Skipping this step."
echo "You can manually list resources after installing kubectl with: kubectl get all --all-namespaces"
else
KUBE_RESOURCES=$(kubectl get all --all-namespaces 2>&1)
if [ $? -ne 0 ]; then
echo "Warning: Unable to get Kubernetes resources. This might be due to permissions."
echo "Error details: $KUBE_RESOURCES"
echo "Continuing with script execution..."
else
echo "$KUBE_RESOURCES"
fi
fi
# Display summary of created resources
echo ""
echo "==========================================="
echo "RESOURCES CREATED"
echo "==========================================="
for resource in "${CREATED_RESOURCES[@]}"; do
echo "- $resource"
done
echo "==========================================="
# Prompt for cleanup
echo ""
echo "==========================================="
echo "CLEANUP CONFIRMATION"
echo "==========================================="
echo "Do you want to clean up all created resources? (y/n): "
read -r CLEANUP_CHOICE
if [[ "${CLEANUP_CHOICE,,}" == "y" ]]; then
cleanup_resources
else
echo "Resources will not be cleaned up. You can manually clean them up later."
echo "To clean up resources, run the following commands:"
echo "1. Delete node group: aws eks delete-nodegroup --cluster-name $CLUSTER_NAME --nodegroup-name $NODEGROUP_NAME"
echo "2. Wait for node group deletion: aws eks wait nodegroup-deleted --cluster-name $CLUSTER_NAME --nodegroup-name $NODEGROUP_NAME"
echo "3. Delete cluster: aws eks delete-cluster --name $CLUSTER_NAME"
echo "4. Wait for cluster deletion: aws eks wait cluster-deleted --name $CLUSTER_NAME"
echo "5. Delete CloudFormation stack: aws cloudformation delete-stack --stack-name $STACK_NAME"
echo "6. Detach and delete IAM roles for the node group and cluster"
fi
echo "Script completed at $(date)"
```
+ For API details, see the following topics in *AWS CLI Command Reference*.
+ [AttachRolePolicy](https://docs.aws.amazon.com/goto/aws-cli/iam-2010-05-08/AttachRolePolicy)
+ [CreateCluster](https://docs.aws.amazon.com/goto/aws-cli/eks-2017-11-01/CreateCluster)
+ [CreateNodegroup](https://docs.aws.amazon.com/goto/aws-cli/eks-2017-11-01/CreateNodegroup)
+ [CreateRole](https://docs.aws.amazon.com/goto/aws-cli/iam-2010-05-08/CreateRole)
+ [CreateStack](https://docs.aws.amazon.com/goto/aws-cli/cloudformation-2010-05-15/CreateStack)
+ [DeleteCluster](https://docs.aws.amazon.com/goto/aws-cli/eks-2017-11-01/DeleteCluster)
+ [DeleteNodegroup](https://docs.aws.amazon.com/goto/aws-cli/eks-2017-11-01/DeleteNodegroup)
+ [DeleteRole](https://docs.aws.amazon.com/goto/aws-cli/iam-2010-05-08/DeleteRole)
+ [DeleteStack](https://docs.aws.amazon.com/goto/aws-cli/cloudformation-2010-05-15/DeleteStack)
+ [DescribeCluster](https://docs.aws.amazon.com/goto/aws-cli/eks-2017-11-01/DescribeCluster)
+ [DescribeNodegroup](https://docs.aws.amazon.com/goto/aws-cli/eks-2017-11-01/DescribeNodegroup)
+ [DescribeStacks](https://docs.aws.amazon.com/goto/aws-cli/cloudformation-2010-05-15/DescribeStacks)
+ [DetachRolePolicy](https://docs.aws.amazon.com/goto/aws-cli/iam-2010-05-08/DetachRolePolicy)
+ [GetCallerIdentity](https://docs.aws.amazon.com/goto/aws-cli/sts-2011-06-15/GetCallerIdentity)
+ [GetRole](https://docs.aws.amazon.com/goto/aws-cli/iam-2010-05-08/GetRole)
+ [ListNodegroups](https://docs.aws.amazon.com/goto/aws-cli/eks-2017-11-01/ListNodegroups)
+ [UpdateKubeconfig](https://docs.aws.amazon.com/goto/aws-cli/eks-2017-11-01/UpdateKubeconfig)
+ [Wait](https://docs.aws.amazon.com/goto/aws-cli/cloudformation-2010-05-15/Wait)
------