aws-cdk-lib.aws_eks.NodegroupRemoteAccess

interface NodegroupRemoteAccess

LanguageType name
.NETAmazon.CDK.AWS.EKS.NodegroupRemoteAccess
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awseks#NodegroupRemoteAccess
Javasoftware.amazon.awscdk.services.eks.NodegroupRemoteAccess
Pythonaws_cdk.aws_eks.NodegroupRemoteAccess
TypeScript (source)aws-cdk-lib » aws_eks » NodegroupRemoteAccess

The remote access (SSH) configuration to use with your node group.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_eks as eks } from 'aws-cdk-lib';

declare const securityGroup: ec2.SecurityGroup;
const nodegroupRemoteAccess: eks.NodegroupRemoteAccess = {
  sshKeyName: 'sshKeyName',

  // the properties below are optional
  sourceSecurityGroups: [securityGroup],
};

Properties

NameTypeDescription
sshKeyNamestringThe Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group.
sourceSecurityGroups?ISecurityGroup[]The security groups that are allowed SSH access (port 22) to the worker nodes.

sshKeyName

Type: string

The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group.


sourceSecurityGroups?

Type: ISecurityGroup[] (optional, default: port 22 on the worker nodes is opened to the internet (0.0.0.0/0))

The security groups that are allowed SSH access (port 22) to the worker nodes.

If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0).