Skip to content

Update Access Entry

eks_update_access_entry R Documentation

Updates an access entry

Description

Updates an access entry.

Usage

eks_update_access_entry(clusterName, principalArn, kubernetesGroups,
  clientRequestToken, username)

Arguments

clusterName

[required] The name of your cluster.
principalArn

[required] The ARN of the IAM principal for the AccessEntry.
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 associate_access_policy. 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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
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.

Value

A list with the following syntax:

list(
  accessEntry = list(
    clusterName = "string",
    principalArn = "string",
    kubernetesGroups = list(
      "string"
    ),
    accessEntryArn = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    modifiedAt = as.POSIXct(
      "2015-01-01"
    ),
    tags = list(
      "string"
    ),
    username = "string",
    type = "string"
  )
)

Request syntax

svc$update_access_entry(
  clusterName = "string",
  principalArn = "string",
  kubernetesGroups = list(
    "string"
  ),
  clientRequestToken = "string",
  username = "string"
)