class CfnAccessEntry (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EKS.CfnAccessEntry |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awseks#CfnAccessEntry |
![]() | software.amazon.awscdk.services.eks.CfnAccessEntry |
![]() | aws_cdk.aws_eks.CfnAccessEntry |
![]() | aws-cdk-lib » aws_eks » CfnAccessEntry |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
Creates an access entry.
An access entry allows an IAM principal to access your cluster. Access entries can replace the need to maintain entries in the aws-auth
ConfigMap
for authentication. You have the following options for authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization requires you to create and manage Kubernetes Role
, ClusterRole
, RoleBinding
, and ClusterRoleBinding
objects, in addition to managing access entries. If you use Amazon EKS authorization exclusively, you don't need to create and manage Kubernetes Role
, ClusterRole
, RoleBinding
, and ClusterRoleBinding
objects.
For more information about access entries, see Access entries in the Amazon EKS User Guide .
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eks as eks } from 'aws-cdk-lib';
const cfnAccessEntry = new eks.CfnAccessEntry(this, 'MyCfnAccessEntry', {
clusterName: 'clusterName',
principalArn: 'principalArn',
// the properties below are optional
accessPolicies: [{
accessScope: {
type: 'type',
// the properties below are optional
namespaces: ['namespaces'],
},
policyArn: 'policyArn',
}],
kubernetesGroups: ['kubernetesGroups'],
tags: [{
key: 'key',
value: 'value',
}],
type: 'type',
username: 'username',
});
Initializer
new CfnAccessEntry(scope: Construct, id: string, props: CfnAccessEntryProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Access Entry Props
Construct Props
Name | Type | Description |
---|---|---|
cluster | string | The name of your cluster. |
principal | string | The ARN of the IAM principal for the AccessEntry . |
access | IResolvable | IResolvable | Access [] | The access policies to associate to the access entry. |
kubernetes | string[] | The value for name that you've specified for kind: Group as a subject in a Kubernetes RoleBinding or ClusterRoleBinding object. |
tags? | Cfn [] | 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. |
clusterName
Type:
string
The name of your cluster.
principalArn
Type:
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. For STANDARD
access entries, you can use every IAM principal type. For nodes ( EC2
(for EKS Auto Mode), EC2_LINUX
, EC2_WINDOWS
, FARGATE_LINUX
, and HYBRID_LINUX
), the only valid ARN is IAM roles. 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.
accessPolicies?
Type:
IResolvable
|
IResolvable
|
Access
[]
(optional)
The access policies to associate to the access entry.
kubernetesGroups?
Type:
string[]
(optional)
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.
tags?
Type:
Cfn
[]
(optional)
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 AWS resources.
type?
Type:
string
(optional)
The type of the new access entry.
Valid values are STANDARD
, FARGATE_LINUX
, EC2_LINUX
, EC2_WINDOWS
, EC2
(for EKS Auto Mode), HYBRID_LINUX
, and HYPERPOD_LINUX
.
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
. If you have the access mode of the cluster set to API_AND_CONFIG_MAP
, 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.
username?
Type:
string
(optional)
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 .
Properties
Name | Type | Description |
---|---|---|
attr | string | The ARN of the access entry. |
cdk | Tag | Tag Manager which manages the tags for this resource. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
cluster | string | The name of your cluster. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
principal | string | The ARN of the IAM principal for the AccessEntry . |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
access | IResolvable | IResolvable | Access [] | The access policies to associate to the access entry. |
kubernetes | string[] | The value for name that you've specified for kind: Group as a subject in a Kubernetes RoleBinding or ClusterRoleBinding object. |
tags? | Cfn [] | 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. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrAccessEntryArn
Type:
string
The ARN of the access entry.
cdkTagManager
Type:
Tag
Tag Manager which manages the tags for this resource.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
clusterName
Type:
string
The name of your cluster.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
node
Type:
Node
The tree node.
principalArn
Type:
string
The ARN of the IAM principal for the AccessEntry
.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
accessPolicies?
Type:
IResolvable
|
IResolvable
|
Access
[]
(optional)
The access policies to associate to the access entry.
kubernetesGroups?
Type:
string[]
(optional)
The value for name
that you've specified for kind: Group
as a subject
in a Kubernetes RoleBinding
or ClusterRoleBinding
object.
tags?
Type:
Cfn
[]
(optional)
Metadata that assists with categorization and organization.
type?
Type:
string
(optional)
The type of the new access entry.
username?
Type:
string
(optional)
The username to authenticate to Kubernetes with.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }