Class: Aws::EKS::Types::VpcConfigResponse

Inherits:

Struct

• Object
• Struct
• Aws::EKS::Types::VpcConfigResponse

Includes:

Structure

Defined in:

lib/aws-sdk-eks/types.rb

Overview

An object representing an Amazon EKS cluster VPC configuration response.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cluster_security_group_id ⇒ String

  The cluster security group that was created by Amazon EKS for the cluster.

• #endpoint_private_access ⇒ Boolean

  This parameter indicates whether the Amazon EKS private API server endpoint is enabled.

• #endpoint_public_access ⇒ Boolean

  Whether the public API server endpoint is enabled.

• #public_access_cidrs ⇒ Array<String>

  The CIDR blocks that are allowed access to your cluster’s public Kubernetes API server endpoint.

• #security_group_ids ⇒ Array<String>

  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.

• #subnet_ids ⇒ Array<String>

  The subnets associated with your cluster.

• #vpc_id ⇒ String

  The VPC associated with your cluster.

Instance Attribute Details

#cluster_security_group_id ⇒ String

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:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 7714

class VpcConfigResponse < Struct.new(
  :subnet_ids,
  :security_group_ids,
  :cluster_security_group_id,
  :vpc_id,
  :endpoint_public_access,
  :endpoint_private_access,
  :public_access_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_private_access ⇒ Boolean

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 [Cluster API server endpoint] in the Amazon EKS User Guide .

[1]: docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-eks/types.rb', line 7714

class VpcConfigResponse < Struct.new(
  :subnet_ids,
  :security_group_ids,
  :cluster_security_group_id,
  :vpc_id,
  :endpoint_public_access,
  :endpoint_private_access,
  :public_access_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_public_access ⇒ Boolean

Whether the public API server endpoint is enabled.

Returns:

• (Boolean)

# File 'lib/aws-sdk-eks/types.rb', line 7714

class VpcConfigResponse < Struct.new(
  :subnet_ids,
  :security_group_ids,
  :cluster_security_group_id,
  :vpc_id,
  :endpoint_public_access,
  :endpoint_private_access,
  :public_access_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#public_access_cidrs ⇒ Array<String>

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` and additionally `::/0` for dual-stack `IPv6` clusters. If you’ve disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate ‘Pod` in the cluster. For more information, see [Cluster API server endpoint] in the Amazon EKS User Guide .

Note that the public endpoints are dual-stack for only ‘IPv6` clusters that are made after October 2024. You can’t add ‘IPv6` CIDR blocks to `IPv4` clusters or `IPv6` clusters that were made before October 2024.

[1]: docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-eks/types.rb', line 7714

class VpcConfigResponse < Struct.new(
  :subnet_ids,
  :security_group_ids,
  :cluster_security_group_id,
  :vpc_id,
  :endpoint_public_access,
  :endpoint_private_access,
  :public_access_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-eks/types.rb', line 7714

class VpcConfigResponse < Struct.new(
  :subnet_ids,
  :security_group_ids,
  :cluster_security_group_id,
  :vpc_id,
  :endpoint_public_access,
  :endpoint_private_access,
  :public_access_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

The subnets associated with your cluster.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-eks/types.rb', line 7714

class VpcConfigResponse < Struct.new(
  :subnet_ids,
  :security_group_ids,
  :cluster_security_group_id,
  :vpc_id,
  :endpoint_public_access,
  :endpoint_private_access,
  :public_access_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The VPC associated with your cluster.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 7714

class VpcConfigResponse < Struct.new(
  :subnet_ids,
  :security_group_ids,
  :cluster_security_group_id,
  :vpc_id,
  :endpoint_public_access,
  :endpoint_private_access,
  :public_access_cidrs)
  SENSITIVE = []
  include Aws::Structure
end