Skip to content

Latest commit

 

History

History
2152 lines (1287 loc) · 64.1 KB

API.md

File metadata and controls

2152 lines (1287 loc) · 64.1 KB

API Reference

Constructs

Addon

Initializers

import { Addon } from '@pepperize/cdk-eks'

new Addon(scope: Construct, id: string, props: AddonProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props AddonProps No description.

scopeRequired
  • Type: constructs.Construct

idRequired
  • Type: string

propsRequired

Methods

Name Description
toString Returns a string representation of this construct.

toString
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.

isConstruct
import { Addon } from '@pepperize/cdk-eks'

Addon.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


Properties

Name Type Description
node constructs.Node The tree node.
serviceAccount aws-cdk-lib.aws_eks.ServiceAccount No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


serviceAccountOptional
public readonly serviceAccount: ServiceAccount;
  • Type: aws-cdk-lib.aws_eks.ServiceAccount

AwsLoadBalancerController

Initializers

import { AwsLoadBalancerController } from '@pepperize/cdk-eks'

new AwsLoadBalancerController(scope: Construct, id: string, props: AwsLoadBalancerControllerProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props AwsLoadBalancerControllerProps No description.

scopeRequired
  • Type: constructs.Construct

idRequired
  • Type: string

propsRequired

Methods

Name Description
toString Returns a string representation of this construct.

toString
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.

isConstruct
import { AwsLoadBalancerController } from '@pepperize/cdk-eks'

AwsLoadBalancerController.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.ICluster No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


clusterRequired
public readonly cluster: ICluster;
  • Type: aws-cdk-lib.aws_eks.ICluster

CloudwatchMetrics

Set up Container Insights to collect cluster metrics.

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Container-Insights-setup-metrics.html

Initializers

import { CloudwatchMetrics } from '@pepperize/cdk-eks'

new CloudwatchMetrics(scope: Construct, id: string, props: CloudwatchMetricsProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props CloudwatchMetricsProps No description.

scopeRequired
  • Type: constructs.Construct

idRequired
  • Type: string

propsRequired

Methods

Name Description
toString Returns a string representation of this construct.

toString
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.

isConstruct
import { CloudwatchMetrics } from '@pepperize/cdk-eks'

CloudwatchMetrics.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


Properties

Name Type Description
node constructs.Node The tree node.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


Cluster

  • Implements: aws-cdk-lib.ITaggable

Initializers

import { Cluster } from '@pepperize/cdk-eks'

new Cluster(scope: Construct, id: string, props: ClusterProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props ClusterProps No description.

scopeRequired
  • Type: constructs.Construct

idRequired
  • Type: string

propsRequired

Methods

Name Description
toString Returns a string representation of this construct.

toString
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.

isConstruct
import { Cluster } from '@pepperize/cdk-eks'

Cluster.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


Properties

Name Type Description
node constructs.Node The tree node.
albController aws-cdk-lib.aws_eks.AlbController No description.
autoscaling cdk-karpenter.Karpenter No description.
externalDns ExternalDns No description.
externalSecrets ExternalSecrets No description.
logging FluentBit No description.
mainRole aws-cdk-lib.aws_iam.IRole No description.
metrics CloudwatchMetrics No description.
resource aws-cdk-lib.aws_eks.Cluster No description.
tags aws-cdk-lib.TagManager TagManager to set, remove and format tags.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


albControllerRequired
public readonly albController: AlbController;
  • Type: aws-cdk-lib.aws_eks.AlbController

autoscalingRequired
public readonly autoscaling: Karpenter;
  • Type: cdk-karpenter.Karpenter

externalDnsRequired
public readonly externalDns: ExternalDns;

externalSecretsRequired
public readonly externalSecrets: ExternalSecrets;

loggingRequired
public readonly logging: FluentBit;

mainRoleRequired
public readonly mainRole: IRole;
  • Type: aws-cdk-lib.aws_iam.IRole

metricsRequired
public readonly metrics: CloudwatchMetrics;

resourceRequired
public readonly resource: Cluster;
  • Type: aws-cdk-lib.aws_eks.Cluster

tagsRequired
public readonly tags: TagManager;
  • Type: aws-cdk-lib.TagManager

TagManager to set, remove and format tags.


EbsCsiDriver

https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html.

Initializers

import { EbsCsiDriver } from '@pepperize/cdk-eks'

new EbsCsiDriver(scope: Construct, id: string, props: EbsCsiDriverProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props EbsCsiDriverProps No description.

scopeRequired
  • Type: constructs.Construct

idRequired
  • Type: string

propsRequired

Methods

Name Description
toString Returns a string representation of this construct.

toString
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
create Create the driver construct associated with this cluster and scope.

isConstruct
import { EbsCsiDriver } from '@pepperize/cdk-eks'

EbsCsiDriver.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


create
import { EbsCsiDriver } from '@pepperize/cdk-eks'

EbsCsiDriver.create(scope: Construct, props: EbsCsiDriverProps)

Create the driver construct associated with this cluster and scope.

Singleton per stack/cluster.

scopeRequired
  • Type: constructs.Construct

propsRequired

Properties

Name Type Description
node constructs.Node The tree node.
serviceAccount aws-cdk-lib.aws_eks.ServiceAccount No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


serviceAccountOptional
public readonly serviceAccount: ServiceAccount;
  • Type: aws-cdk-lib.aws_eks.ServiceAccount

EfsCsiDriver

https://docs.aws.amazon.com/eks/latest/userguide/efs-csi.html#efs-install-driver.

Initializers

import { EfsCsiDriver } from '@pepperize/cdk-eks'

new EfsCsiDriver(scope: Construct, id: string, props: EfsCsiDriverProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props EfsCsiDriverProps No description.

scopeRequired
  • Type: constructs.Construct

idRequired
  • Type: string

propsRequired

Methods

Name Description
toString Returns a string representation of this construct.

toString
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
create Create the driver construct associated with this cluster and scope.

isConstruct
import { EfsCsiDriver } from '@pepperize/cdk-eks'

EfsCsiDriver.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


create
import { EfsCsiDriver } from '@pepperize/cdk-eks'

EfsCsiDriver.create(scope: Construct, props: EfsCsiDriverProps)

Create the driver construct associated with this cluster and scope.

Singleton per stack/cluster.

scopeRequired
  • Type: constructs.Construct

propsRequired

Properties

Name Type Description
node constructs.Node The tree node.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


ExternalDns

Initializers

import { ExternalDns } from '@pepperize/cdk-eks'

new ExternalDns(scope: Construct, id: string, props: ExternalDnsProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props ExternalDnsProps No description.

scopeRequired
  • Type: constructs.Construct

idRequired
  • Type: string

propsRequired

Methods

Name Description
toString Returns a string representation of this construct.

toString
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.

isConstruct
import { ExternalDns } from '@pepperize/cdk-eks'

ExternalDns.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


Properties

Name Type Description
node constructs.Node The tree node.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


ExternalSecrets

Initializers

import { ExternalSecrets } from '@pepperize/cdk-eks'

new ExternalSecrets(scope: Construct, id: string, props: ExternalSecretsProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props ExternalSecretsProps No description.

scopeRequired
  • Type: constructs.Construct

idRequired
  • Type: string

propsRequired

Methods

Name Description
toString Returns a string representation of this construct.

toString
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.

isConstruct
import { ExternalSecrets } from '@pepperize/cdk-eks'

ExternalSecrets.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


Properties

Name Type Description
node constructs.Node The tree node.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


FluentBit

Initializers

import { FluentBit } from '@pepperize/cdk-eks'

new FluentBit(scope: Construct, id: string, props: FluentBitProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props FluentBitProps No description.

scopeRequired
  • Type: constructs.Construct

idRequired
  • Type: string

propsRequired

Methods

Name Description
toString Returns a string representation of this construct.

toString
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.

isConstruct
import { FluentBit } from '@pepperize/cdk-eks'

FluentBit.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


Properties

Name Type Description
node constructs.Node The tree node.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


VpcCni

Amazon EKS supports native VPC networking with the Amazon VPC Container Network Interface (CNI) plugin for Kubernetes.

Using this plugin allows Kubernetes pods to have the same IP address inside the pod as they do on the VPC network.

https://docs.aws.amazon.com/eks/latest/userguide/pod-networking.html

Initializers

import { VpcCni } from '@pepperize/cdk-eks'

new VpcCni(scope: Construct, id: string, props: VpcCniProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props VpcCniProps No description.

scopeRequired
  • Type: constructs.Construct

idRequired
  • Type: string

propsRequired

Methods

Name Description
toString Returns a string representation of this construct.

toString
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
create Create the driver construct associated with this cluster and scope.

isConstruct
import { VpcCni } from '@pepperize/cdk-eks'

VpcCni.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


create
import { VpcCni } from '@pepperize/cdk-eks'

VpcCni.create(scope: Construct, props: VpcCniProps)

Create the driver construct associated with this cluster and scope.

Singleton per stack/cluster.

scopeRequired
  • Type: constructs.Construct

propsRequired

Properties

Name Type Description
node constructs.Node The tree node.
serviceAccount aws-cdk-lib.aws_eks.ServiceAccount No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


serviceAccountOptional
public readonly serviceAccount: ServiceAccount;
  • Type: aws-cdk-lib.aws_eks.ServiceAccount

Structs

AddonProps

Initializer

import { AddonProps } from '@pepperize/cdk-eks'

const addonProps: AddonProps = { ... }

Properties

Name Type Description
addonName string The name of the addon.
cluster aws-cdk-lib.aws_eks.ICluster No description.
version IAddonVersion The version of the addon to be deployed.
managedPolicy aws-cdk-lib.aws_iam.IManagedPolicy The managed policy to add to the service account's role.
namespace string No description.
resolveConflicts ResolveConflicts No description.
serviceAccountName string The name of the service account for which to create a role.

addonNameRequired
public readonly addonName: string;
  • Type: string

The name of the addon.


clusterRequired
public readonly cluster: ICluster;
  • Type: aws-cdk-lib.aws_eks.ICluster

versionRequired
public readonly version: IAddonVersion;

The version of the addon to be deployed.


managedPolicyOptional
public readonly managedPolicy: IManagedPolicy;
  • Type: aws-cdk-lib.aws_iam.IManagedPolicy

The managed policy to add to the service account's role.


namespaceOptional
public readonly namespace: string;
  • Type: string
  • Default: kube-system

resolveConflictsOptional
public readonly resolveConflicts: ResolveConflicts;

serviceAccountNameOptional
public readonly serviceAccountName: string;
  • Type: string

The name of the service account for which to create a role.


AwsLoadBalancerControllerProps

Initializer

import { AwsLoadBalancerControllerProps } from '@pepperize/cdk-eks'

const awsLoadBalancerControllerProps: AwsLoadBalancerControllerProps = { ... }

Properties

Name Type Description
cluster aws-cdk-lib.aws_eks.ICluster No description.
vpc aws-cdk-lib.aws_ec2.IVpc No description.
namespace string No description.

clusterRequired
public readonly cluster: ICluster;
  • Type: aws-cdk-lib.aws_eks.ICluster

vpcRequired
public readonly vpc: IVpc;
  • Type: aws-cdk-lib.aws_ec2.IVpc

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

CloudwatchMetricsProps

Initializer

import { CloudwatchMetricsProps } from '@pepperize/cdk-eks'

const cloudwatchMetricsProps: CloudwatchMetricsProps = { ... }

Properties

Name Type Description
cluster aws-cdk-lib.aws_eks.ICluster No description.
namespace string No description.

clusterRequired
public readonly cluster: ICluster;
  • Type: aws-cdk-lib.aws_eks.ICluster

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

ClusterProps

Initializer

import { ClusterProps } from '@pepperize/cdk-eks'

const clusterProps: ClusterProps = { ... }

Properties

Name Type Description
hostedZoneIds string[] No description.
mainRoles aws-cdk-lib.aws_iam.IRole[] No description.
secretsEncryptionKey aws-cdk-lib.aws_kms.IKey No description.
vpc aws-cdk-lib.aws_ec2.IVpc No description.
clusterName string No description.

hostedZoneIdsRequired
public readonly hostedZoneIds: string[];
  • Type: string[]

mainRolesRequired
public readonly mainRoles: IRole[];
  • Type: aws-cdk-lib.aws_iam.IRole[]

secretsEncryptionKeyRequired
public readonly secretsEncryptionKey: IKey;
  • Type: aws-cdk-lib.aws_kms.IKey

vpcRequired
public readonly vpc: IVpc;
  • Type: aws-cdk-lib.aws_ec2.IVpc

clusterNameOptional
public readonly clusterName: string;
  • Type: string

EbsCsiDriverProps

Initializer

import { EbsCsiDriverProps } from '@pepperize/cdk-eks'

const ebsCsiDriverProps: EbsCsiDriverProps = { ... }

Properties

Name Type Description
cluster aws-cdk-lib.aws_eks.ICluster No description.
namespace string No description.
version EbsCsiDriverVersion No description.

clusterRequired
public readonly cluster: ICluster;
  • Type: aws-cdk-lib.aws_eks.ICluster

namespaceOptional
public readonly namespace: string;
  • Type: string
  • Default: kube-system

versionOptional
public readonly version: EbsCsiDriverVersion;

EfsCsiDriverProps

Initializer

import { EfsCsiDriverProps } from '@pepperize/cdk-eks'

const efsCsiDriverProps: EfsCsiDriverProps = { ... }

Properties

Name Type Description
cluster aws-cdk-lib.aws_eks.ICluster No description.
namespace string No description.
policy any A custom iam policy document used for custom version.
repository string The repository to pull the driver image from.
version EfsCsiDriverVersion No description.

clusterRequired
public readonly cluster: ICluster;
  • Type: aws-cdk-lib.aws_eks.ICluster

namespaceOptional
public readonly namespace: string;
  • Type: string
  • Default: kube-system

policyOptional
public readonly policy: any;
  • Type: any
  • Default: undefined

A custom iam policy document used for custom version.


repositoryOptional
public readonly repository: string;
  • Type: string
  • Default: '602401143452.dkr.ecr.us-east-1.amazonaws.com/eks/aws-efs-csi-driver'

The repository to pull the driver image from.

Note that the default repository works for most regions, but not all.

https://docs.aws.amazon.com/eks/latest/userguide/add-ons-images.html.


versionOptional
public readonly version: EfsCsiDriverVersion;

ExternalDnsProps

Initializer

import { ExternalDnsProps } from '@pepperize/cdk-eks'

const externalDnsProps: ExternalDnsProps = { ... }

Properties

Name Type Description
cluster aws-cdk-lib.aws_eks.ICluster No description.
hostedZoneIds string[] No description.
namespace string No description.

clusterRequired
public readonly cluster: ICluster;
  • Type: aws-cdk-lib.aws_eks.ICluster

hostedZoneIdsRequired
public readonly hostedZoneIds: string[];
  • Type: string[]

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

ExternalSecretsProps

https://external-secrets.io/v0.5.1/provider-aws-secrets-manager/

Initializer

import { ExternalSecretsProps } from '@pepperize/cdk-eks'

const externalSecretsProps: ExternalSecretsProps = { ... }

Properties

Name Type Description
cluster aws-cdk-lib.aws_eks.ICluster No description.
namespace string No description.

clusterRequired
public readonly cluster: ICluster;
  • Type: aws-cdk-lib.aws_eks.ICluster

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

FluentBitProps

Initializer

import { FluentBitProps } from '@pepperize/cdk-eks'

const fluentBitProps: FluentBitProps = { ... }

Properties

Name Type Description
cluster aws-cdk-lib.aws_eks.ICluster No description.
namespace string No description.

clusterRequired
public readonly cluster: ICluster;
  • Type: aws-cdk-lib.aws_eks.ICluster

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

VpcCniProps

Initializer

import { VpcCniProps } from '@pepperize/cdk-eks'

const vpcCniProps: VpcCniProps = { ... }

Properties

Name Type Description
cluster aws-cdk-lib.aws_eks.ICluster No description.
namespace string No description.
version VpcCniVersion No description.

clusterRequired
public readonly cluster: ICluster;
  • Type: aws-cdk-lib.aws_eks.ICluster

namespaceOptional
public readonly namespace: string;
  • Type: string
  • Default: kube-system

versionOptional
public readonly version: VpcCniVersion;

Classes

EbsCsiDriverVersion

Static Functions

Name Description
of Specify a custom version.

of
import { EbsCsiDriverVersion } from '@pepperize/cdk-eks'

EbsCsiDriverVersion.of(version: string)

Specify a custom version.

Use this if the version you need is not available in one of the predefined versions.

versionRequired
  • Type: string

The version number.


Properties

Name Type Description
custom boolean Whether it's a custom version.
version string The version string.

customRequired
public readonly custom: boolean;
  • Type: boolean

Whether it's a custom version.


versionRequired
public readonly version: string;
  • Type: string

The version string.


Constants

Name Type Description
V1_5_2 EbsCsiDriverVersion v1.5.2.

V1_5_2Required
public readonly V1_5_2: EbsCsiDriverVersion;

v1.5.2.


EfsCsiDriverVersion

Static Functions

Name Description
of Specify a custom version.

of
import { EfsCsiDriverVersion } from '@pepperize/cdk-eks'

EfsCsiDriverVersion.of(version: string)

Specify a custom version.

Use this if the version you need is not available in one of the predefined versions. Note that in this case, you will also need to provide an IAM policy in the driver options.

versionRequired
  • Type: string

The version number.


Properties

Name Type Description
custom boolean Whether it's a custom version.
version string The version string.

customRequired
public readonly custom: boolean;
  • Type: boolean

Whether it's a custom version.


versionRequired
public readonly version: string;
  • Type: string

The version string.


Constants

Name Type Description
V1_3_2 EfsCsiDriverVersion v1.3.2.

V1_3_2Required
public readonly V1_3_2: EfsCsiDriverVersion;

v1.3.2.


VpcCniVersion

Static Functions

Name Description
of Specify a custom version.

of
import { VpcCniVersion } from '@pepperize/cdk-eks'

VpcCniVersion.of(version: string)

Specify a custom version.

Use this if the version you need is not available in one of the predefined versions.

versionRequired
  • Type: string

The version number.


Properties

Name Type Description
custom boolean Whether it's a custom version.
version string The version string.

customRequired
public readonly custom: boolean;
  • Type: boolean

Whether it's a custom version.


versionRequired
public readonly version: string;
  • Type: string

The version string.


Constants

Name Type Description
V1_10_1 VpcCniVersion v1.10.1.
V1_10_2 VpcCniVersion v1.10.2.
V1_10_3 VpcCniVersion v1.10.3.

V1_10_1Required
public readonly V1_10_1: VpcCniVersion;

v1.10.1.


V1_10_2Required
public readonly V1_10_2: VpcCniVersion;

v1.10.2.


V1_10_3Required
public readonly V1_10_3: VpcCniVersion;

v1.10.3.


Protocols

IAddonVersion

Properties

Name Type Description
version string No description.

versionRequired
public readonly version: string;
  • Type: string

Enums

ResolveConflicts

Members

Name Description
NONE No description.
OVERWRITE No description.

NONE

OVERWRITE