@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateAccessEntryRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateAccessEntryRequest() |
Modifier and Type | Method and Description |
---|---|
CreateAccessEntryRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateAccessEntryRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateAccessEntryRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getClientRequestToken()
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
String |
getClusterName()
The name of your cluster.
|
List<String> |
getKubernetesGroups()
The value for
name that you've specified for kind: Group as a subject in a
Kubernetes RoleBinding or ClusterRoleBinding object. |
String |
getPrincipalArn()
The ARN of the IAM principal for the
AccessEntry . |
Map<String,String> |
getTags()
Metadata that assists with categorization and organization.
|
String |
getType()
The type of the new access entry.
|
String |
getUsername()
The username to authenticate to Kubernetes with.
|
int |
hashCode() |
void |
setClientRequestToken(String clientRequestToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
void |
setClusterName(String clusterName)
The name of your cluster.
|
void |
setKubernetesGroups(Collection<String> kubernetesGroups)
The value for
name that you've specified for kind: Group as a subject in a
Kubernetes RoleBinding or ClusterRoleBinding object. |
void |
setPrincipalArn(String principalArn)
The ARN of the IAM principal for the
AccessEntry . |
void |
setTags(Map<String,String> tags)
Metadata that assists with categorization and organization.
|
void |
setType(String type)
The type of the new access entry.
|
void |
setUsername(String username)
The username to authenticate to Kubernetes with.
|
String |
toString()
Returns a string representation of this object.
|
CreateAccessEntryRequest |
withClientRequestToken(String clientRequestToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
CreateAccessEntryRequest |
withClusterName(String clusterName)
The name of your cluster.
|
CreateAccessEntryRequest |
withKubernetesGroups(Collection<String> kubernetesGroups)
The value for
name that you've specified for kind: Group as a subject in a
Kubernetes RoleBinding or ClusterRoleBinding object. |
CreateAccessEntryRequest |
withKubernetesGroups(String... kubernetesGroups)
The value for
name that you've specified for kind: Group as a subject in a
Kubernetes RoleBinding or ClusterRoleBinding object. |
CreateAccessEntryRequest |
withPrincipalArn(String principalArn)
The ARN of the IAM principal for the
AccessEntry . |
CreateAccessEntryRequest |
withTags(Map<String,String> tags)
Metadata that assists with categorization and organization.
|
CreateAccessEntryRequest |
withType(String type)
The type of the new access entry.
|
CreateAccessEntryRequest |
withUsername(String username)
The username to authenticate to Kubernetes with.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setClusterName(String clusterName)
The name of your cluster.
clusterName
- The name of your cluster.public String getClusterName()
The name of your cluster.
public CreateAccessEntryRequest withClusterName(String clusterName)
The name of your cluster.
clusterName
- The name of your cluster.public void setPrincipalArn(String principalArn)
The ARN of the IAM principal for the AccessEntry
. You can specify one ARN for each access entry. You
can't specify the same ARN in more than one access entry. This value can't be changed after access entry
creation.
The valid principals differ depending on the type of the access entry in the type
field. The only
valid ARN is IAM roles for the types of access entries for nodes:
. You can use every IAM principal type for
STANDARD
access entries. You can't use the
STS session principal type with access entries because this is a temporary principal for each session and not a
permanent identity that can be assigned permissions.
IAM best practices recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials.
principalArn
- The ARN of the IAM principal for the AccessEntry
. You can specify one ARN for each access
entry. You can't specify the same ARN in more than one access entry. This value can't be changed after
access entry creation.
The valid principals differ depending on the type of the access entry in the type
field. The
only valid ARN is IAM roles for the types of access entries for nodes:
. You can use every IAM principal type for
STANDARD
access entries. You can't
use the STS session principal type with access entries because this is a temporary principal for each
session and not a permanent identity that can be assigned permissions.
IAM best practices recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials.
public String getPrincipalArn()
The ARN of the IAM principal for the AccessEntry
. You can specify one ARN for each access entry. You
can't specify the same ARN in more than one access entry. This value can't be changed after access entry
creation.
The valid principals differ depending on the type of the access entry in the type
field. The only
valid ARN is IAM roles for the types of access entries for nodes:
. You can use every IAM principal type for
STANDARD
access entries. You can't use the
STS session principal type with access entries because this is a temporary principal for each session and not a
permanent identity that can be assigned permissions.
IAM best practices recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials.
AccessEntry
. You can specify one ARN for each access
entry. You can't specify the same ARN in more than one access entry. This value can't be changed after
access entry creation.
The valid principals differ depending on the type of the access entry in the type
field. The
only valid ARN is IAM roles for the types of access entries for nodes:
. You can use every IAM principal type for
STANDARD
access entries. You can't
use the STS session principal type with access entries because this is a temporary principal for each
session and not a permanent identity that can be assigned permissions.
IAM best practices recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials.
public CreateAccessEntryRequest withPrincipalArn(String principalArn)
The ARN of the IAM principal for the AccessEntry
. You can specify one ARN for each access entry. You
can't specify the same ARN in more than one access entry. This value can't be changed after access entry
creation.
The valid principals differ depending on the type of the access entry in the type
field. The only
valid ARN is IAM roles for the types of access entries for nodes:
. You can use every IAM principal type for
STANDARD
access entries. You can't use the
STS session principal type with access entries because this is a temporary principal for each session and not a
permanent identity that can be assigned permissions.
IAM best practices recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials.
principalArn
- The ARN of the IAM principal for the AccessEntry
. You can specify one ARN for each access
entry. You can't specify the same ARN in more than one access entry. This value can't be changed after
access entry creation.
The valid principals differ depending on the type of the access entry in the type
field. The
only valid ARN is IAM roles for the types of access entries for nodes:
. You can use every IAM principal type for
STANDARD
access entries. You can't
use the STS session principal type with access entries because this is a temporary principal for each
session and not a permanent identity that can be assigned permissions.
IAM best practices recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials.
public List<String> getKubernetesGroups()
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.
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.
public void setKubernetesGroups(Collection<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.
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.
public CreateAccessEntryRequest withKubernetesGroups(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.
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.
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.
public CreateAccessEntryRequest withKubernetesGroups(Collection<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.
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.
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.
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.
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.public CreateAccessEntryRequest 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.
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.public CreateAccessEntryRequest addTagsEntry(String key, String value)
public CreateAccessEntryRequest clearTagsEntries()
public void setClientRequestToken(String clientRequestToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
clientRequestToken
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.public String getClientRequestToken()
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
public CreateAccessEntryRequest withClientRequestToken(String clientRequestToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
clientRequestToken
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.public void setUsername(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.
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.public String getUsername()
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.
public CreateAccessEntryRequest withUsername(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.
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.public void setType(String type)
The type of the new access entry. Valid values are Standard
, FARGATE_LINUX
,
EC2_LINUX
, and EC2_WINDOWS
.
If the principalArn
is for an IAM role that's used for self-managed Amazon EC2 nodes, specify
EC2_LINUX
or EC2_WINDOWS
. Amazon EKS grants the necessary permissions to the node for
you. If the principalArn
is for any other purpose, specify STANDARD
. If you don't
specify a value, Amazon EKS sets the value to STANDARD
. It's unnecessary to create access entries
for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the
aws-auth
ConfigMap
for the roles. You can't change this value once you've created the
access entry.
If you set the value to EC2_LINUX
or EC2_WINDOWS
, you can't specify values for
kubernetesGroups
, or associate an AccessPolicy
to the access entry.
type
- The type of the new access entry. Valid values are Standard
, FARGATE_LINUX
,
EC2_LINUX
, and EC2_WINDOWS
.
If the principalArn
is for an IAM role that's used for self-managed Amazon EC2 nodes, specify
EC2_LINUX
or EC2_WINDOWS
. Amazon EKS grants the necessary permissions to the
node for you. If the principalArn
is for any other purpose, specify STANDARD
. If
you don't specify a value, Amazon EKS sets the value to STANDARD
. It's unnecessary to create
access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS
creates entries in the aws-auth
ConfigMap
for the roles. You can't change this
value once you've created the access entry.
If you set the value to EC2_LINUX
or EC2_WINDOWS
, you can't specify values for
kubernetesGroups
, or associate an AccessPolicy
to the access entry.
public String getType()
The type of the new access entry. Valid values are Standard
, FARGATE_LINUX
,
EC2_LINUX
, and EC2_WINDOWS
.
If the principalArn
is for an IAM role that's used for self-managed Amazon EC2 nodes, specify
EC2_LINUX
or EC2_WINDOWS
. Amazon EKS grants the necessary permissions to the node for
you. If the principalArn
is for any other purpose, specify STANDARD
. If you don't
specify a value, Amazon EKS sets the value to STANDARD
. It's unnecessary to create access entries
for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the
aws-auth
ConfigMap
for the roles. You can't change this value once you've created the
access entry.
If you set the value to EC2_LINUX
or EC2_WINDOWS
, you can't specify values for
kubernetesGroups
, or associate an AccessPolicy
to the access entry.
Standard
, FARGATE_LINUX
,
EC2_LINUX
, and EC2_WINDOWS
.
If the principalArn
is for an IAM role that's used for self-managed Amazon EC2 nodes,
specify EC2_LINUX
or EC2_WINDOWS
. Amazon EKS grants the necessary permissions
to the node for you. If the principalArn
is for any other purpose, specify
STANDARD
. If you don't specify a value, Amazon EKS sets the value to STANDARD
.
It's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2
nodes, because Amazon EKS creates entries in the aws-auth
ConfigMap
for the
roles. You can't change this value once you've created the access entry.
If you set the value to EC2_LINUX
or EC2_WINDOWS
, you can't specify values for
kubernetesGroups
, or associate an AccessPolicy
to the access entry.
public CreateAccessEntryRequest withType(String type)
The type of the new access entry. Valid values are Standard
, FARGATE_LINUX
,
EC2_LINUX
, and EC2_WINDOWS
.
If the principalArn
is for an IAM role that's used for self-managed Amazon EC2 nodes, specify
EC2_LINUX
or EC2_WINDOWS
. Amazon EKS grants the necessary permissions to the node for
you. If the principalArn
is for any other purpose, specify STANDARD
. If you don't
specify a value, Amazon EKS sets the value to STANDARD
. It's unnecessary to create access entries
for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the
aws-auth
ConfigMap
for the roles. You can't change this value once you've created the
access entry.
If you set the value to EC2_LINUX
or EC2_WINDOWS
, you can't specify values for
kubernetesGroups
, or associate an AccessPolicy
to the access entry.
type
- The type of the new access entry. Valid values are Standard
, FARGATE_LINUX
,
EC2_LINUX
, and EC2_WINDOWS
.
If the principalArn
is for an IAM role that's used for self-managed Amazon EC2 nodes, specify
EC2_LINUX
or EC2_WINDOWS
. Amazon EKS grants the necessary permissions to the
node for you. If the principalArn
is for any other purpose, specify STANDARD
. If
you don't specify a value, Amazon EKS sets the value to STANDARD
. It's unnecessary to create
access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS
creates entries in the aws-auth
ConfigMap
for the roles. You can't change this
value once you've created the access entry.
If you set the value to EC2_LINUX
or EC2_WINDOWS
, you can't specify values for
kubernetesGroups
, or associate an AccessPolicy
to the access entry.
public String toString()
toString
in class Object
Object.toString()
public CreateAccessEntryRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()