Interface CfnCluster.IResourcesVpcConfigProperty
An object representing the VPC configuration to use for an Amazon EKS cluster.
Namespace: Amazon.CDK.AWS.EKS.Legacy
Assembly: Amazon.CDK.AWS.EKS.Legacy.dll
Syntax (csharp)
public interface IResourcesVpcConfigProperty
Syntax (vb)
Public Interface IResourcesVpcConfigProperty
Remarks
When updating a resource, you must include these properties if the previous CloudFormation template of the resource had them:
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EKS.Legacy;
var resourcesVpcConfigProperty = new ResourcesVpcConfigProperty {
SubnetIds = new [] { "subnetIds" },
// the properties below are optional
EndpointPrivateAccess = false,
EndpointPublicAccess = false,
PublicAccessCidrs = new [] { "publicAccessCidrs" },
SecurityGroupIds = new [] { "securityGroupIds" }
};
Synopsis
Properties
EndpointPrivateAccess | Set this value to |
EndpointPublicAccess | Set this value to |
PublicAccessCidrs | The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. |
SecurityGroupIds | Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane. |
SubnetIds | Specify subnets for your Amazon EKS nodes. |
Properties
EndpointPrivateAccess
Set this value to true
to enable private access for your cluster's Kubernetes API server endpoint.
virtual object EndpointPrivateAccess { get; }
Property Value
System.Object
Remarks
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 nodes or AWS 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 .
EndpointPublicAccess
Set this value to false
to disable public access to your cluster's Kubernetes API server endpoint.
virtual object EndpointPublicAccess { get; }
Property Value
System.Object
Remarks
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 .
PublicAccessCidrs
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint.
virtual string[] PublicAccessCidrs { get; }
Property Value
System.String[]
Remarks
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 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 .
SecurityGroupIds
Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane.
virtual string[] SecurityGroupIds { get; }
Property Value
System.String[]
Remarks
If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes. For more information, see Amazon EKS security group considerations in the Amazon EKS User Guide .
SubnetIds
Specify subnets for your Amazon EKS nodes.
string[] SubnetIds { get; }
Property Value
System.String[]
Remarks
Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.