Package software.amazon.awscdk.services.eks

Interface NodegroupRemoteAccess

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

NodegroupRemoteAccess.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:06.943Z")
@Stability(Stable)
public interface NodegroupRemoteAccess
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.eks.*;
 SecurityGroup securityGroup;
 NodegroupRemoteAccess nodegroupRemoteAccess = NodegroupRemoteAccess.builder()
         .sshKeyName("sshKeyName")
         // the properties below are optional
         .sourceSecurityGroups(List.of(securityGroup))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	NodegroupRemoteAccess.Builder	A builder for NodegroupRemoteAccess
static final class	NodegroupRemoteAccess.Jsii$Proxy	An implementation for NodegroupRemoteAccess

Method Summary

Modifier and Type	Method	Description
static NodegroupRemoteAccess.Builder	builder()
default List<ISecurityGroup>	getSourceSecurityGroups()	The security groups that are allowed SSH access (port 22) to the worker nodes.
String	getSshKeyName()	The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSshKeyName

@Stability(Stable)
@NotNull
String getSshKeyName()

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

getSourceSecurityGroups

@Stability(Stable)
@Nullable
default List<ISecurityGroup> getSourceSecurityGroups()

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).

Default: - port 22 on the worker nodes is opened to the internet (0.0.0.0/0)

builder

@Stability(Stable)
static NodegroupRemoteAccess.Builder builder()

Returns:

a NodegroupRemoteAccess.Builder of NodegroupRemoteAccess