AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Configures kubectl so that you can connect to an Amazon EKS cluster.
This command constructs a configuration with prepopulated server and certificate authority data values for a specified cluster.
You can specify an IAM role ARN with the --role-arn option to use for authentication when you issue kubectl commands.
Otherwise, the IAM entity in your default AWS CLI or SDK credential chain is used.
You can view your default AWS CLI or SDK identity by running the aws sts get-caller-identity
command.
The resulting kubeconfig is created as a new file or merged with an existing kubeconfig file using the following logic:
You can use the --dry-run option to print the resulting configuration to stdout instead of writing it to the specified location.
update-kubeconfig
--name <value>
[--kubeconfig <value>]
[--role-arn <value>]
[--dry-run]
[--verbose]
[--alias <value>]
[--user-alias <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--name
(string)
The name of the cluster for which to create a kubeconfig entry. This cluster must exist in your account and in the specified or configured default Region for your AWS CLI installation.
--kubeconfig
(string)
Optionally specify a kubeconfig file to append with your configuration. By default, the configuration is written to the first file path in the KUBECONFIG environment variable (if it is set) or the default kubeconfig path (.kube/config) in your home directory.
--role-arn
(string)
To assume a role for cluster authentication, specify an IAM role ARN with this option. For example, if you created a cluster while assuming an IAM role, then you must also assume that role to connect to the cluster the first time.
--dry-run
(boolean)
Print the merged kubeconfig to stdout instead of writing it to the specified file.
--verbose
(boolean)
Print more detailed output when writing to the kubeconfig file, including the appended entries.
--alias
(string)
Alias for the cluster context name. Defaults to match cluster ARN.
--user-alias
(string)
Alias for the generated user name. Defaults to match cluster ARN.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
Example 1: Configures your kubectl by creating or updating the kubeconfig so that you can connect to an Amazon EKS Cluster named `my-eks-cluster`
The following update-kubeconfig
example configures your kubectl by creating or updating the kubeconfig so that you can connect to an Amazon EKS Cluster named my-eks-cluster.
aws eks update-kubeconfig \
--name my-eks-cluster
Output:
Updated context arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster in /Users/xxx/.kube/config
For more information, see Creating or updating a kubeconfig file for an Amazon EKS cluster in the Amazon EKS User Guide.
Example 2: Configures your kubectl by creating or updating the kubeconfig (with role-arn option to assume a role for cluster authentication) so that you can connect to an Amazon EKS Cluster named `my-eks-cluster`
The following update-kubeconfig
example configures your kubectl by creating or updating the kubeconfig (with role-arn option to assume a role for cluster authentication) so that you can connect to an Amazon EKS Cluster named my-eks-cluster.
aws eks update-kubeconfig \
--name my-eks-cluster \
--role-arn arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM
Output:
Updated context arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster in /Users/xxx/.kube/config
For more information, see Creating or updating a kubeconfig file for an Amazon EKS cluster in the Amazon EKS User Guide.
Example 3: Configures your kubectl by creating or updating the kubeconfig (with role-arn option to assume a role for cluster authentication along with custom cluster alias and user-alias) so that you can connect to an Amazon EKS Cluster named `my-eks-cluster`
The following update-kubeconfig
example configures your kubectl by creating or updating the kubeconfig (with role-arn option to assume a role for cluster authentication along with custom cluster alias and user-alias) so that you can connect to an Amazon EKS Cluster named my-eks-cluster.
aws eks update-kubeconfig \
--name my-eks-cluster \
--role-arn arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM \
--alias stage-eks-cluster \
--user-alias john
Output:
Updated context stage-eks-cluster in /Users/dubaria/.kube/config
For more information, see Creating or updating a kubeconfig file for an Amazon EKS cluster in the Amazon EKS User Guide.
Example 4: Print kubeconfig file entries for review and configures your kubectl so that you can connect to an Amazon EKS Cluster named `my-eks-cluster`
The following update-kubeconfig
example configures your kubectl by creating or updating the kubeconfig (with role-arn option to assume a role for cluster authentication along with custom cluster alias and user-alias) so that you can connect to an Amazon EKS Cluster named my-eks-cluster.
aws eks update-kubeconfig \
--name my-eks-cluster \
--role-arn arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM \
--alias stage-eks-cluster \
--user-alias john \
--verbose
Output:
Updated context stage-eks-cluster in /Users/dubaria/.kube/config
Entries:
context:
cluster: arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster
user: john
name: stage-eks-cluster
name: john
user:
exec:
apiVersion: client.authentication.k8s.io/v1beta1
args:
- --region
- us-east-2
- eks
- get-token
- --cluster-name
- my-eks-cluster
- --output
- json
- --role
- arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM
command: aws
cluster:
certificate-authority-data: xxx_CA_DATA_xxx
server: https://DALSJ343KE23J3RN45653DSKJTT647TYD.yl4.us-east-2.eks.amazonaws.com
name: arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster
For more information, see Creating or updating a kubeconfig file for an Amazon EKS cluster in the Amazon EKS User Guide.