POST

/clusters/{name}/addons/{addonName}/update

http://eks.{region}.amazonaws.com/clusters/{name}/addons/{addonName}/update

Updates an Amazon EKS add-on.

Access Token Required: API Key

Path Parameters

namestringrequired

The name of the cluster.

addonNamestringrequired

The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html"> <code>ListAddons</code> </a>.

Body Params

addonVersionstring

The version of the add-on. The version must match one of the versions returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html"> <code>DescribeAddonVersions</code> </a>.

resolveConflictsstring

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: <ul> <li> None – Amazon EKS doesn't change the value. The update might fail. </li> <li> Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS default value. </li> <li> 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. </li> </ul>

clientRequestTokenstring

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

configurationValuesstring

The set of configuration values for the add-on that's created. The values that you provide are validated against the schema in <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonConfiguration.html">DescribeAddonConfiguration</a>.

serviceAccountRoleArnstring

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 <a href="https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html">Amazon EKS node IAM role</a> in the Amazon EKS User Guide. <note> To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html">Enabling IAM roles for service accounts on your cluster</a> in the Amazon EKS User Guide. </note>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://eks.{region}.amazonaws.com/clusters/{name}/addons/{addonName}/update' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request POST \ 2 --url 'http://eks.{region}.amazonaws.com/clusters/{name}/addons/{addonName}/update' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'