Interface IClusterOptions

Options for EKS clusters.

Inherited Members
Namespace: Amazon.CDK.AWS.EKS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IClusterOptions : ICommonClusterOptions
Syntax (vb)
Public Interface IClusterOptions
    Inherits ICommonClusterOptions
Remarks

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;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.EKS;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.KMS;
using Amazon.CDK.AWS.Lambda;

AlbControllerVersion albControllerVersion;
EndpointAccess endpointAccess;
Key key;
KubernetesVersion kubernetesVersion;
LayerVersion layerVersion;
var policy;
Role role;
SecurityGroup securityGroup;
Size size;
Subnet subnet;
SubnetFilter subnetFilter;
Vpc vpc;

var clusterOptions = new ClusterOptions {
    KubectlLayer = layerVersion,
    Version = kubernetesVersion,

    // the properties below are optional
    AlbController = new AlbControllerOptions {
        Version = albControllerVersion,

        // the properties below are optional
        Policy = policy,
        Repository = "repository"
    },
    AuthenticationMode = AuthenticationMode.CONFIG_MAP,
    AwscliLayer = layerVersion,
    ClusterHandlerEnvironment = new Dictionary<string, string> {
        { "clusterHandlerEnvironmentKey", "clusterHandlerEnvironment" }
    },
    ClusterHandlerSecurityGroup = securityGroup,
    ClusterLogging = new [] { ClusterLoggingTypes.API },
    ClusterName = "clusterName",
    CoreDnsComputeType = CoreDnsComputeType.EC2,
    EndpointAccess = endpointAccess,
    IpFamily = IpFamily.IP_V4,
    KubectlEnvironment = new Dictionary<string, string> {
        { "kubectlEnvironmentKey", "kubectlEnvironment" }
    },
    KubectlMemory = size,
    MastersRole = role,
    OnEventLayer = layerVersion,
    OutputClusterName = false,
    OutputConfigCommand = false,
    OutputMastersRoleArn = false,
    PlaceClusterHandlerInVpc = false,
    Prune = false,
    RemoteNodeNetworks = new [] { new RemoteNodeNetwork {
        Cidrs = new [] { "cidrs" }
    } },
    RemotePodNetworks = new [] { new RemotePodNetwork {
        Cidrs = new [] { "cidrs" }
    } },
    Role = role,
    SecretsEncryptionKey = key,
    SecurityGroup = securityGroup,
    ServiceIpv4Cidr = "serviceIpv4Cidr",
    Vpc = vpc,
    VpcSubnets = new [] { new SubnetSelection {
        AvailabilityZones = new [] { "availabilityZones" },
        OnePerAz = false,
        SubnetFilters = new [] { subnetFilter },
        SubnetGroupName = "subnetGroupName",
        Subnets = new [] { subnet },
        SubnetType = SubnetType.PRIVATE_ISOLATED
    } }
};

Synopsis

Properties

AlbController

Install the AWS Load Balancer Controller onto the cluster.
AuthenticationMode

The desired authentication mode for the cluster.
AwscliLayer

An AWS Lambda layer that contains the aws CLI.
ClusterHandlerEnvironment

Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.
ClusterHandlerSecurityGroup

A security group to associate with the Cluster Handler's Lambdas.
ClusterLogging

The cluster log types which you want to enable.
CoreDnsComputeType

Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.
EndpointAccess

Configure access to the Kubernetes API server endpoint..
IpFamily

Specify which IP family is used to assign Kubernetes pod and service IP addresses.
KubectlEnvironment

Environment variables for the kubectl execution.
KubectlLayer

An AWS Lambda Layer which includes kubectl and Helm.
KubectlMemory

Amount of memory to allocate to the provider's lambda function.
MastersRole

An IAM role that will be added to the system:masters Kubernetes RBAC group.
OnEventLayer

An AWS Lambda Layer which includes the NPM dependency proxy-agent.
OutputMastersRoleArn

Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if mastersRole is specified).
PlaceClusterHandlerInVpc

If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the vpcSubnets selection strategy.
Prune

Indicates whether Kubernetes resources added through addManifest() can be automatically pruned.
RemoteNodeNetworks

IPv4 CIDR blocks defining the expected address range of hybrid nodes that will join the cluster.
RemotePodNetworks

IPv4 CIDR blocks for Pods running Kubernetes webhooks on hybrid nodes.
SecretsEncryptionKey

KMS secret for envelope encryption for Kubernetes secrets.
ServiceIpv4Cidr

The CIDR block to assign Kubernetes service IP addresses from.

Properties

AlbController

Install the AWS Load Balancer Controller onto the cluster.

virtual IAlbControllerOptions AlbController { get; }
Property Value

IAlbControllerOptions

Remarks

Default: - The controller is not installed.

See: https://kubernetes-sigs.github.io/aws-load-balancer-controller

AuthenticationMode

The desired authentication mode for the cluster.

virtual Nullable<AuthenticationMode> AuthenticationMode { get; }
Property Value

System.Nullable<AuthenticationMode>

Remarks

Default: AuthenticationMode.CONFIG_MAP

AwscliLayer

An AWS Lambda layer that contains the aws CLI.

virtual ILayerVersion AwscliLayer { get; }
Property Value

ILayerVersion

Remarks

The handler expects the layer to include the following executables:

/opt/awscli/aws

Default: - a default layer with the AWS CLI 1.x

ClusterHandlerEnvironment

Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.

virtual IDictionary<string, string> ClusterHandlerEnvironment { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Remarks

Default: - No environment variables.

ClusterHandlerSecurityGroup

A security group to associate with the Cluster Handler's Lambdas.

virtual ISecurityGroup ClusterHandlerSecurityGroup { get; }
Property Value

ISecurityGroup

Remarks

The Cluster Handler's Lambdas are responsible for calling AWS's EKS API.

Requires placeClusterHandlerInVpc to be set to true.

Default: - No security group.

ClusterLogging

The cluster log types which you want to enable.

virtual ClusterLoggingTypes[] ClusterLogging { get; }
Property Value

ClusterLoggingTypes[]

Remarks

Default: - none

CoreDnsComputeType

Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.

virtual Nullable<CoreDnsComputeType> CoreDnsComputeType { get; }
Property Value

System.Nullable<CoreDnsComputeType>

Remarks

Default: CoreDnsComputeType.EC2 (for FargateCluster the default is FARGATE)

EndpointAccess

Configure access to the Kubernetes API server endpoint..

virtual EndpointAccess EndpointAccess { get; }
Property Value

EndpointAccess

Remarks

Default: EndpointAccess.PUBLIC_AND_PRIVATE

See: https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html

IpFamily

Specify which IP family is used to assign Kubernetes pod and service IP addresses.

virtual Nullable<IpFamily> IpFamily { get; }
Property Value

System.Nullable<IpFamily>

Remarks

Default: - IpFamily.IP_V4

See: https://docs.aws.amazon.com/eks/latest/APIReference/API_KubernetesNetworkConfigRequest.html#AmazonEKS-Type-KubernetesNetworkConfigRequest-ipFamily

KubectlEnvironment

Environment variables for the kubectl execution.

virtual IDictionary<string, string> KubectlEnvironment { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Remarks

Only relevant for kubectl enabled clusters.

Default: - No environment variables.

KubectlLayer

An AWS Lambda Layer which includes kubectl and Helm.

ILayerVersion KubectlLayer { get; }
Property Value

ILayerVersion

Remarks

This layer is used by the kubectl handler to apply manifests and install helm charts. You must pick an appropriate releases of one of the @aws-cdk/layer-kubectl-vXX packages, that works with the version of Kubernetes you have chosen.

The handler expects the layer to include the following executables:

/opt/helm/helm
/opt/kubectl/kubectl

KubectlMemory

Amount of memory to allocate to the provider's lambda function.

virtual Size KubectlMemory { get; }
Property Value

Size

Remarks

Default: Size.gibibytes(1)

MastersRole

An IAM role that will be added to the system:masters Kubernetes RBAC group.

virtual IRole MastersRole { get; }
Property Value

IRole

Remarks

Default: - no masters role.

See: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings

OnEventLayer

An AWS Lambda Layer which includes the NPM dependency proxy-agent.

virtual ILayerVersion OnEventLayer { get; }
Property Value

ILayerVersion

Remarks

This layer is used by the onEvent handler to route AWS SDK requests through a proxy.

By default, the provider will use the layer included in the "aws-lambda-layer-node-proxy-agent" SAR application which is available in all commercial regions.

To deploy the layer locally define it in your app as follows:

var layer = new LayerVersion(this, "proxy-agent-layer", new LayerVersionProps {
    Code = Code.FromAsset($"{__dirname}/layer.zip"),
    CompatibleRuntimes = new [] { Runtime.NODEJS_LATEST }
});

Default: - a layer bundled with this module.

OutputMastersRoleArn

Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if mastersRole is specified).

virtual Nullable<bool> OutputMastersRoleArn { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

PlaceClusterHandlerInVpc

If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the vpcSubnets selection strategy.

virtual Nullable<bool> PlaceClusterHandlerInVpc { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

Prune

Indicates whether Kubernetes resources added through addManifest() can be automatically pruned.

virtual Nullable<bool> Prune { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

When this is enabled (default), prune labels will be allocated and injected to each resource. These labels will then be used when issuing the kubectl apply operation with the --prune switch.

Default: true

RemoteNodeNetworks

IPv4 CIDR blocks defining the expected address range of hybrid nodes that will join the cluster.

virtual IRemoteNodeNetwork[] RemoteNodeNetworks { get; }
Property Value

IRemoteNodeNetwork[]

Remarks

Default: - none

RemotePodNetworks

IPv4 CIDR blocks for Pods running Kubernetes webhooks on hybrid nodes.

virtual IRemotePodNetwork[] RemotePodNetworks { get; }
Property Value

IRemotePodNetwork[]

Remarks

Default: - none

SecretsEncryptionKey

KMS secret for envelope encryption for Kubernetes secrets.

virtual IKey SecretsEncryptionKey { get; }
Property Value

IKey

Remarks

Default: - By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys.

ServiceIpv4Cidr

The CIDR block to assign Kubernetes service IP addresses from.

virtual string ServiceIpv4Cidr { get; }
Property Value

System.String

Remarks

Default: - Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks

See: https://docs.aws.amazon.com/eks/latest/APIReference/API_KubernetesNetworkConfigRequest.html#AmazonEKS-Type-KubernetesNetworkConfigRequest-serviceIpv4Cidr