Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. eks
  5. getAccessEntry

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.eks.getAccessEntry

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Access Entry Configurations for an EKS Cluster.

    Example Usage

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

const example = aws.eks.getAccessEntry({
    clusterName: exampleAwsEksCluster.name,
    principalArn: exampleAwsIamRole.arn,
});
export const eksAccessEntryOutputs = exampleAwsEksAccessEntry;

    import pulumi
import pulumi_aws as aws

example = aws.eks.get_access_entry(cluster_name=example_aws_eks_cluster["name"],
    principal_arn=example_aws_iam_role["arn"])
pulumi.export("eksAccessEntryOutputs", example_aws_eks_access_entry)

    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.LookupAccessEntry(ctx, &eks.LookupAccessEntryArgs{
			ClusterName:  exampleAwsEksCluster.Name,
			PrincipalArn: exampleAwsIamRole.Arn,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("eksAccessEntryOutputs", exampleAwsEksAccessEntry)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Aws.Eks.GetAccessEntry.Invoke(new()
    {
        ClusterName = exampleAwsEksCluster.Name,
        PrincipalArn = exampleAwsIamRole.Arn,
    });

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

    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.GetAccessEntryArgs;
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.getAccessEntry(GetAccessEntryArgs.builder()
            .clusterName(exampleAwsEksCluster.name())
            .principalArn(exampleAwsIamRole.arn())
            .build());

        ctx.export("eksAccessEntryOutputs", exampleAwsEksAccessEntry);
    }
}

    variables:
  example:
    fn::invoke:
      Function: aws:eks:getAccessEntry
      Arguments:
        clusterName: ${exampleAwsEksCluster.name}
        principalArn: ${exampleAwsIamRole.arn}
outputs:
  eksAccessEntryOutputs: ${exampleAwsEksAccessEntry}

    Using getAccessEntry

    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 getAccessEntry(args: GetAccessEntryArgs, opts?: InvokeOptions): Promise<GetAccessEntryResult>
function getAccessEntryOutput(args: GetAccessEntryOutputArgs, opts?: InvokeOptions): Output<GetAccessEntryResult>
    def get_access_entry(cluster_name: Optional[str] = None,
                     principal_arn: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAccessEntryResult
def get_access_entry_output(cluster_name: Optional[pulumi.Input[str]] = None,
                     principal_arn: Optional[pulumi.Input[str]] = None,
                     tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAccessEntryResult]
    func LookupAccessEntry(ctx *Context, args *LookupAccessEntryArgs, opts ...InvokeOption) (*LookupAccessEntryResult, error)
func LookupAccessEntryOutput(ctx *Context, args *LookupAccessEntryOutputArgs, opts ...InvokeOption) LookupAccessEntryResultOutput

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

    public static class GetAccessEntry 
{
    public static Task<GetAccessEntryResult> InvokeAsync(GetAccessEntryArgs args, InvokeOptions? opts = null)
    public static Output<GetAccessEntryResult> Invoke(GetAccessEntryInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAccessEntryResult> getAccessEntry(GetAccessEntryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    ClusterName string
    Name of the EKS Cluster.
    PrincipalArn string
    The IAM Principal ARN which requires Authentication access to the EKS cluster.
    Tags Dictionary<string, string>
    ClusterName string
    Name of the EKS Cluster.
    PrincipalArn string
    The IAM Principal ARN which requires Authentication access to the EKS cluster.
    Tags map[string]string
    clusterName String
    Name of the EKS Cluster.
    principalArn String
    The IAM Principal ARN which requires Authentication access to the EKS cluster.
    tags Map<String,String>
    clusterName string
    Name of the EKS Cluster.
    principalArn string
    The IAM Principal ARN which requires Authentication access to the EKS cluster.
    tags {[key: string]: string}
    cluster_name str
    Name of the EKS Cluster.
    principal_arn str
    The IAM Principal ARN which requires Authentication access to the EKS cluster.
    tags Mapping[str, str]
    clusterName String
    Name of the EKS Cluster.
    principalArn String
    The IAM Principal ARN which requires Authentication access to the EKS cluster.
    tags Map<String>

    getAccessEntry Result

    The following output properties are available:

    AccessEntryArn string
    Amazon Resource Name (ARN) of the Access Entry.
    ClusterName 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.
    KubernetesGroups List<string>
    List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry.
    ModifiedAt string
    Date and time in RFC3339 format that the EKS add-on was updated.
    PrincipalArn string
    TagsAll Dictionary<string, string>
    (Optional) Key-value map of resource tags, including those inherited from the provider default_tags configuration block.
    Type string
    Defaults to STANDARD which provides the standard workflow. EC2_LINUX, EC2_WINDOWS, FARGATE_LINUX types disallow users to input a username or groups, and prevent associations.
    UserName string
    Defaults to principal ARN if user is principal else defaults to assume-role/session-name is role is used.
    Tags Dictionary<string, string>
    AccessEntryArn string
    Amazon Resource Name (ARN) of the Access Entry.
    ClusterName 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.
    KubernetesGroups []string
    List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry.
    ModifiedAt string
    Date and time in RFC3339 format that the EKS add-on was updated.
    PrincipalArn string
    TagsAll map[string]string
    (Optional) Key-value map of resource tags, including those inherited from the provider default_tags configuration block.
    Type string
    Defaults to STANDARD which provides the standard workflow. EC2_LINUX, EC2_WINDOWS, FARGATE_LINUX types disallow users to input a username or groups, and prevent associations.
    UserName string
    Defaults to principal ARN if user is principal else defaults to assume-role/session-name is role is used.
    Tags map[string]string
    accessEntryArn String
    Amazon Resource Name (ARN) of the Access Entry.
    clusterName 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.
    kubernetesGroups List<String>
    List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry.
    modifiedAt String
    Date and time in RFC3339 format that the EKS add-on was updated.
    principalArn String
    tagsAll Map<String,String>
    (Optional) Key-value map of resource tags, including those inherited from the provider default_tags configuration block.
    type String
    Defaults to STANDARD which provides the standard workflow. EC2_LINUX, EC2_WINDOWS, FARGATE_LINUX types disallow users to input a username or groups, and prevent associations.
    userName String
    Defaults to principal ARN if user is principal else defaults to assume-role/session-name is role is used.
    tags Map<String,String>
    accessEntryArn string
    Amazon Resource Name (ARN) of the Access Entry.
    clusterName 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.
    kubernetesGroups string[]
    List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry.
    modifiedAt string
    Date and time in RFC3339 format that the EKS add-on was updated.
    principalArn string
    tagsAll {[key: string]: string}
    (Optional) Key-value map of resource tags, including those inherited from the provider default_tags configuration block.
    type string
    Defaults to STANDARD which provides the standard workflow. EC2_LINUX, EC2_WINDOWS, FARGATE_LINUX types disallow users to input a username or groups, and prevent associations.
    userName string
    Defaults to principal ARN if user is principal else defaults to assume-role/session-name is role is used.
    tags {[key: string]: string}
    access_entry_arn str
    Amazon Resource Name (ARN) of the Access Entry.
    cluster_name str
    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.
    kubernetes_groups Sequence[str]
    List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry.
    modified_at str
    Date and time in RFC3339 format that the EKS add-on was updated.
    principal_arn str
    tags_all Mapping[str, str]
    (Optional) Key-value map of resource tags, including those inherited from the provider default_tags configuration block.
    type str
    Defaults to STANDARD which provides the standard workflow. EC2_LINUX, EC2_WINDOWS, FARGATE_LINUX types disallow users to input a username or groups, and prevent associations.
    user_name str
    Defaults to principal ARN if user is principal else defaults to assume-role/session-name is role is used.
    tags Mapping[str, str]
    accessEntryArn String
    Amazon Resource Name (ARN) of the Access Entry.
    clusterName 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.
    kubernetesGroups List<String>
    List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry.
    modifiedAt String
    Date and time in RFC3339 format that the EKS add-on was updated.
    principalArn String
    tagsAll Map<String>
    (Optional) Key-value map of resource tags, including those inherited from the provider default_tags configuration block.
    type String
    Defaults to STANDARD which provides the standard workflow. EC2_LINUX, EC2_WINDOWS, FARGATE_LINUX types disallow users to input a username or groups, and prevent associations.
    userName String
    Defaults to principal ARN if user is principal else defaults to assume-role/session-name is role is used.
    tags Map<String>

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws