@aws-quickstart/eks-blueprints
    Preparing search index...

    Interface AutomodeClusterProviderProps

    interface AutomodeClusterProviderProps {
        albController?: AlbControllerOptions;
        clusterLogging?: ClusterLoggingTypes[];
        clusterName?: string;
        coreDnsComputeType?: CoreDnsComputeType;
        endpointAccess?: EndpointAccess;
        extraNodeClasses?: { [key: string]: AutoModeNodeClassSpec };
        extraNodePools?: { [key: string]: AutoModeNodePoolSpec };
        id?: string;
        ipFamily?: IpFamily;
        kubectlProviderOptions?: KubectlProviderOptions;
        mastersRole?: IRole;
        nodePools?: string[];
        nodeRole?: IRole;
        prune?: boolean;
        remoteNodeNetworks?: RemoteNodeNetwork[];
        remotePodNetworks?: RemotePodNetwork[];
        removalPolicy?: RemovalPolicy;
        role?: IRole;
        secretsEncryptionKey?: IKeyRef;
        securityGroup?: ISecurityGroup;
        serviceIpv4Cidr?: string;
        tags?: { [key: string]: string };
        version?: KubernetesVersion;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection[];
    }

    Hierarchy

    • Partial<eks.ClusterCommonOptions>
      • AutomodeClusterProviderProps
    Index

    Properties

    albController? clusterLogging? clusterName? coreDnsComputeType? endpointAccess? extraNodeClasses? extraNodePools? id? ipFamily? kubectlProviderOptions? mastersRole? nodePools? nodeRole? prune? remoteNodeNetworks? remotePodNetworks? removalPolicy? role? secretsEncryptionKey? securityGroup? serviceIpv4Cidr? tags? version? vpc? vpcSubnets?

    Properties

    albController?: AlbControllerOptions

    Install the AWS Load Balancer Controller onto the cluster.

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

    - The controller is not installed.
    clusterLogging?: ClusterLoggingTypes[]

    The cluster log types which you want to enable.

    - none
    clusterName?: string

    Name for the cluster.

    - Automatically generated name
    coreDnsComputeType?: 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.

    CoreDnsComputeType.EC2 (for FargateCluster the default is FARGATE)

    endpointAccess?: EndpointAccess

    Configure access to the Kubernetes API server endpoint..

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

    EndpointAccess.PUBLIC_AND_PRIVATE
    extraNodeClasses?: { [key: string]: AutoModeNodeClassSpec }

    If using custom node classes, you must specify a non default node role. Otherwise delete will fail (https://github.com/aws/aws-cdk/issues/35475)

    extraNodePools?: { [key: string]: AutoModeNodePoolSpec }
    id?: string
    ipFamily?: IpFamily

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

    IpFamily.IP_V4

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

    kubectlProviderOptions?: KubectlProviderOptions

    Options for creating the kubectl provider - a lambda function that executes kubectl and helm against the cluster. If defined, kubectlLayer is a required property.

    - kubectl provider will not be created
    mastersRole?: IRole

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

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

    - no masters role.
    nodePools?: string[]

    @default: ['system,'general-purpose']

    nodeRole?: IRole

    @default: generated by CDK

    prune?: boolean

    Indicates whether Kubernetes resources added through addManifest() can be automatically pruned. 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.

    true
    remoteNodeNetworks?: RemoteNodeNetwork[]

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

    - none
    remotePodNetworks?: RemotePodNetwork[]

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

    - none
    removalPolicy?: RemovalPolicy

    The removal policy applied to all CloudFormation resources created by this construct when they are no longer managed by CloudFormation.

    This can happen in one of three situations:

    • The resource is removed from the template, so CloudFormation stops managing it;
    • A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it;
    • The stack is deleted, so CloudFormation stops managing all resources in it.

    This affects the EKS cluster itself, associated IAM roles, node groups, security groups, VPC and any other CloudFormation resources managed by this construct.

    - Resources will be deleted.
    role?: IRole

    Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

    - A role is automatically created for you
    secretsEncryptionKey?: IKeyRef

    KMS secret for envelope encryption for Kubernetes secrets.

    - 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.
    securityGroup?: ISecurityGroup

    Security Group to use for Control Plane ENIs

    - A security group is automatically created
    serviceIpv4Cidr?: string

    The CIDR block to assign Kubernetes service IP addresses from.

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

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

    tags?: { [key: string]: string }

    The tags assigned to the EKS cluster

    - none
    version?: KubernetesVersion

    The Kubernetes version to run in the cluster

    vpc?: IVpc

    The VPC in which to create the Cluster.

    • a VPC with default configuration will be created and can be accessed through cluster.vpc.
    vpcSubnets?: SubnetSelection[]

    Where to place EKS Control Plane ENIs

    For example, to only select private subnets, supply the following:

    vpcSubnets: [{ subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }]

    - All public and private subnets

    Settings

    Member Visibility

    On This Page

    Properties