Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. eks
  5. getAddon
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.eks.getAddon

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Retrieve information about an EKS add-on.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.eks.getAddon({
    addonName: "vpc-cni",
    clusterName: exampleAwsEksCluster.name,
});
export const eksAddonOutputs = exampleAwsEksAddon;

    import pulumi
import pulumi_aws as aws

example = aws.eks.get_addon(addon_name="vpc-cni",
    cluster_name=example_aws_eks_cluster["name"])
pulumi.export("eksAddonOutputs", example_aws_eks_addon)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/eks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := eks.LookupAddon(ctx, &eks.LookupAddonArgs{
			AddonName:   "vpc-cni",
			ClusterName: exampleAwsEksCluster.Name,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("eksAddonOutputs", exampleAwsEksAddon)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Eks.GetAddon.Invoke(new()
    {
        AddonName = "vpc-cni",
        ClusterName = exampleAwsEksCluster.Name,
    });

    return new Dictionary<string, object?>
    {
        ["eksAddonOutputs"] = exampleAwsEksAddon,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.eks.EksFunctions;
import com.pulumi.aws.eks.inputs.GetAddonArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = EksFunctions.getAddon(GetAddonArgs.builder()
            .addonName("vpc-cni")
            .clusterName(exampleAwsEksCluster.name())
            .build());

        ctx.export("eksAddonOutputs", exampleAwsEksAddon);
    }
}

    variables:
  example:
    fn::invoke:
      function: aws:eks:getAddon
      arguments:
        addonName: vpc-cni
        clusterName: ${exampleAwsEksCluster.name}
outputs:
  eksAddonOutputs: ${exampleAwsEksAddon}

    Using getAddon

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAddon(args: GetAddonArgs, opts?: InvokeOptions): Promise<GetAddonResult>
function getAddonOutput(args: GetAddonOutputArgs, opts?: InvokeOptions): Output<GetAddonResult>
    def get_addon(addon_name: Optional[str] = None,
              cluster_name: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              opts: Optional[InvokeOptions] = None) -> GetAddonResult
def get_addon_output(addon_name: Optional[pulumi.Input[str]] = None,
              cluster_name: Optional[pulumi.Input[str]] = None,
              tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAddonResult]
    func LookupAddon(ctx *Context, args *LookupAddonArgs, opts ...InvokeOption) (*LookupAddonResult, error)
func LookupAddonOutput(ctx *Context, args *LookupAddonOutputArgs, opts ...InvokeOption) LookupAddonResultOutput

    > Note: This function is named LookupAddon in the Go SDK.

    public static class GetAddon 
{
    public static Task<GetAddonResult> InvokeAsync(GetAddonArgs args, InvokeOptions? opts = null)
    public static Output<GetAddonResult> Invoke(GetAddonInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAddonResult> getAddon(GetAddonArgs args, InvokeOptions options)
public static Output<GetAddonResult> getAddon(GetAddonArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:eks/getAddon:getAddon
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AddonName string
    Name of the EKS add-on. The name must match one of the names returned by list-addon.
    ClusterName string
    Name of the EKS Cluster.
    Tags Dictionary<string, string>
    AddonName string
    Name of the EKS add-on. The name must match one of the names returned by list-addon.
    ClusterName string
    Name of the EKS Cluster.
    Tags map[string]string
    addonName String
    Name of the EKS add-on. The name must match one of the names returned by list-addon.
    clusterName String
    Name of the EKS Cluster.
    tags Map<String,String>
    addonName string
    Name of the EKS add-on. The name must match one of the names returned by list-addon.
    clusterName string
    Name of the EKS Cluster.
    tags {[key: string]: string}
    addon_name str
    Name of the EKS add-on. The name must match one of the names returned by list-addon.
    cluster_name str
    Name of the EKS Cluster.
    tags Mapping[str, str]
    addonName String
    Name of the EKS add-on. The name must match one of the names returned by list-addon.
    clusterName String
    Name of the EKS Cluster.
    tags Map<String>

    getAddon Result

    The following output properties are available:

    AddonName string
    AddonVersion string
    Version of EKS add-on.
    Arn string
    ARN of the EKS add-on.
    ClusterName string
    ConfigurationValues string
    Configuration values for the addon with a single JSON string.
    CreatedAt string
    Date and time in RFC3339 format that the EKS add-on was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedAt string
    Date and time in RFC3339 format that the EKS add-on was updated.
    PodIdentityAssociations List<GetAddonPodIdentityAssociation>
    Pod identity association for the EKS add-on.
    ServiceAccountRoleArn string
    ARN of IAM role used for EKS add-on. If value is empty - then add-on uses the IAM role assigned to the EKS Cluster node.
    Tags Dictionary<string, string>
    AddonName string
    AddonVersion string
    Version of EKS add-on.
    Arn string
    ARN of the EKS add-on.
    ClusterName string
    ConfigurationValues string
    Configuration values for the addon with a single JSON string.
    CreatedAt string
    Date and time in RFC3339 format that the EKS add-on was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedAt string
    Date and time in RFC3339 format that the EKS add-on was updated.
    PodIdentityAssociations []GetAddonPodIdentityAssociation
    Pod identity association for the EKS add-on.
    ServiceAccountRoleArn string
    ARN of IAM role used for EKS add-on. If value is empty - then add-on uses the IAM role assigned to the EKS Cluster node.
    Tags map[string]string
    addonName String
    addonVersion String
    Version of EKS add-on.
    arn String
    ARN of the EKS add-on.
    clusterName String
    configurationValues String
    Configuration values for the addon with a single JSON string.
    createdAt String
    Date and time in RFC3339 format that the EKS add-on was created.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedAt String
    Date and time in RFC3339 format that the EKS add-on was updated.
    podIdentityAssociations List<GetAddonPodIdentityAssociation>
    Pod identity association for the EKS add-on.
    serviceAccountRoleArn String
    ARN of IAM role used for EKS add-on. If value is empty - then add-on uses the IAM role assigned to the EKS Cluster node.
    tags Map<String,String>
    addonName string
    addonVersion string
    Version of EKS add-on.
    arn string
    ARN of the EKS add-on.
    clusterName string
    configurationValues string
    Configuration values for the addon with a single JSON string.
    createdAt string
    Date and time in RFC3339 format that the EKS add-on was created.
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedAt string
    Date and time in RFC3339 format that the EKS add-on was updated.
    podIdentityAssociations GetAddonPodIdentityAssociation[]
    Pod identity association for the EKS add-on.
    serviceAccountRoleArn string
    ARN of IAM role used for EKS add-on. If value is empty - then add-on uses the IAM role assigned to the EKS Cluster node.
    tags {[key: string]: string}
    addon_name str
    addon_version str
    Version of EKS add-on.
    arn str
    ARN of the EKS add-on.
    cluster_name str
    configuration_values str
    Configuration values for the addon with a single JSON string.
    created_at str
    Date and time in RFC3339 format that the EKS add-on was created.
    id str
    The provider-assigned unique ID for this managed resource.
    modified_at str
    Date and time in RFC3339 format that the EKS add-on was updated.
    pod_identity_associations Sequence[GetAddonPodIdentityAssociation]
    Pod identity association for the EKS add-on.
    service_account_role_arn str
    ARN of IAM role used for EKS add-on. If value is empty - then add-on uses the IAM role assigned to the EKS Cluster node.
    tags Mapping[str, str]
    addonName String
    addonVersion String
    Version of EKS add-on.
    arn String
    ARN of the EKS add-on.
    clusterName String
    configurationValues String
    Configuration values for the addon with a single JSON string.
    createdAt String
    Date and time in RFC3339 format that the EKS add-on was created.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedAt String
    Date and time in RFC3339 format that the EKS add-on was updated.
    podIdentityAssociations List<Property Map>
    Pod identity association for the EKS add-on.
    serviceAccountRoleArn String
    ARN of IAM role used for EKS add-on. If value is empty - then add-on uses the IAM role assigned to the EKS Cluster node.
    tags Map<String>

    Supporting Types

    GetAddonPodIdentityAssociation

    RoleArn string
    ARN of the IAM role associated with the EKS add-on.
    ServiceAccount string
    Service account associated with the EKS add-on.
    RoleArn string
    ARN of the IAM role associated with the EKS add-on.
    ServiceAccount string
    Service account associated with the EKS add-on.
    roleArn String
    ARN of the IAM role associated with the EKS add-on.
    serviceAccount String
    Service account associated with the EKS add-on.
    roleArn string
    ARN of the IAM role associated with the EKS add-on.
    serviceAccount string
    Service account associated with the EKS add-on.
    role_arn str
    ARN of the IAM role associated with the EKS add-on.
    service_account str
    Service account associated with the EKS add-on.
    roleArn String
    ARN of the IAM role associated with the EKS add-on.
    serviceAccount String
    Service account associated with the EKS add-on.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws