software.amazon.awssdk.services.eks.model

Class VpcConfigResponse

java.lang.Object

software.amazon.awssdk.services.eks.model.VpcConfigResponse

All Implemented Interfaces:

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

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

An object representing an Amazon EKS cluster VPC configuration response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VpcConfigResponse.Builder

Method Summary

Modifier and Type	Method and Description
static VpcConfigResponse.Builder	builder()
String	clusterSecurityGroupId() The cluster security group that was created by Amazon EKS for the cluster.
Boolean	endpointPrivateAccess() This parameter indicates whether the Amazon EKS private API server endpoint is enabled.
Boolean	endpointPublicAccess() This parameter indicates whether the Amazon EKS public API server endpoint is enabled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPublicAccessCidrs() For responses, this returns true if the service returned a value for the PublicAccessCidrs property.
boolean	hasSecurityGroupIds() For responses, this returns true if the service returned a value for the SecurityGroupIds property.
boolean	hasSubnetIds() For responses, this returns true if the service returned a value for the SubnetIds property.
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() The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.
static Class<? extends VpcConfigResponse.Builder>	serializableBuilderClass()
List<String>	subnetIds() The subnets associated with your cluster.
VpcConfigResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vpcId() The VPC associated with your cluster.

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 final boolean hasSubnetIds()

For responses, this returns true if the service returned a value for the SubnetIds 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.

subnetIds

public final List<String> subnetIds()

The subnets associated with your cluster.

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 hasSubnetIds() method.

Returns:

The subnets associated with your cluster.

hasSecurityGroupIds

public final boolean hasSecurityGroupIds()

For responses, this returns true if the service returned a value for the SecurityGroupIds 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.

securityGroupIds

public final List<String> securityGroupIds()

The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.

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 hasSecurityGroupIds() method.

Returns:

The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.

clusterSecurityGroupId

public final String clusterSecurityGroupId()

The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.

Returns:

The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.

vpcId

public final String vpcId()

The VPC associated with your cluster.

Returns:

The VPC associated with your cluster.

endpointPublicAccess

public final Boolean endpointPublicAccess()

This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.

Returns:

This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.

endpointPrivateAccess

public final Boolean endpointPrivateAccess()

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

Returns:

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

hasPublicAccessCidrs

public final boolean hasPublicAccessCidrs()

For responses, this returns true if the service returned a value for the PublicAccessCidrs 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.

publicAccessCidrs

public final 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 listed CIDR blocks is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. 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.

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 hasPublicAccessCidrs() method.

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 listed CIDR blocks is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

toBuilder

public VpcConfigResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VpcConfigResponse.Builder,VpcConfigResponse>

builder

public static VpcConfigResponse.Builder builder()

serializableBuilderClass

public static Class<? extends VpcConfigResponse.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