software.amazon.awssdk.services.eks.model

Class VpcConfigRequest

java.lang.Object

software.amazon.awssdk.services.eks.model.VpcConfigRequest

All Implemented Interfaces:

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

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

An object representing the VPC configuration to use for an Amazon EKS cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VpcConfigRequest.Builder

Method Summary

Modifier and Type	Method and Description
static VpcConfigRequest.Builder	builder()
Boolean	endpointPrivateAccess() Set this value to true to enable private access for your cluster's Kubernetes API server endpoint.
Boolean	endpointPublicAccess() Set this value to false to disable public access to your cluster's Kubernetes API server endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPublicAccessCidrs() Returns true if the PublicAccessCidrs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSecurityGroupIds() Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSubnetIds() Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	publicAccessCidrs() The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint.
List<SdkField<?>>	sdkFields()
List<String>	securityGroupIds() Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane.
static Class<? extends VpcConfigRequest.Builder>	serializableBuilderClass()
List<String>	subnetIds() Specify subnets for your Amazon EKS worker nodes.
VpcConfigRequest.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

hasSubnetIds

public boolean hasSubnetIds()

Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

subnetIds

public List<String> subnetIds()

Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.

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

You can use hasSubnetIds() to see if a value was sent in this field.

Returns:

Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.

hasSecurityGroupIds

public boolean hasSecurityGroupIds()

Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

securityGroupIds

public List<String> securityGroupIds()

Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes:

• 1.14 Amazon EKS platform version eks.2 and earlier

• 1.14 Amazon EKS platform version eks.3 and later

For more information, see Amazon EKS security group considerations in the Amazon EKS User Guide .

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

You can use hasSecurityGroupIds() to see if a value was sent in this field.

Returns:

Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes:

• 1.14 Amazon EKS platform version eks.2 and earlier

• 1.14 Amazon EKS platform version eks.3 and later

For more information, see Amazon EKS security group considerations in the Amazon EKS User Guide .

endpointPublicAccess

public Boolean endpointPublicAccess()

Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

Returns:

Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

endpointPrivateAccess

public Boolean endpointPrivateAccess()

Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

Returns:

Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

hasPublicAccessCidrs

public boolean hasPublicAccessCidrs()

Returns true if the PublicAccessCidrs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

publicAccessCidrs

public List<String> publicAccessCidrs()

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

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

You can use hasPublicAccessCidrs() to see if a value was sent in this field.

Returns:

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

toBuilder

public VpcConfigRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VpcConfigRequest.Builder,VpcConfigRequest>

builder

public static VpcConfigRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo