Package com.pulumi.aws.eks

Class AccessEntry

  • public class AccessEntry
extends com.pulumi.resources.CustomResource
    Access Entry Configurations for an EKS Cluster. ## Example Usage 
     
 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());
 
     }
 }
    ## 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: ```sh $ pulumi import aws:eks/accessEntry:AccessEntry example example-cluster:arn:aws:iam::123456789012:role/example ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> accessEntryArn()  
      com.pulumi.core.Output<java.lang.String> clusterName()  
      com.pulumi.core.Output<java.lang.String> createdAt()  
      static AccessEntry get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AccessEntryState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.List<java.lang.String>> kubernetesGroups()  
      com.pulumi.core.Output<java.lang.String> modifiedAt()  
      com.pulumi.core.Output<java.lang.String> principalArn()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> type()  
      com.pulumi.core.Output<java.lang.String> userName()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AccessEntry

        public AccessEntry​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • AccessEntry

        public AccessEntry​(java.lang.String name,
                   AccessEntryArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • AccessEntry

        public AccessEntry​(java.lang.String name,
                   AccessEntryArgs args,
                   @Nullable
                   com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • accessEntryArn

        public com.pulumi.core.Output<java.lang.String> accessEntryArn()
        Returns:
        ARN of the Access Entry.

      • clusterName

        public com.pulumi.core.Output<java.lang.String> clusterName()
        Returns:
        Name of the EKS Cluster.

      • createdAt

        public com.pulumi.core.Output<java.lang.String> createdAt()
        Returns:
        Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the EKS add-on was created.

      • kubernetesGroups

        public com.pulumi.core.Output<java.util.List<java.lang.String>> kubernetesGroups()
        Returns:
        List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry.

      • modifiedAt

        public com.pulumi.core.Output<java.lang.String> modifiedAt()
        Returns:
        Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the EKS add-on was updated.

      • principalArn

        public com.pulumi.core.Output<java.lang.String> principalArn()
        Returns:
        The IAM Principal ARN which requires Authentication access to the EKS cluster. The following arguments are optional:

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        (Optional) Key-value map of resource tags, including those inherited from the provider `defaultTags` configuration block.

      • type

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> type()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> userName()
        Returns:
        Defaults to principal ARN if user is principal else defaults to assume-role/session-name is role is used.

      • get

        public static AccessEntry get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              AccessEntryState state,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.