This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::EKS::Addon
<a name="aws-resource-eks-addon"></a>

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](https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the *Amazon EKS User Guide*.

## Syntax
<a name="aws-resource-eks-addon-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-eks-addon-syntax.json"></a>

```
{
  "Type" : "AWS::EKS::Addon",
  "Properties" : {
      "[AddonName](#cfn-eks-addon-addonname)" : String,
      "[AddonVersion](#cfn-eks-addon-addonversion)" : String,
      "[ClusterName](#cfn-eks-addon-clustername)" : String,
      "[ConfigurationValues](#cfn-eks-addon-configurationvalues)" : String,
      "[NamespaceConfig](#cfn-eks-addon-namespaceconfig)" : NamespaceConfig,
      "[PodIdentityAssociations](#cfn-eks-addon-podidentityassociations)" : [ PodIdentityAssociation, ... ],
      "[PreserveOnDelete](#cfn-eks-addon-preserveondelete)" : Boolean,
      "[ResolveConflicts](#cfn-eks-addon-resolveconflicts)" : String,
      "[ServiceAccountRoleArn](#cfn-eks-addon-serviceaccountrolearn)" : String,
      "[Tags](#cfn-eks-addon-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-eks-addon-syntax.yaml"></a>

```
Type: AWS::EKS::Addon
Properties:
  [AddonName](#cfn-eks-addon-addonname): String
  [AddonVersion](#cfn-eks-addon-addonversion): String
  [ClusterName](#cfn-eks-addon-clustername): String
  [ConfigurationValues](#cfn-eks-addon-configurationvalues): String
  [NamespaceConfig](#cfn-eks-addon-namespaceconfig): 
    NamespaceConfig
  [PodIdentityAssociations](#cfn-eks-addon-podidentityassociations): 
    - PodIdentityAssociation
  [PreserveOnDelete](#cfn-eks-addon-preserveondelete): Boolean
  [ResolveConflicts](#cfn-eks-addon-resolveconflicts): String
  [ServiceAccountRoleArn](#cfn-eks-addon-serviceaccountrolearn): String
  [Tags](#cfn-eks-addon-tags): 
    - Tag
```

## Properties
<a name="aws-resource-eks-addon-properties"></a>

`AddonName`  <a name="cfn-eks-addon-addonname"></a>
The name of the add-on.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`AddonVersion`  <a name="cfn-eks-addon-addonversion"></a>
The version of the add-on.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClusterName`  <a name="cfn-eks-addon-clustername"></a>
The name of your cluster.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ConfigurationValues`  <a name="cfn-eks-addon-configurationvalues"></a>
The configuration values that you provided.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceConfig`  <a name="cfn-eks-addon-namespaceconfig"></a>
The namespace configuration for the addon. This specifies the Kubernetes namespace where the addon is installed.  
*Required*: No  
*Type*: [NamespaceConfig](aws-properties-eks-addon-namespaceconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PodIdentityAssociations`  <a name="cfn-eks-addon-podidentityassociations"></a>
An array of EKS Pod Identity associations owned by the add-on. Each association maps a role to a service account in a namespace in the cluster.  
For more information, see [Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity](https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html) in the *Amazon EKS User Guide*.  
*Required*: No  
*Type*: Array of [PodIdentityAssociation](aws-properties-eks-addon-podidentityassociation.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PreserveOnDelete`  <a name="cfn-eks-addon-preserveondelete"></a>
Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it isn't removed.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResolveConflicts`  <a name="cfn-eks-addon-resolveconflicts"></a>
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** – This is similar to the NONE option. If the self-managed version of the add-on is installed on your cluster Amazon EKS doesn't change the add-on resource properties. Creation of the add-on might fail if conflicts are detected. This option works differently during the update operation. For more information, see [https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html).
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.  
*Required*: No  
*Type*: String  
*Allowed values*: `NONE | OVERWRITE | PRESERVE`  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServiceAccountRoleArn`  <a name="cfn-eks-addon-serviceaccountrolearn"></a>
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](https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) 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](https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) in the *Amazon EKS User Guide*.
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-eks-addon-tags"></a>
The metadata that you apply to the add-on to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Add-on tags do not propagate to any other resources associated with the cluster.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-eks-addon-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-eks-addon-return-values"></a>

### Ref
<a name="aws-resource-eks-addon-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:

 `{ "Ref": "vpc-cni" }` 

For the add-on `vpc-cni`, `Ref` returns the name of the add-on. For example, `cluster-name|vpc-cni`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-eks-addon-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-eks-addon-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the add-on, such as `arn:aws:eks:us-west-2:111122223333:addon/1-19/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`.

## See also
<a name="aws-resource-eks-addon--seealso"></a>
+ [Amazon EKS add-ons](https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the *Amazon EKS User Guide*.
+ [https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateAddon.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateAddon.html) in the *Amazon EKS API Reference*.