Interface ImportClusterProviderProps

Properties object for the ImportClusterProvider.

interface ImportClusterProviderProps {
    awscliLayer?: ILayerVersion;
    clusterCertificateAuthorityData?: string;
    clusterEncryptionConfigKeyArn?: string;
    clusterEndpoint?: string;
    clusterHandlerSecurityGroupId?: string;
    clusterName: string;
    clusterSecurityGroupId?: string;
    id?: string;
    ipFamily?: IpFamily;
    kubectlEnvironment?: {
        [name: string]: string;
    };
    kubectlLambdaRole?: IRole;
    kubectlLayer?: ILayerVersion;
    kubectlMemory?: Size;
    kubectlPrivateSubnetIds?: string[];
    kubectlProvider?: IKubectlProvider;
    kubectlRoleArn?: string;
    kubectlSecurityGroupId?: string;
    onEventLayer?: ILayerVersion;
    openIdConnectProvider?: IOpenIdConnectProvider;
    prune?: boolean;
    securityGroupIds?: string[];
    version: KubernetesVersion;
}

Hierarchy

  • Omit<eks.ClusterAttributes, "vpc">
    • ImportClusterProviderProps

Properties

awscliLayer? clusterCertificateAuthorityData? clusterEncryptionConfigKeyArn? clusterEndpoint? clusterHandlerSecurityGroupId? clusterName clusterSecurityGroupId? id? ipFamily? kubectlEnvironment? kubectlLambdaRole? kubectlLayer? kubectlMemory? kubectlPrivateSubnetIds? kubectlProvider? kubectlRoleArn? kubectlSecurityGroupId? onEventLayer? openIdConnectProvider? prune? securityGroupIds? version

Properties

Optional ReadonlyawscliLayer

awscliLayer?: ILayerVersion

An AWS Lambda layer that contains the aws CLI.

The handler expects the layer to include the following executables:

/opt/awscli/aws

Default

- a default layer with the AWS CLI 1.x

Optional ReadonlyclusterCertificateAuthorityData

clusterCertificateAuthorityData?: string

The certificate-authority-data for your cluster.

Default

  • if not specified cluster.clusterCertificateAuthorityData will throw an error

Optional ReadonlyclusterEncryptionConfigKeyArn

clusterEncryptionConfigKeyArn?: string

Amazon Resource Name (ARN) or alias of the customer master key (CMK).

Default

  • if not specified cluster.clusterEncryptionConfigKeyArn will throw an error

Optional ReadonlyclusterEndpoint

clusterEndpoint?: string

The API Server endpoint URL

Default

  • if not specified cluster.clusterEndpoint will throw an error.

Optional ReadonlyclusterHandlerSecurityGroupId

clusterHandlerSecurityGroupId?: string

A security group id to associate with the Cluster Handler's Lambdas. The Cluster Handler's Lambdas are responsible for calling AWS's EKS API.

Default

- No security group.

ReadonlyclusterName

clusterName: string

The physical name of the Cluster

Optional ReadonlyclusterSecurityGroupId

clusterSecurityGroupId?: string

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

Default

  • if not specified cluster.clusterSecurityGroupId will throw an error

Optionalid

id?: string

Used for the CDK construct id for the imported cluster. Useful when passing tokens for cluster name.

Optional ReadonlyipFamily

ipFamily?: IpFamily

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

Default

- IpFamily.IP_V4

See

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

Optional ReadonlykubectlEnvironment

kubectlEnvironment?: {
    [name: string]: string;
}

Environment variables to use when running kubectl against this cluster.

Default

- no additional variables

Optional ReadonlykubectlLambdaRole

kubectlLambdaRole?: IRole

An IAM role that can perform kubectl operations against this cluster.

The role should be mapped to the system:masters Kubernetes RBAC role.

This role is directly passed to the lambda handler that sends Kube Ctl commands to the cluster.

Default

- if not specified, the default role created by a lambda function will
be used.

Optional ReadonlykubectlLayer

kubectlLayer?: ILayerVersion

An AWS Lambda Layer which includes kubectl and Helm.

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. If you don't supply this value kubectl 1.20 will be used, but that version is most likely too old.

The handler expects the layer to include the following executables:

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

Default

- a default layer with Kubectl 1.20 and helm 3.8.

Optional ReadonlykubectlMemory

kubectlMemory?: Size

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

Default

Size.gibibytes(1)

Optional ReadonlykubectlPrivateSubnetIds

kubectlPrivateSubnetIds?: string[]

Subnets to host the kubectl compute resources. If not specified, the k8s endpoint is expected to be accessible publicly.

Default

- k8s endpoint is expected to be accessible publicly

Optional ReadonlykubectlProvider

kubectlProvider?: IKubectlProvider

KubectlProvider for issuing kubectl commands.

Default

- Default CDK provider

Optional ReadonlykubectlRoleArn

kubectlRoleArn?: string

An IAM role with cluster administrator and "system:masters" permissions.

Default

  • if not specified, it not be possible to issue kubectl commands against an imported cluster.

Optional ReadonlykubectlSecurityGroupId

kubectlSecurityGroupId?: string

A security group to use for kubectl execution. If not specified, the k8s endpoint is expected to be accessible publicly.

Default

- k8s endpoint is expected to be accessible publicly

Optional ReadonlyonEventLayer

onEventLayer?: ILayerVersion

An AWS Lambda Layer which includes the NPM dependency proxy-agent. This layer is used by the onEvent handler to route AWS SDK requests through a proxy.

The handler expects the layer to include the following node_modules:

proxy-agent

Default

- a layer bundled with this module.

Optional ReadonlyopenIdConnectProvider

openIdConnectProvider?: IOpenIdConnectProvider

An Open ID Connect provider for this cluster that can be used to configure service accounts. You can either import an existing provider using iam.OpenIdConnectProvider.fromProviderArn, or create a new provider using new eks.OpenIdConnectProvider

Default

  • if not specified cluster.openIdConnectProvider and cluster.addServiceAccount will throw an error.

Optional Readonlyprune

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.

Default

true

Optional ReadonlysecurityGroupIds

securityGroupIds?: string[]

Additional security groups associated with this cluster.

Default

  • if not specified, no additional security groups will be considered in cluster.connections.

version

version: KubernetesVersion

This property is needed as it drives selection of certain add-on versions as well as kubectl layer.

Settings

Member Visibility

On This Page

Properties