Class CreateAccessEntryRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateAccessEntryRequest.Builder,
CreateAccessEntryRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final String
The name of your cluster.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the KubernetesGroups property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.The value forname
that you've specified forkind: Group
as asubject
in a KubernetesRoleBinding
orClusterRoleBinding
object.final String
The ARN of the IAM principal for theAccessEntry
.static Class
<? extends CreateAccessEntryRequest.Builder> tags()
Metadata that assists with categorization and organization.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
type()
The type of the new access entry.final String
username()
The username to authenticate to Kubernetes with.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clusterName
The name of your cluster.
- Returns:
- The name of your cluster.
-
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.
- Returns:
- 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.
-
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 theisEmpty()
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
The value for
name
that you've specified forkind: Group
as asubject
in a KubernetesRoleBinding
orClusterRoleBinding
object. Amazon EKS doesn't confirm that the value forname
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 KubernetesRole
orClusterRole
object that is also specified in a binding'sroleRef
. For more information about creating KubernetesRoleBinding
,ClusterRoleBinding
,Role
, orClusterRole
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 theprincipalArn
), you can associate one or more access policies to the access entry usingAssociateAccessPolicy
. If you associate any access policies, theprincipalARN
has all permissions assigned in the associated access policies and all permissions in any KubernetesRole
orClusterRole
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 forkind: Group
as asubject
in a KubernetesRoleBinding
orClusterRoleBinding
object. Amazon EKS doesn't confirm that the value forname
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 KubernetesRole
orClusterRole
object that is also specified in a binding'sroleRef
. For more information about creating KubernetesRoleBinding
,ClusterRoleBinding
,Role
, orClusterRole
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 theprincipalArn
), you can associate one or more access policies to the access entry usingAssociateAccessPolicy
. If you associate any access policies, theprincipalARN
has all permissions assigned in the associated access policies and all permissions in any KubernetesRole
orClusterRole
objects that the group names are bound to.
-
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 theisEmpty()
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
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.
-
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
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.
-
type
The type of the new access entry. Valid values are
Standard
,FARGATE_LINUX
,EC2_LINUX
, andEC2_WINDOWS
.If the
principalArn
is for an IAM role that's used for self-managed Amazon EC2 nodes, specifyEC2_LINUX
orEC2_WINDOWS
. Amazon EKS grants the necessary permissions to the node for you. If theprincipalArn
is for any other purpose, specifySTANDARD
. If you don't specify a value, Amazon EKS sets the value toSTANDARD
. 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 theaws-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
orEC2_WINDOWS
, you can't specify values forkubernetesGroups
, or associate anAccessPolicy
to the access entry.- Returns:
- The type of the new access entry. Valid values are
Standard
,FARGATE_LINUX
,EC2_LINUX
, andEC2_WINDOWS
.If the
principalArn
is for an IAM role that's used for self-managed Amazon EC2 nodes, specifyEC2_LINUX
orEC2_WINDOWS
. Amazon EKS grants the necessary permissions to the node for you. If theprincipalArn
is for any other purpose, specifySTANDARD
. If you don't specify a value, Amazon EKS sets the value toSTANDARD
. 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 theaws-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
orEC2_WINDOWS
, you can't specify values forkubernetesGroups
, or associate anAccessPolicy
to the access entry.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateAccessEntryRequest.Builder,
CreateAccessEntryRequest> - Specified by:
toBuilder
in classEksRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-