AccessEntry (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.eks.model.AccessEntry

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AccessEntry
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AccessEntry()

Constructors
Constructor and Description
`AccessEntry()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessEntry`	`addTagsEntry(String key, String value)` Add a single Tags entry
`AccessEntry`	`clearTagsEntries()` Removes all the entries added into Tags.
`AccessEntry`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccessEntryArn()` The ARN of the access entry.
`String`	`getClusterName()` The name of your cluster.
`Date`	`getCreatedAt()` The Unix epoch timestamp at object creation.
`List<String>`	`getKubernetesGroups()` A `name` that you've specified in a Kubernetes `RoleBinding` or `ClusterRoleBinding` object so that Kubernetes authorizes the `principalARN` access to cluster objects.
`Date`	`getModifiedAt()` The Unix epoch timestamp for the last modification to the object.
`String`	`getPrincipalArn()` The ARN of the IAM principal for the access entry.
`Map<String,String>`	`getTags()` Metadata that assists with categorization and organization.
`String`	`getType()` The type of the access entry.
`String`	`getUsername()` The `name` of a user that can authenticate to your cluster.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccessEntryArn(String accessEntryArn)` The ARN of the access entry.
`void`	`setClusterName(String clusterName)` The name of your cluster.
`void`	`setCreatedAt(Date createdAt)` The Unix epoch timestamp at object creation.
`void`	`setKubernetesGroups(Collection<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.
`void`	`setModifiedAt(Date modifiedAt)` The Unix epoch timestamp for the last modification to the object.
`void`	`setPrincipalArn(String principalArn)` The ARN of the IAM principal for the access entry.
`void`	`setTags(Map<String,String> tags)` Metadata that assists with categorization and organization.
`void`	`setType(String type)` The type of the access entry.
`void`	`setUsername(String username)` The `name` of a user that can authenticate to your cluster.
`String`	`toString()` Returns a string representation of this object.
`AccessEntry`	`withAccessEntryArn(String accessEntryArn)` The ARN of the access entry.
`AccessEntry`	`withClusterName(String clusterName)` The name of your cluster.
`AccessEntry`	`withCreatedAt(Date createdAt)` The Unix epoch timestamp at object creation.
`AccessEntry`	`withKubernetesGroups(Collection<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.
`AccessEntry`	`withKubernetesGroups(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.
`AccessEntry`	`withModifiedAt(Date modifiedAt)` The Unix epoch timestamp for the last modification to the object.
`AccessEntry`	`withPrincipalArn(String principalArn)` The ARN of the IAM principal for the access entry.
`AccessEntry`	`withTags(Map<String,String> tags)` Metadata that assists with categorization and organization.
`AccessEntry`	`withType(String type)` The type of the access entry.
`AccessEntry`	`withUsername(String username)` The `name` of a user that can authenticate to your cluster.

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

- Constructor Detail
  - AccessEntry
```
public AccessEntry()
```
- Method Detail
  - setClusterName
```
public void setClusterName(String clusterName)
```
    The name of your cluster.
    
    Parameters:
    
    clusterName - The name of your cluster.
  - getClusterName
```
public String getClusterName()
```
    The name of your cluster.
    
    Returns:
    
    The name of your cluster.
  - withClusterName
```
public AccessEntry withClusterName(String clusterName)
```
    The name of your cluster.
    
    Parameters:
    
    clusterName - The name of your cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrincipalArn
```
public void setPrincipalArn(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.
    
    Parameters:
    
    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.
  - getPrincipalArn
```
public String getPrincipalArn()
```
    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.
  - withPrincipalArn
```
public AccessEntry withPrincipalArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getKubernetesGroups
```
public List<String> getKubernetesGroups()
```
    A name that you've specified in a Kubernetes RoleBinding or ClusterRoleBinding object so that Kubernetes authorizes the principalARN access to cluster objects.
    
    Returns:
    
    A name that you've specified in a Kubernetes RoleBinding or ClusterRoleBinding object so that Kubernetes authorizes the principalARN access to cluster objects.
  - setKubernetesGroups
```
public void setKubernetesGroups(Collection<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.
    
    Parameters:
    
    kubernetesGroups - A name that you've specified in a Kubernetes RoleBinding or ClusterRoleBinding object so that Kubernetes authorizes the principalARN access to cluster objects.
  - withKubernetesGroups
```
public AccessEntry withKubernetesGroups(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setKubernetesGroups(java.util.Collection) or withKubernetesGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    kubernetesGroups - A name that you've specified in a Kubernetes RoleBinding or ClusterRoleBinding object so that Kubernetes authorizes the principalARN access to cluster objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withKubernetesGroups
```
public AccessEntry withKubernetesGroups(Collection<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.
    
    Parameters:
    
    kubernetesGroups - A name that you've specified in a Kubernetes RoleBinding or ClusterRoleBinding object so that Kubernetes authorizes the principalARN access to cluster objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessEntryArn
```
public void setAccessEntryArn(String accessEntryArn)
```
    The ARN of the access entry.
    
    Parameters:
    
    accessEntryArn - The ARN of the access entry.
  - getAccessEntryArn
```
public String getAccessEntryArn()
```
    The ARN of the access entry.
    
    Returns:
    
    The ARN of the access entry.
  - withAccessEntryArn
```
public AccessEntry withAccessEntryArn(String accessEntryArn)
```
    The ARN of the access entry.
    
    Parameters:
    
    accessEntryArn - The ARN of the access entry.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The Unix epoch timestamp at object creation.
    
    Parameters:
    
    createdAt - The Unix epoch timestamp at object creation.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The Unix epoch timestamp at object creation.
    
    Returns:
    
    The Unix epoch timestamp at object creation.
  - withCreatedAt
```
public AccessEntry withCreatedAt(Date createdAt)
```
    The Unix epoch timestamp at object creation.
    
    Parameters:
    
    createdAt - The Unix epoch timestamp at object creation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModifiedAt
```
public void setModifiedAt(Date modifiedAt)
```
    The Unix epoch timestamp for the last modification to the object.
    
    Parameters:
    
    modifiedAt - The Unix epoch timestamp for the last modification to the object.
  - getModifiedAt
```
public Date getModifiedAt()
```
    The Unix epoch timestamp for the last modification to the object.
    
    Returns:
    
    The Unix epoch timestamp for the last modification to the object.
  - withModifiedAt
```
public AccessEntry withModifiedAt(Date modifiedAt)
```
    The Unix epoch timestamp for the last modification to the object.
    
    Parameters:
    
    modifiedAt - The Unix epoch timestamp for the last modification to the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    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.
    
    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.
  - setTags
```
public void setTags(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.
    
    Parameters:
    
    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.
  - withTags
```
public AccessEntry withTags(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public AccessEntry addTagsEntry(String key,
                                String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public AccessEntry clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsername
```
public void setUsername(String username)
```
    The name of a user that can authenticate to your cluster.
    
    Parameters:
    
    username - The name of a user that can authenticate to your cluster.
  - getUsername
```
public String getUsername()
```
    The name of a user that can authenticate to your cluster.
    
    Returns:
    
    The name of a user that can authenticate to your cluster.
  - withUsername
```
public AccessEntry withUsername(String username)
```
    The name of a user that can authenticate to your cluster.
    
    Parameters:
    
    username - The name of a user that can authenticate to your cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of the access entry.
    
    Parameters:
    
    type - The type of the access entry.
  - getType
```
public String getType()
```
    The type of the access entry.
    
    Returns:
    
    The type of the access entry.
  - withType
```
public AccessEntry withType(String type)
```
    The type of the access entry.
    
    Parameters:
    
    type - The type of the access entry.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AccessEntry clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class AccessEntry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AccessEntry

Method Detail

setClusterName

getClusterName

withClusterName

setPrincipalArn

getPrincipalArn

withPrincipalArn

getKubernetesGroups

setKubernetesGroups

withKubernetesGroups

withKubernetesGroups

setAccessEntryArn

getAccessEntryArn

withAccessEntryArn

setCreatedAt

getCreatedAt

withCreatedAt

setModifiedAt

getModifiedAt

withModifiedAt

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setUsername

getUsername

withUsername

setType

getType

withType

toString

equals

hashCode

clone

marshall