Skip to content
v2.278.0

RemoteAccessProperty Struct ​

An object representing the remote access configuration for the managed node group.

Example ​

ts
// 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 remoteAccessProperty: eks.CfnNodegroup.RemoteAccessProperty = {
  ec2SshKey: 'ec2SshKey',

  // the properties below are optional
  sourceSecurityGroups: ['sourceSecurityGroups'],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_eks as eks

remote_access_property = eks.CfnNodegroup.RemoteAccessProperty(
    ec2_ssh_key="ec2SshKey",

    # the properties below are optional
    source_security_groups=["sourceSecurityGroups"]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.eks.*;

RemoteAccessProperty remoteAccessProperty = RemoteAccessProperty.builder()
        .ec2SshKey("ec2SshKey")

        // the properties below are optional
        .sourceSecurityGroups(List.of("sourceSecurityGroups"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EKS;

var remoteAccessProperty = new RemoteAccessProperty {
    Ec2SshKey = "ec2SshKey",

    // the properties below are optional
    SourceSecurityGroups = new [] { "sourceSecurityGroups" }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

remoteAccessProperty := &RemoteAccessProperty{
	Ec2SshKey: jsii.String("ec2SshKey"),

	// the properties below are optional
	SourceSecurityGroups: []*string{
		jsii.String("sourceSecurityGroups"),
	},
}

Properties ​

ec2SshKeystringec2_ssh_keystrec2SshKeyStringEc2SshKeystringEc2SshKey*string required #
The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group.
notes

For more information, see Amazon EC2 key pairs and Linux instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances . For Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more information, see Amazon EC2 key pairs and Windows instances in the Amazon Elastic Compute Cloud User Guide for Windows Instances .

sourceSecurityGroupsoptionalstring[]source_security_groupsoptionaltyping.List[str]sourceSecurityGroupsoptionalList<String>SourceSecurityGroupsoptionalstring[]SourceSecurityGroupsoptional*[]*string #
The security group IDs that are allowed SSH access (port 22) to the nodes.
notes

For Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't specify a source security group when you create a managed node group, then the port on the nodes is opened to the internet ( 0.0.0.0/0 ). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .