# API Reference
## Constructs
### Karpenter
#### Initializers
```typescript
import { Karpenter } from 'cdk-eks-karpenter'
new Karpenter(scope: Construct, id: string, props: KarpenterProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | KarpenterProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* KarpenterProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| with | Applies one or more mixins to this construct. |
| addEC2NodeClass | addEC2NodeClass adds a EC2NodeClass to the Karpenter configuration. |
| addManagedPolicyToKarpenterRole | addManagedPolicyToKarpenterRole adds Managed Policies To Karpenter Role. |
| addNodePool | addNodePool adds a NodePool to the Karpenter configuration. |
| addNodeTemplate | addNodeTemplate adds a node template manifest to the cluster. |
| addProvisioner | addProvisioner adds a provisioner manifest to the cluster. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `with`
```typescript
public with(mixins: ...IMixin[]): IConstruct
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
###### `mixins`Required
- *Type:* ...constructs.IMixin[]
The mixins to apply.
---
##### `addEC2NodeClass`
```typescript
public addEC2NodeClass(id: string, ec2NodeClassSpec: {[ key: string ]: any}): {[ key: string ]: any}
```
addEC2NodeClass adds a EC2NodeClass to the Karpenter configuration.
###### `id`Required
- *Type:* string
must consist of lower case alphanumeric characters, \'-\' or \'.\', and must start and end with an alphanumeric character.
---
###### `ec2NodeClassSpec`Required
- *Type:* {[ key: string ]: any}
spec of Karpenters EC2NodeClass API.
---
##### `addManagedPolicyToKarpenterRole`
```typescript
public addManagedPolicyToKarpenterRole(managedPolicy: IManagedPolicy): void
```
addManagedPolicyToKarpenterRole adds Managed Policies To Karpenter Role.
###### `managedPolicy`Required
- *Type:* aws-cdk-lib.aws_iam.IManagedPolicy
iam managed policy to add to the karpenter role.
---
##### `addNodePool`
```typescript
public addNodePool(id: string, nodePoolSpec: {[ key: string ]: any}): {[ key: string ]: any}
```
addNodePool adds a NodePool to the Karpenter configuration.
###### `id`Required
- *Type:* string
must consist of lower case alphanumeric characters, \'-\' or \'.\', and must start and end with an alphanumeric character.
---
###### `nodePoolSpec`Required
- *Type:* {[ key: string ]: any}
spec of Karpenters NodePool API.
---
##### ~~`addNodeTemplate`~~
```typescript
public addNodeTemplate(id: string, nodeTemplateSpec: {[ key: string ]: any}): void
```
addNodeTemplate adds a node template manifest to the cluster.
Currently the node template spec
parameter is relatively free form.
###### `id`Required
- *Type:* string
must consist of lower case alphanumeric characters, \'-\' or \'.\', and must start and end with an alphanumeric character.
---
###### `nodeTemplateSpec`Required
- *Type:* {[ key: string ]: any}
spec of Karpenters Node Template object.
---
##### ~~`addProvisioner`~~
```typescript
public addProvisioner(id: string, provisionerSpec: {[ key: string ]: any}): void
```
addProvisioner adds a provisioner manifest to the cluster.
Currently the provisioner spec
parameter is relatively free form.
###### `id`Required
- *Type:* string
must consist of lower case alphanumeric characters, \'-\' or \'.\', and must start and end with an alphanumeric character.
---
###### `provisionerSpec`Required
- *Type:* {[ key: string ]: any}
spec of Karpenters Provisioner object.
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { Karpenter } from 'cdk-eks-karpenter'
Karpenter.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| cluster | aws-cdk-lib.aws_eks.Cluster | *No description.* |
| helmExtraValues | any | *No description.* |
| namespace | string | *No description.* |
| nodeRole | aws-cdk-lib.aws_iam.Role | *No description.* |
| serviceAccountName | string | *No description.* |
| version | string | *No description.* |
| helmChartValues | {[ key: string ]: any} | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `cluster`Required
```typescript
public readonly cluster: Cluster;
```
- *Type:* aws-cdk-lib.aws_eks.Cluster
---
##### `helmExtraValues`Required
```typescript
public readonly helmExtraValues: any;
```
- *Type:* any
---
##### `namespace`Required
```typescript
public readonly namespace: string;
```
- *Type:* string
---
##### `nodeRole`Required
```typescript
public readonly nodeRole: Role;
```
- *Type:* aws-cdk-lib.aws_iam.Role
---
##### `serviceAccountName`Required
```typescript
public readonly serviceAccountName: string;
```
- *Type:* string
---
##### `version`Required
```typescript
public readonly version: string;
```
- *Type:* string
---
##### `helmChartValues`Required
```typescript
public readonly helmChartValues: {[ key: string ]: any};
```
- *Type:* {[ key: string ]: any}
---
## Structs
### KarpenterProps
#### Initializer
```typescript
import { KarpenterProps } from 'cdk-eks-karpenter'
const karpenterProps: KarpenterProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| cluster | aws-cdk-lib.aws_eks.Cluster | The EKS Cluster to attach to. |
| version | string | The helm chart version to install. |
| helmExtraValues | {[ key: string ]: any} | Extra values to pass to the Karpenter Helm chart. |
| namespace | string | The Kubernetes namespace to install to. |
| nodeRole | aws-cdk-lib.aws_iam.Role | Custom NodeRole to pass for Karpenter Nodes. |
| serviceAccountName | string | The Kubernetes ServiceAccount name to use. |
---
##### `cluster`Required
```typescript
public readonly cluster: Cluster;
```
- *Type:* aws-cdk-lib.aws_eks.Cluster
The EKS Cluster to attach to.
---
##### `version`Required
```typescript
public readonly version: string;
```
- *Type:* string
- *Default:* latest
The helm chart version to install.
---
##### `helmExtraValues`Optional
```typescript
public readonly helmExtraValues: {[ key: string ]: any};
```
- *Type:* {[ key: string ]: any}
Extra values to pass to the Karpenter Helm chart.
---
##### `namespace`Optional
```typescript
public readonly namespace: string;
```
- *Type:* string
- *Default:* karpenter
The Kubernetes namespace to install to.
---
##### `nodeRole`Optional
```typescript
public readonly nodeRole: Role;
```
- *Type:* aws-cdk-lib.aws_iam.Role
Custom NodeRole to pass for Karpenter Nodes.
---
##### `serviceAccountName`Optional
```typescript
public readonly serviceAccountName: string;
```
- *Type:* string
- *Default:* karpenter
The Kubernetes ServiceAccount name to use.
---