addons

Creates, updates, deletes or gets an addon resource or lists addons in a region

Overview

Name	addons
Type	Resource
Description	Resource Schema for AWS::EKS::Addon
Id	aws.eks.addons

Fields

Name	Datatype	Description
cluster_name	string	Name of Cluster
addon_name	string	Name of Addon
addon_version	string	Version of Addon
preserve_on_delete	boolean	PreserveOnDelete parameter value
resolve_conflicts	string	Resolve parameter value conflicts
service_account_role_arn	string	IAM role to bind to the add-on's service account
pod_identity_associations	array	An array of pod identities to apply to this add-on.
configuration_values	string	The configuration values to use with the add-on
arn	string	Amazon Resource Name (ARN) of the add-on
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ClusterName, AddonName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all addons in a region.

SELECT
region,
cluster_name,
addon_name,
addon_version,
preserve_on_delete,
resolve_conflicts,
service_account_role_arn,
pod_identity_associations,
configuration_values,
arn,
tags
FROM aws.eks.addons
WHERE region = 'us-east-1';

Gets all properties from an individual addon.

SELECT
region,
cluster_name,
addon_name,
addon_version,
preserve_on_delete,
resolve_conflicts,
service_account_role_arn,
pod_identity_associations,
configuration_values,
arn,
tags
FROM aws.eks.addons
WHERE region = 'us-east-1' AND data__Identifier = '<ClusterName>|<AddonName>';

INSERT example

Use the following StackQL query and manifest file to create a new addon resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.eks.addons (
 ClusterName,
 AddonName,
 region
)
SELECT 
'{{ ClusterName }}',
 '{{ AddonName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.eks.addons (
 ClusterName,
 AddonName,
 AddonVersion,
 PreserveOnDelete,
 ResolveConflicts,
 ServiceAccountRoleArn,
 PodIdentityAssociations,
 ConfigurationValues,
 Tags,
 region
)
SELECT 
 '{{ ClusterName }}',
 '{{ AddonName }}',
 '{{ AddonVersion }}',
 '{{ PreserveOnDelete }}',
 '{{ ResolveConflicts }}',
 '{{ ServiceAccountRoleArn }}',
 '{{ PodIdentityAssociations }}',
 '{{ ConfigurationValues }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: addon
    props:
      - name: ClusterName
        value: '{{ ClusterName }}'
      - name: AddonName
        value: '{{ AddonName }}'
      - name: AddonVersion
        value: '{{ AddonVersion }}'
      - name: PreserveOnDelete
        value: '{{ PreserveOnDelete }}'
      - name: ResolveConflicts
        value: '{{ ResolveConflicts }}'
      - name: ServiceAccountRoleArn
        value: '{{ ServiceAccountRoleArn }}'
      - name: PodIdentityAssociations
        value:
          - ClusterName: '{{ ClusterName }}'
            RoleArn: '{{ RoleArn }}'
            Namespace: '{{ Namespace }}'
            ServiceAccount: '{{ ServiceAccount }}'
            Tags:
              - Key: '{{ Key }}'
                Value: '{{ Value }}'
      - name: ConfigurationValues
        value: '{{ ConfigurationValues }}'
      - name: Tags
        value:
          - null

DELETE example

/*+ delete */
DELETE FROM aws.eks.addons
WHERE data__Identifier = '<ClusterName|AddonName>'
AND region = 'us-east-1';

Permissions

To operate on the addons resource, the following permissions are required:

Create

eks:CreateAddon,
eks:DescribeAddon,
eks:TagResource,
iam:PassRole,
iam:GetRole,
eks:CreatePodIdentityAssociation

Read

eks:DescribeAddon

Delete

eks:DeleteAddon,
eks:DescribeAddon,
eks:DeletePodIdentityAssociation

List

eks:ListAddons

Update

iam:PassRole,
iam:GetRole,
eks:UpdateAddon,
eks:DescribeAddon,
eks:DescribeUpdate,
eks:ListTagsForResource,
eks:TagResource,
eks:UntagResource,
eks:CreatePodIdentityAssociation,
eks:DeletePodIdentityAssociation