update-addon --cluster-name <value> --addon-name <value> [--addon-version <value>] [--service-account-role-arn <value>] [--resolve-conflicts <value>] [--client-request-token <value>] [--configuration-values <value>] [--cli-input-json | --cli-input-yaml] [--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>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
The name of the cluster.
The name of the add-on. The name must match one of the names returned by `
The version of the add-on. The version must match one of the versions returned by `
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on’s service account. The role must be assigned the IAM permissions required by the add-on. If you don’t specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide .
NoteTo specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide .
How to resolve field value conflicts for an Amazon EKS add-on if you’ve changed a value from the Amazon EKS default value. Conflicts are handled based on the option you choose:
- None – Amazon EKS doesn’t change the value. The update might fail.
- Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS default value.
- Preserve – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add-on on your production cluster.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
The set of configuration values for the add-on that’s created. The values that you provide are validated against the schema in DescribeAddonConfiguration .
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with
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. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
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.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
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.
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.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
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.
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 in seconds for when the update was created.
errors -> (list)
Any errors associated with a
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 free 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.