Package software.amazon.awssdk.services.eks.model

Class UpdateAccessEntryRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.eks.model.EksRequest

software.amazon.awssdk.services.eks.model.UpdateAccessEntryRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAccessEntryRequest.Builder,UpdateAccessEntryRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateAccessEntryRequest
extends EksRequest
implements ToCopyableBuilder<UpdateAccessEntryRequest.Builder,UpdateAccessEntryRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateAccessEntryRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateAccessEntryRequest.Builder	builder()
String	clientRequestToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	clusterName()	The name of your cluster.
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.
List<String>	kubernetesGroups()	The value for name that you've specified for kind: Group as a subject in a Kubernetes RoleBinding or ClusterRoleBinding object.
String	principalArn()	The ARN of the IAM principal for the AccessEntry.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateAccessEntryRequest.Builder>	serializableBuilderClass()
UpdateAccessEntryRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	username()	The username to authenticate to Kubernetes with.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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 AccessEntry.

Returns:

The ARN of the IAM principal for the AccessEntry.

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()

The value for name that you've specified for kind: Group as a subject in a Kubernetes RoleBinding or ClusterRoleBinding object. Amazon EKS doesn't confirm that the value for name exists in any bindings on your cluster. You can specify one or more names.

Kubernetes authorizes the principalArn of the access entry to access any cluster objects that you've specified in a Kubernetes Role or ClusterRole object that is also specified in a binding's roleRef. For more information about creating Kubernetes RoleBinding, ClusterRoleBinding, Role, or ClusterRole objects, see Using RBAC Authorization in the Kubernetes documentation.

If you want Amazon EKS to authorize the principalArn (instead of, or in addition to Kubernetes authorizing the principalArn), you can associate one or more access policies to the access entry using AssociateAccessPolicy. If you associate any access policies, the principalARN has all permissions assigned in the associated access policies and all permissions in any Kubernetes Role or ClusterRole objects that the group names are bound to.

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:

The value for name that you've specified for kind: Group as a subject in a Kubernetes RoleBinding or ClusterRoleBinding object. Amazon EKS doesn't confirm that the value for name exists in any bindings on your cluster. You can specify one or more names.

Kubernetes authorizes the principalArn of the access entry to access any cluster objects that you've specified in a Kubernetes Role or ClusterRole object that is also specified in a binding's roleRef. For more information about creating Kubernetes RoleBinding, ClusterRoleBinding, Role, or ClusterRole objects, see Using RBAC Authorization in the Kubernetes documentation.

If you want Amazon EKS to authorize the principalArn (instead of, or in addition to Kubernetes authorizing the principalArn), you can associate one or more access policies to the access entry using AssociateAccessPolicy. If you associate any access policies, the principalARN has all permissions assigned in the associated access policies and all permissions in any Kubernetes Role or ClusterRole objects that the group names are bound to.

clientRequestToken

public final String clientRequestToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

username

public final String username()

The username to authenticate to Kubernetes with. We recommend not specifying a username and letting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies for you, or constraints before specifying your own username, see Creating access entries in the Amazon EKS User Guide.

Returns:

The username to authenticate to Kubernetes with. We recommend not specifying a username and letting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies for you, or constraints before specifying your own username, see Creating access entries in the Amazon EKS User Guide.

toBuilder

public UpdateAccessEntryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateAccessEntryRequest.Builder,UpdateAccessEntryRequest>

Specified by:

toBuilder in class EksRequest

builder

public static UpdateAccessEntryRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateAccessEntryRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo