CreateAddon - Amazon EKS
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.


Creates an Amazon EKS add-on.

Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

Request Syntax

POST /clusters/name/addons HTTP/1.1 Content-type: application/json { "addonName": "string", "addonVersion": "string", "clientRequestToken": "string", "configurationValues": "string", "resolveConflicts": "string", "serviceAccountRoleArn": "string", "tags": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.


The name of the cluster to create the add-on for.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z][A-Za-z0-9\-_]*

Required: Yes

Request Body

The request accepts the following data in JSON format.


The name of the add-on. The name must match one of the names that DescribeAddonVersions returns.

Type: String

Required: Yes


The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions.

Type: String

Required: No


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

Type: String

Required: No


The set of configuration values for the add-on that's created. The values that you provide are validated against the schema in DescribeAddonConfiguration.

Type: String

Required: No


How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are handled based on the value you choose:

  • None – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail.

  • Overwrite – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value.

  • Preserve – Not supported. You can set this value when updating an add-on though. For more information, see UpdateAddon.

If you don't currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify.

Type: String


Required: No


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.


To 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No


The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "addon": { "addonArn": "string", "addonName": "string", "addonVersion": "string", "clusterName": "string", "configurationValues": "string", "createdAt": number, "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "marketplaceInformation": { "productId": "string", "productUrl": "string" }, "modifiedAt": number, "owner": "string", "publisher": "string", "serviceAccountRoleArn": "string", "status": "string", "tags": { "string" : "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

Type: Addon object


For information about the errors that are common to all actions, see Common Errors.


These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

HTTP Status Code: 400


The specified parameter is invalid. Review the available parameters for the API request.

HTTP Status Code: 400


The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

HTTP Status Code: 400


The specified resource is in use.

HTTP Status Code: 409


The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

HTTP Status Code: 404


These errors are usually caused by a server-side issue.

HTTP Status Code: 500


In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an Amazon Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the Amazon EKS General Reference.

You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the Amazon Command Line Interface (Amazon CLI) or one of the Amazon SDKs to make requests to Amazon, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.


The following example creates an add-on named vpc-cni. The add-on uses an existing IAM role named AmazonEKSCNIRole. If the add-on existed prior to creating the Amazon EKS add-on, its settings are overwritten with the Amazon EKS add-on's settings.

Sample Request

POST /clusters/1-18/addons HTTP/1.1 Host: Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20201125T143943Z Authorization: AUTHPARAMS Content-Length: 195 { "addonName": "vpc-cni", "serviceAccountRoleArn": "arn:aws:iam::012345678910:role/AmazonEKSCNIRole", "resolveConflicts": "overwrite", "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }

Sample Response

HTTP/1.1 200 OK Date: Wed, 25 Nov 2020 14:39:44 GMT Content-Type: application/json Content-Length: 474 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: WkXriGcavHcFyqw= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "addon" : { "addonName" : "vpc-cni", "clusterName" : "1-18", "status" : "CREATING", "addonVersion" : "v1.7.5-eksbuild.1", "health" : { "issues" : [ ] }, "addonArn" : "arn:aws:eks:us-west-2:012345678910:addon/1-18/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "createdAt" : 1.606315184255E9, "modifiedAt" : 1.606315184274E9, "serviceAccountRoleArn" : "arn:aws:iam::012345678910:role/AmazonEKSCNIRole", "tags" : { } } }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: