1. Packages
  2. AWS
  3. API Docs
  4. eks
  5. getClusterAuth
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
aws logo
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi

    Get an authentication token to communicate with an EKS cluster.

    Uses IAM credentials from the AWS provider to generate a temporary token that is compatible with AWS IAM Authenticator authentication. This can be used to authenticate to an EKS cluster or to a cluster that has the AWS IAM Authenticator server configured.

    Using getClusterAuth

    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 getClusterAuth(args: GetClusterAuthArgs, opts?: InvokeOptions): Promise<GetClusterAuthResult>
    function getClusterAuthOutput(args: GetClusterAuthOutputArgs, opts?: InvokeOptions): Output<GetClusterAuthResult>
    def get_cluster_auth(name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetClusterAuthResult
    def get_cluster_auth_output(name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetClusterAuthResult]
    func GetClusterAuth(ctx *Context, args *GetClusterAuthArgs, opts ...InvokeOption) (*GetClusterAuthResult, error)
    func GetClusterAuthOutput(ctx *Context, args *GetClusterAuthOutputArgs, opts ...InvokeOption) GetClusterAuthResultOutput

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

    public static class GetClusterAuth 
    {
        public static Task<GetClusterAuthResult> InvokeAsync(GetClusterAuthArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterAuthResult> Invoke(GetClusterAuthInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClusterAuthResult> getClusterAuth(GetClusterAuthArgs args, InvokeOptions options)
    public static Output<GetClusterAuthResult> getClusterAuth(GetClusterAuthArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws:eks/getClusterAuth:getClusterAuth
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the cluster
    Name string
    Name of the cluster
    name String
    Name of the cluster
    name string
    Name of the cluster
    name str
    Name of the cluster
    name String
    Name of the cluster

    getClusterAuth Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Token string
    Token to use to authenticate with the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Token string
    Token to use to authenticate with the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    token String
    Token to use to authenticate with the cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    token string
    Token to use to authenticate with the cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    token str
    Token to use to authenticate with the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    token String
    Token to use to authenticate with the cluster.

    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
    Viewing docs for AWS v5.43.0 (Older version)
    published on Tuesday, Mar 10, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.