Package software.amazon.awssdk.services.eks.model

Class RemoteAccessConfig

java.lang.Object

software.amazon.awssdk.services.eks.model.RemoteAccessConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RemoteAccessConfig.Builder,RemoteAccessConfig>

@Generated("software.amazon.awssdk:codegen")
public final class RemoteAccessConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RemoteAccessConfig.Builder,RemoteAccessConfig>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RemoteAccessConfig.Builder

Method Summary

Modifier and Type	Method	Description
static RemoteAccessConfig.Builder	builder()
String	ec2SshKey()	The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSourceSecurityGroups()	For responses, this returns true if the service returned a value for the SourceSecurityGroups property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RemoteAccessConfig.Builder>	serializableBuilderClass()
List<String>	sourceSecurityGroups()	The security group IDs that are allowed SSH access (port 22) to the nodes.
RemoteAccessConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

ec2SshKey

public final String ec2SshKey()

The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group. 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.

Returns:

The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group. 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.

hasSourceSecurityGroups

public final boolean hasSourceSecurityGroups()

For responses, this returns true if the service returned a value for the SourceSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sourceSecurityGroups

public final List<String> sourceSecurityGroups()

The security group IDs that are allowed SSH access (port 22) to the nodes. 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSourceSecurityGroups() method.

Returns:

The security group IDs that are allowed SSH access (port 22) to the nodes. 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.

toBuilder

public RemoteAccessConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RemoteAccessConfig.Builder,RemoteAccessConfig>

builder

public static RemoteAccessConfig.Builder builder()

serializableBuilderClass

public static Class<? extends RemoteAccessConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo