Skip to content

Latest commit

 

History

History
237 lines (141 loc) · 6.75 KB

API.md

File metadata and controls

237 lines (141 loc) · 6.75 KB
Raw

API Reference

Constructs

Karpenter

Initializers 

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.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
addProvisioner addProvisioner adds a provisioner manifest to the cluster.
toString 
public toString(): string

Returns a string representation of this construct.

addProvisioner 
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.

idRequired
  • Type: string

must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.

provisionerSpecRequired
  • Type: {[ key: string ]: any}

spec of Karpenters Provisioner object.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { Karpenter } from 'cdk-eks-karpenter'

Karpenter.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
cluster aws-cdk-lib.aws_eks.Cluster No description.
namespace string No description.
nodeRole aws-cdk-lib.aws_iam.Role No description.
version string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

clusterRequired 
public readonly cluster: Cluster;
  • Type: aws-cdk-lib.aws_eks.Cluster
namespaceRequired 
public readonly namespace: string;
  • Type: string
nodeRoleRequired 
public readonly nodeRole: Role;
  • Type: aws-cdk-lib.aws_iam.Role
versionOptional 
public readonly version: string;
  • Type: string

Structs

KarpenterProps

Initializer 

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.
namespace string The Kubernetes namespace to install to.
version string The helm chart version to install.
clusterRequired 
public readonly cluster: Cluster;
  • Type: aws-cdk-lib.aws_eks.Cluster

The EKS Cluster to attach to.

namespaceOptional 
public readonly namespace: string;
  • Type: string
  • Default: karpenter

The Kubernetes namespace to install to.

versionOptional 
public readonly version: string;
  • Type: string
  • Default: latest

The helm chart version to install.