java.lang.Object
- software.amazon.awssdk.services.eks.model.AccessEntry

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AccessEntry.Builder,AccessEntry>
```
@Generated("software.amazon.awssdk:codegen")
public final class AccessEntry
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AccessEntry.Builder,AccessEntry>
```
An access entry allows an IAM principal (user or role) to access your cluster. Access entries can replace the need to maintain the aws-auth ConfigMap for authentication. For more information about access entries, see Access entries in the Amazon EKS User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AccessEntry.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`accessEntryArn()`	The ARN of the access entry.
`static AccessEntry.Builder`	`builder()`
`String`	`clusterName()`	The name of your cluster.
`Instant`	`createdAt()`	The Unix epoch timestamp at object creation.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasKubernetesGroups()`	For responses, this returns true if the service returned a value for the KubernetesGroups property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`List<String>`	`kubernetesGroups()`	A `name` that you've specified in a Kubernetes `RoleBinding` or `ClusterRoleBinding` object so that Kubernetes authorizes the `principalARN` access to cluster objects.
`Instant`	`modifiedAt()`	The Unix epoch timestamp for the last modification to the object.
`String`	`principalArn()`	The ARN of the IAM principal for the access entry.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AccessEntry.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`	Metadata that assists with categorization and organization.
`AccessEntry.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`type()`	The type of the access entry.
`String`	`username()`	The `name` of a user that can authenticate to your cluster.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clusterName
```
public final String clusterName()
```
    The name of your cluster.
    
    Returns:
    
    The name of your cluster.
  - principalArn
```
public final String principalArn()
```
    The ARN of the IAM principal for the access entry. If you ever delete the IAM principal with this ARN, the access entry isn't automatically deleted. We recommend that you delete the access entry with an ARN for an IAM principal that you delete. If you don't delete the access entry and ever recreate the IAM principal, even if it has the same ARN, the access entry won't work. This is because even though the ARN is the same for the recreated IAM principal, the roleID or userID (you can see this with the Security Token Service GetCallerIdentity API) is different for the recreated IAM principal than it was for the original IAM principal. Even though you don't see the IAM principal's roleID or userID for an access entry, Amazon EKS stores it with the access entry.
    
    Returns:
    
    The ARN of the IAM principal for the access entry. If you ever delete the IAM principal with this ARN, the access entry isn't automatically deleted. We recommend that you delete the access entry with an ARN for an IAM principal that you delete. If you don't delete the access entry and ever recreate the IAM principal, even if it has the same ARN, the access entry won't work. This is because even though the ARN is the same for the recreated IAM principal, the roleID or userID (you can see this with the Security Token Service GetCallerIdentity API) is different for the recreated IAM principal than it was for the original IAM principal. Even though you don't see the IAM principal's roleID or userID for an access entry, Amazon EKS stores it with the access entry.
  - hasKubernetesGroups
```
public final boolean hasKubernetesGroups()
```
    For responses, this returns true if the service returned a value for the KubernetesGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - kubernetesGroups
```
public final List<String> kubernetesGroups()
```
    A name that you've specified in a Kubernetes RoleBinding or ClusterRoleBinding object so that Kubernetes authorizes the principalARN access to cluster objects.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasKubernetesGroups() method.
    
    Returns:
    
    A name that you've specified in a Kubernetes RoleBinding or ClusterRoleBinding object so that Kubernetes authorizes the principalARN access to cluster objects.
  - accessEntryArn
```
public final String accessEntryArn()
```
    The ARN of the access entry.
    
    Returns:
    
    The ARN of the access entry.
  - createdAt
```
public final Instant createdAt()
```
    The Unix epoch timestamp at object creation.
    
    Returns:
    
    The Unix epoch timestamp at object creation.
  - modifiedAt
```
public final Instant modifiedAt()
```
    The Unix epoch timestamp for the last modification to the object.
    
    Returns:
    
    The Unix epoch timestamp for the last modification to the object.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
  - username
```
public final String username()
```
    The name of a user that can authenticate to your cluster.
    
    Returns:
    
    The name of a user that can authenticate to your cluster.
  - type
```
public final String type()
```
    The type of the access entry.
    
    Returns:
    
    The type of the access entry.
  - toBuilder
```
public AccessEntry.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AccessEntry.Builder,AccessEntry>
  - builder
```
public static AccessEntry.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AccessEntry.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class AccessEntry

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clusterName

principalArn

hasKubernetesGroups

kubernetesGroups

accessEntryArn

createdAt

modifiedAt

hasTags

tags

username

type

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField