Class: Aws::EKS::Types::CreateAccessEntryRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EKS::Types::CreateAccessEntryRequest
- Defined in:
- gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
-
#cluster_name ⇒ String
The name of your cluster.
-
#kubernetes_groups ⇒ Array<String>
The value for
name
that you've specified forkind: Group
as asubject
in a KubernetesRoleBinding
orClusterRoleBinding
object. -
#principal_arn ⇒ String
The ARN of the IAM principal for the
AccessEntry
. -
#tags ⇒ Hash<String,String>
Metadata that assists with categorization and organization.
-
#type ⇒ String
The type of the new access entry.
-
#username ⇒ String
The username to authenticate to Kubernetes with.
Instance Attribute Details
#client_request_token ⇒ String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
A suitable default value is auto-generated. You should normally not need to pass this option.
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1115 class CreateAccessEntryRequest < Struct.new( :cluster_name, :principal_arn, :kubernetes_groups, :tags, :client_request_token, :username, :type) SENSITIVE = [] include Aws::Structure end |
#cluster_name ⇒ String
The name of your cluster.
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1115 class CreateAccessEntryRequest < Struct.new( :cluster_name, :principal_arn, :kubernetes_groups, :tags, :client_request_token, :username, :type) SENSITIVE = [] include Aws::Structure end |
#kubernetes_groups ⇒ Array<String>
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.
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1115 class CreateAccessEntryRequest < Struct.new( :cluster_name, :principal_arn, :kubernetes_groups, :tags, :client_request_token, :username, :type) SENSITIVE = [] include Aws::Structure end |
#principal_arn ⇒ String
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.</p> IAM best practices recommend
using IAM roles with temporary credentials, rather than IAM users
with long-term credentials.
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1115 class CreateAccessEntryRequest < Struct.new( :cluster_name, :principal_arn, :kubernetes_groups, :tags, :client_request_token, :username, :type) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
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.
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1115 class CreateAccessEntryRequest < Struct.new( :cluster_name, :principal_arn, :kubernetes_groups, :tags, :client_request_token, :username, :type) SENSITIVE = [] include Aws::Structure end |
#type ⇒ String
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.
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1115 class CreateAccessEntryRequest < Struct.new( :cluster_name, :principal_arn, :kubernetes_groups, :tags, :client_request_token, :username, :type) SENSITIVE = [] include Aws::Structure end |
#username ⇒ String
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.
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 |
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1115 class CreateAccessEntryRequest < Struct.new( :cluster_name, :principal_arn, :kubernetes_groups, :tags, :client_request_token, :username, :type) SENSITIVE = [] include Aws::Structure end |