AccessEntry class

Access Entry Configurations for an EKS Cluster.

Example Usage

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

const example = new aws.eks.AccessEntry("example", {
    clusterName: exampleAwsEksCluster.name,
    principalArn: exampleAwsIamRole.arn,
    kubernetesGroups: [
        "group-1",
        "group-2",
    ],
    type: "STANDARD",
});
import pulumi
import pulumi_aws as aws

example = aws.eks.AccessEntry("example",
    cluster_name=example_aws_eks_cluster["name"],
    principal_arn=example_aws_iam_role["arn"],
    kubernetes_groups=[
        "group-1",
        "group-2",
    ],
    type="STANDARD")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Eks.AccessEntry("example", new()
    {
        ClusterName = exampleAwsEksCluster.Name,
        PrincipalArn = exampleAwsIamRole.Arn,
        KubernetesGroups = new[]
        {
            "group-1",
            "group-2",
        },
        Type = "STANDARD",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := eks.NewAccessEntry(ctx, "example", &eks.AccessEntryArgs{
			ClusterName:  pulumi.Any(exampleAwsEksCluster.Name),
			PrincipalArn: pulumi.Any(exampleAwsIamRole.Arn),
			KubernetesGroups: pulumi.StringArray{
				pulumi.String("group-1"),
				pulumi.String("group-2"),
			},
			Type: pulumi.String("STANDARD"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_eks_accessentry" "example" {
  cluster_name      = exampleAwsEksCluster.name
  principal_arn     = exampleAwsIamRole.arn
  kubernetes_groups = ["group-1", "group-2"]
  type              = "STANDARD"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.eks.AccessEntry;
import com.pulumi.aws.eks.AccessEntryArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var example = new AccessEntry("example", AccessEntryArgs.builder()
            .clusterName(exampleAwsEksCluster.name())
            .principalArn(exampleAwsIamRole.arn())
            .kubernetesGroups(
                "group-1",
                "group-2")
            .type("STANDARD")
            .build());

    }
}
resources:
  example:
    type: aws:eks:AccessEntry
    properties:
      clusterName: ${exampleAwsEksCluster.name}
      principalArn: ${exampleAwsIamRole.arn}
      kubernetesGroups:
        - group-1
        - group-2
      type: STANDARD

Import

Identity Schema

Required

  • clusterName (String) Name of the EKS Cluster.
  • principalArn (String) IAM principal ARN.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import Access Entries using clusterName and principalArn separated by a colon (:). For example:

$ pulumi import aws:eks/accessEntry:AccessEntry example example-cluster:arn:aws:iam::123456789012:role/example

Constructors

AccessEntry(String name, {AccessEntryArgs? args, CustomResourceOptions? options})
Creates a new AccessEntry. name The Pulumi resource name. args Arguments used to configure this AccessEntry. The set of arguments for AccessEntry. options Resource options controlling this resource's behavior.
AccessEntry.reference(String urn)
Creates a typed reference to an existing AccessEntry resource.

Properties

accessEntryArn ↔ Output<String>
ARN of the Access Entry.
latefinal
childResources → Set<Resource>
finalinherited
clusterName ↔ Output<String>
Name of the EKS Cluster.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdAt ↔ Output<String>
Date and time in RFC3339 format that the EKS add-on was created.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
kubernetesGroups ↔ Output<List<String>>
List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry.
latefinal
modifiedAt ↔ Output<String>
Date and time in RFC3339 format that the EKS add-on was updated.
latefinal
principalArn ↔ Output<String>
The IAM Principal ARN which requires Authentication access to the EKS cluster.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
(Optional) Key-value map of resource tags, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<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.
latefinal
urn ↔ Output<String>
latefinalinherited
userName ↔ Output<String>
Defaults to principal ARN if user is principal else defaults to assume-role/session-name is role is used.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {AccessEntryState? state, CustomResourceOptions? options}) → AccessEntry
Gets an existing AccessEntry resource's state with the given name and id.