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. |
- Type: constructs.Construct
- Type: string
- Type: AddonProps
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
import { Addon } from '@pepperize/cdk-eks'
Addon.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
serviceAccount |
aws-cdk-lib.aws_eks.ServiceAccount |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly serviceAccount: ServiceAccount;
- Type: aws-cdk-lib.aws_eks.ServiceAccount
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. |
- Type: constructs.Construct
- Type: string
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
import { AwsLoadBalancerController } from '@pepperize/cdk-eks'
AwsLoadBalancerController.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
cluster |
aws-cdk-lib.aws_eks.ICluster |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cluster: ICluster;
- Type: aws-cdk-lib.aws_eks.ICluster
Set up Container Insights to collect cluster metrics.
https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Container-Insights-setup-metrics.html
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. |
- Type: constructs.Construct
- Type: string
- Type: CloudwatchMetricsProps
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
import { CloudwatchMetrics } from '@pepperize/cdk-eks'
CloudwatchMetrics.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
- Implements: aws-cdk-lib.ITaggable
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. |
- Type: constructs.Construct
- Type: string
- Type: ClusterProps
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
import { Cluster } from '@pepperize/cdk-eks'
Cluster.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
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. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly albController: AlbController;
- Type: aws-cdk-lib.aws_eks.AlbController
public readonly autoscaling: Karpenter;
- Type: cdk-karpenter.Karpenter
public readonly externalDns: ExternalDns;
- Type: ExternalDns
public readonly externalSecrets: ExternalSecrets;
- Type: ExternalSecrets
public readonly logging: FluentBit;
- Type: FluentBit
public readonly mainRole: IRole;
- Type: aws-cdk-lib.aws_iam.IRole
public readonly metrics: CloudwatchMetrics;
- Type: CloudwatchMetrics
public readonly resource: Cluster;
- Type: aws-cdk-lib.aws_eks.Cluster
public readonly tags: TagManager;
- Type: aws-cdk-lib.TagManager
TagManager to set, remove and format tags.
https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html.
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. |
- Type: constructs.Construct
- Type: string
- Type: EbsCsiDriverProps
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
create |
Create the driver construct associated with this cluster and scope. |
import { EbsCsiDriver } from '@pepperize/cdk-eks'
EbsCsiDriver.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
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.
- Type: constructs.Construct
- Type: EbsCsiDriverProps
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
serviceAccount |
aws-cdk-lib.aws_eks.ServiceAccount |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly serviceAccount: ServiceAccount;
- Type: aws-cdk-lib.aws_eks.ServiceAccount
https://docs.aws.amazon.com/eks/latest/userguide/efs-csi.html#efs-install-driver.
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. |
- Type: constructs.Construct
- Type: string
- Type: EfsCsiDriverProps
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
create |
Create the driver construct associated with this cluster and scope. |
import { EfsCsiDriver } from '@pepperize/cdk-eks'
EfsCsiDriver.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
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.
- Type: constructs.Construct
- Type: EfsCsiDriverProps
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
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. |
- Type: constructs.Construct
- Type: string
- Type: ExternalDnsProps
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
import { ExternalDns } from '@pepperize/cdk-eks'
ExternalDns.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
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. |
- Type: constructs.Construct
- Type: string
- Type: ExternalSecretsProps
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
import { ExternalSecrets } from '@pepperize/cdk-eks'
ExternalSecrets.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
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. |
- Type: constructs.Construct
- Type: string
- Type: FluentBitProps
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
import { FluentBit } from '@pepperize/cdk-eks'
FluentBit.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
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
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. |
- Type: constructs.Construct
- Type: string
- Type: VpcCniProps
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
create |
Create the driver construct associated with this cluster and scope. |
import { VpcCni } from '@pepperize/cdk-eks'
VpcCni.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
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.
- Type: constructs.Construct
- Type: VpcCniProps
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
serviceAccount |
aws-cdk-lib.aws_eks.ServiceAccount |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly serviceAccount: ServiceAccount;
- Type: aws-cdk-lib.aws_eks.ServiceAccount
import { AddonProps } from '@pepperize/cdk-eks'
const addonProps: AddonProps = { ... }
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. |
public readonly addonName: string;
- Type: string
The name of the addon.
public readonly cluster: ICluster;
- Type: aws-cdk-lib.aws_eks.ICluster
public readonly version: IAddonVersion;
- Type: IAddonVersion
The version of the addon to be deployed.
public readonly managedPolicy: IManagedPolicy;
- Type: aws-cdk-lib.aws_iam.IManagedPolicy
The managed policy to add to the service account's role.
public readonly namespace: string;
- Type: string
- Default: kube-system
public readonly resolveConflicts: ResolveConflicts;
- Type: ResolveConflicts
- Default: 'OVERWRITE'
public readonly serviceAccountName: string;
- Type: string
The name of the service account for which to create a role.
import { AwsLoadBalancerControllerProps } from '@pepperize/cdk-eks'
const awsLoadBalancerControllerProps: AwsLoadBalancerControllerProps = { ... }
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. |
public readonly cluster: ICluster;
- Type: aws-cdk-lib.aws_eks.ICluster
public readonly vpc: IVpc;
- Type: aws-cdk-lib.aws_ec2.IVpc
public readonly namespace: string;
- Type: string
- Default: ingress
import { CloudwatchMetricsProps } from '@pepperize/cdk-eks'
const cloudwatchMetricsProps: CloudwatchMetricsProps = { ... }
Name | Type | Description |
---|---|---|
cluster |
aws-cdk-lib.aws_eks.ICluster |
No description. |
namespace |
string |
No description. |
public readonly cluster: ICluster;
- Type: aws-cdk-lib.aws_eks.ICluster
public readonly namespace: string;
- Type: string
- Default: metrics
import { ClusterProps } from '@pepperize/cdk-eks'
const clusterProps: ClusterProps = { ... }
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. |
public readonly hostedZoneIds: string[];
- Type: string[]
public readonly mainRoles: IRole[];
- Type: aws-cdk-lib.aws_iam.IRole[]
public readonly secretsEncryptionKey: IKey;
- Type: aws-cdk-lib.aws_kms.IKey
public readonly vpc: IVpc;
- Type: aws-cdk-lib.aws_ec2.IVpc
public readonly clusterName: string;
- Type: string
import { EbsCsiDriverProps } from '@pepperize/cdk-eks'
const ebsCsiDriverProps: EbsCsiDriverProps = { ... }
Name | Type | Description |
---|---|---|
cluster |
aws-cdk-lib.aws_eks.ICluster |
No description. |
namespace |
string |
No description. |
version |
EbsCsiDriverVersion |
No description. |
public readonly cluster: ICluster;
- Type: aws-cdk-lib.aws_eks.ICluster
public readonly namespace: string;
- Type: string
- Default: kube-system
public readonly version: EbsCsiDriverVersion;
- Type: EbsCsiDriverVersion
- Default: v1.5.2
import { EfsCsiDriverProps } from '@pepperize/cdk-eks'
const efsCsiDriverProps: EfsCsiDriverProps = { ... }
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. |
public readonly cluster: ICluster;
- Type: aws-cdk-lib.aws_eks.ICluster
public readonly namespace: string;
- Type: string
- Default: kube-system
public readonly policy: any;
- Type: any
- Default: undefined
A custom iam policy document used for custom version.
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.
public readonly version: EfsCsiDriverVersion;
- Type: EfsCsiDriverVersion
- Default: v1.3.2
import { ExternalDnsProps } from '@pepperize/cdk-eks'
const externalDnsProps: ExternalDnsProps = { ... }
Name | Type | Description |
---|---|---|
cluster |
aws-cdk-lib.aws_eks.ICluster |
No description. |
hostedZoneIds |
string[] |
No description. |
namespace |
string |
No description. |
public readonly cluster: ICluster;
- Type: aws-cdk-lib.aws_eks.ICluster
public readonly hostedZoneIds: string[];
- Type: string[]
public readonly namespace: string;
- Type: string
- Default: dns
https://external-secrets.io/v0.5.1/provider-aws-secrets-manager/
import { ExternalSecretsProps } from '@pepperize/cdk-eks'
const externalSecretsProps: ExternalSecretsProps = { ... }
Name | Type | Description |
---|---|---|
cluster |
aws-cdk-lib.aws_eks.ICluster |
No description. |
namespace |
string |
No description. |
public readonly cluster: ICluster;
- Type: aws-cdk-lib.aws_eks.ICluster
public readonly namespace: string;
- Type: string
- Default: secrets
import { FluentBitProps } from '@pepperize/cdk-eks'
const fluentBitProps: FluentBitProps = { ... }
Name | Type | Description |
---|---|---|
cluster |
aws-cdk-lib.aws_eks.ICluster |
No description. |
namespace |
string |
No description. |
public readonly cluster: ICluster;
- Type: aws-cdk-lib.aws_eks.ICluster
public readonly namespace: string;
- Type: string
- Default: logging
import { VpcCniProps } from '@pepperize/cdk-eks'
const vpcCniProps: VpcCniProps = { ... }
Name | Type | Description |
---|---|---|
cluster |
aws-cdk-lib.aws_eks.ICluster |
No description. |
namespace |
string |
No description. |
version |
VpcCniVersion |
No description. |
public readonly cluster: ICluster;
- Type: aws-cdk-lib.aws_eks.ICluster
public readonly namespace: string;
- Type: string
- Default: kube-system
public readonly version: VpcCniVersion;
- Type: VpcCniVersion
- Default: v1.10.2
- Implements: IAddonVersion
Name | Description |
---|---|
of |
Specify a custom version. |
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.
- Type: string
The version number.
Name | Type | Description |
---|---|---|
custom |
boolean |
Whether it's a custom version. |
version |
string |
The version string. |
public readonly custom: boolean;
- Type: boolean
Whether it's a custom version.
public readonly version: string;
- Type: string
The version string.
Name | Type | Description |
---|---|---|
V1_5_2 |
EbsCsiDriverVersion |
v1.5.2. |
public readonly V1_5_2: EbsCsiDriverVersion;
- Type: EbsCsiDriverVersion
v1.5.2.
Name | Description |
---|---|
of |
Specify a custom version. |
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.
- Type: string
The version number.
Name | Type | Description |
---|---|---|
custom |
boolean |
Whether it's a custom version. |
version |
string |
The version string. |
public readonly custom: boolean;
- Type: boolean
Whether it's a custom version.
public readonly version: string;
- Type: string
The version string.
Name | Type | Description |
---|---|---|
V1_3_2 |
EfsCsiDriverVersion |
v1.3.2. |
public readonly V1_3_2: EfsCsiDriverVersion;
- Type: EfsCsiDriverVersion
v1.3.2.
- Implements: IAddonVersion
Name | Description |
---|---|
of |
Specify a custom version. |
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.
- Type: string
The version number.
Name | Type | Description |
---|---|---|
custom |
boolean |
Whether it's a custom version. |
version |
string |
The version string. |
public readonly custom: boolean;
- Type: boolean
Whether it's a custom version.
public readonly version: string;
- Type: string
The version string.
Name | Type | Description |
---|---|---|
V1_10_1 |
VpcCniVersion |
v1.10.1. |
V1_10_2 |
VpcCniVersion |
v1.10.2. |
V1_10_3 |
VpcCniVersion |
v1.10.3. |
public readonly V1_10_1: VpcCniVersion;
- Type: VpcCniVersion
v1.10.1.
public readonly V1_10_2: VpcCniVersion;
- Type: VpcCniVersion
v1.10.2.
public readonly V1_10_3: VpcCniVersion;
- Type: VpcCniVersion
v1.10.3.
- Implemented By: EbsCsiDriverVersion, VpcCniVersion, IAddonVersion
Name | Type | Description |
---|---|---|
version |
string |
No description. |
public readonly version: string;
- Type: string
Name | Description |
---|---|
NONE |
No description. |
OVERWRITE |
No description. |