• Public
  • Public/Protected
  • All

Interface CreateAddonRequest





addonName: string | undefined

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

Optional addonVersion

addonVersion: undefined | string

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

Optional clientRequestToken

clientRequestToken: undefined | string

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


clusterName: string | undefined

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

Optional configurationValues

configurationValues: undefined | string

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

Optional resolveConflicts

resolveConflicts: ResolveConflicts | string

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.

Optional serviceAccountRoleArn

serviceAccountRoleArn: undefined | string

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.

Optional tags

tags: Record<string, string>

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.