Skip to content

VpcConfigResponse

Source code in docs_src/capo_eks/types/vpc_config_response.py
class VpcConfigResponse(TypedDict, closed=True):
    subnet_ids: NotRequired["capo_eks.types.string_list.StringList"]
    """<p>The subnets associated with your cluster.</p>"""
    security_group_ids: NotRequired["capo_eks.types.string_list.StringList"]
    """<p>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.</p>"""
    cluster_security_group_id: NotRequired["capo_eks.types.string.String"]
    """<p>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.</p>"""
    vpc_id: NotRequired["capo_eks.types.string.String"]
    """<p>The VPC associated with your cluster.</p>"""
    endpoint_public_access: "capo_eks.types.boolean.Boolean"
    """<p>Whether the public API server endpoint is enabled.</p>"""
    endpoint_private_access: "capo_eks.types.boolean.Boolean"
    """<p>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 <code>publicAccessCidrs</code> includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html">Cluster API server endpoint</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"""
    public_access_cidrs: NotRequired["capo_eks.types.string_list.StringList"]
    """<p>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 <code>0.0.0.0/0</code> and additionally <code>::/0</code> 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 <code>Pod</code> in the cluster. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html">Cluster API server endpoint</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p> <p>Note that the public endpoints are dual-stack for only <code>IPv6</code> clusters that are made after October 2024. You can't add <code>IPv6</code> CIDR blocks to <code>IPv4</code> clusters or <code>IPv6</code> clusters that were made before October 2024.</p>"""
    control_plane_egress_mode: NotRequired[
        "capo_eks.types.control_plane_egress_mode_type.ControlPlaneEgressModeType"
    ]
    """<p>The current control plane egress routing mode for the cluster. If the cluster is set to <code>AWS_MANAGED</code>, Amazon EKS manages the egress path from the control plane. If the cluster is set to <code>CUSTOMER_ROUTED</code>, you manage the egress path from the control plane in your VPC subnets.</p> <p> <a href="https://docs.aws.amazon.com/eks/latest/userguide/control-plane-egress.html">Learn more about control plane egress routing in the <i>Amazon EKS User Guide</i>.</a> </p>"""

cluster_security_group_id instance-attribute

cluster_security_group_id: NotRequired[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.

control_plane_egress_mode instance-attribute

control_plane_egress_mode: NotRequired[ControlPlaneEgressModeType]

The current control plane egress routing mode for the cluster. If the cluster is set to AWS_MANAGED, Amazon EKS manages the egress path from the control plane. If the cluster is set to CUSTOMER_ROUTED, you manage the egress path from the control plane in your VPC subnets.

Learn more about control plane egress routing in the Amazon EKS User Guide.

endpoint_private_access instance-attribute

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 .

endpoint_public_access instance-attribute

endpoint_public_access: Boolean

Whether the public API server endpoint is enabled.

public_access_cidrs instance-attribute

public_access_cidrs: NotRequired[StringList]

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.

security_group_ids instance-attribute

security_group_ids: NotRequired[StringList]

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 instance-attribute

subnet_ids: NotRequired[StringList]

The subnets associated with your cluster.

vpc_id instance-attribute

vpc_id: NotRequired[String]

The VPC associated with your cluster.