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.
Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with DescribeUpdate
"/>.
You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the * Amazon EKS User Guide * .
You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the * Amazon EKS User Guide * .
You can also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the * Amazon EKS User Guide * .
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING
(this status transition is eventually consistent). When the update is complete (either Failed
or Successful
), the cluster status moves to Active
.
See also: AWS API Documentation
update-cluster-config
--name <value>
[--resources-vpc-config <value>]
[--logging <value>]
[--client-request-token <value>]
[--access-config <value>]
[--upgrade-policy <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <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 Amazon EKS cluster to update.
--resources-vpc-config
(structure)
An object representing the VPC configuration to use for an Amazon EKS cluster.
subnetIds -> (list)
Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
(string)
securityGroupIds -> (list)
Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes. For more information, see Amazon EKS security group considerations in the * Amazon EKS User Guide * .
(string)
endpointPublicAccess -> (boolean)
Set this value tofalse
to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter istrue
, which enables public access for your Kubernetes API server. For more information, see Amazon EKS cluster endpoint access control in the * Amazon EKS User Guide * .endpointPrivateAccess -> (boolean)
Set this value totrue
to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter isfalse
, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or Fargate pods in the cluster, then ensure thatpublicAccessCidrs
includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the * Amazon EKS User Guide * .publicAccessCidrs -> (list)
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is
0.0.0.0/0
. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and FargatePod
in the cluster. For more information, see Amazon EKS cluster endpoint access control in the * Amazon EKS User Guide * .(string)
Shorthand Syntax:
subnetIds=string,string,securityGroupIds=string,string,endpointPublicAccess=boolean,endpointPrivateAccess=boolean,publicAccessCidrs=string,string
JSON Syntax:
{
"subnetIds": ["string", ...],
"securityGroupIds": ["string", ...],
"endpointPublicAccess": true|false,
"endpointPrivateAccess": true|false,
"publicAccessCidrs": ["string", ...]
}
--logging
(structure)
Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS cluster control plane logs in the * Amazon EKS User Guide * .
Note
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing .clusterLogging -> (list)
The cluster control plane logging configuration for your cluster.
(structure)
An object representing the enabled or disabled Kubernetes control plane logs for your cluster.
types -> (list)
The available cluster control plane log types.
(string)
enabled -> (boolean)
If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.
JSON Syntax:
{
"clusterLogging": [
{
"types": ["api"|"audit"|"authenticator"|"controllerManager"|"scheduler", ...],
"enabled": true|false
}
...
]
}
--client-request-token
(string)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
--access-config
(structure)
The access configuration for the cluster.
authenticationMode -> (string)
The desired authentication mode for the cluster.
Shorthand Syntax:
authenticationMode=string
JSON Syntax:
{
"authenticationMode": "API"|"API_AND_CONFIG_MAP"|"CONFIG_MAP"
}
--upgrade-policy
(structure)
You can enable or disable extended support for clusters currently on standard support. You cannot disable extended support once it starts. You must enable extended support before your cluster exits standard support.
supportType -> (string)
If the cluster is set to
EXTENDED
, it will enter extended support at the end of standard support. If the cluster is set toSTANDARD
, it will be automatically upgraded at the end of standard support.
Shorthand Syntax:
supportType=string
JSON Syntax:
{
"supportType": "STANDARD"|"EXTENDED"
}
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--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 .
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": []
}
}
update -> (structure)
An object representing an asynchronous update.
id -> (string)
A UUID that is used to track the update.status -> (string)
The current status of the update.type -> (string)
The type of the update.params -> (list)
A key-value map that contains the parameters associated with the update.
(structure)
An object representing the details of an update request.
type -> (string)
The keys associated with an update request.value -> (string)
The value of the keys submitted as part of an update request.createdAt -> (timestamp)
The Unix epoch timestamp at object creation.errors -> (list)
Any errors associated with a
Failed
update.(structure)
An object representing an error when an asynchronous operation fails.
errorCode -> (string)
A brief description of the error.
- SubnetNotFound : We couldn't find one of the subnets associated with the cluster.
- SecurityGroupNotFound : We couldn't find one of the security groups associated with the cluster.
- EniLimitReached : You have reached the elastic network interface limit for your account.
- IpNotAvailable : A subnet associated with the cluster doesn't have any available IP addresses.
- AccessDenied : You don't have permissions to perform the specified operation.
- OperationNotPermitted : The service role associated with the cluster doesn't have the required access permissions for Amazon EKS.
- VpcIdNotFound : We couldn't find the VPC associated with the cluster.
errorMessage -> (string)
A more complete description of the error.resourceIds -> (list)
An optional field that contains the resource IDs associated with the error.
(string)