Interface Summary
Interface	Description
AddDirectoryOptions	Options for `configmap.addDirectory()`.
CommandProbeOptions	Options for `Probe.fromCommand()`.
ConfigMapProps	Properties for initialization of `ConfigMap`.
ConfigMapVolumeOptions	Options for the ConfigMap-based volume.
ContainerProps	Properties for creating a container.
DeploymentProps	Properties for initialization of `Deployment`.
EmptyDirVolumeOptions	Options for volumes populated with an empty directory.
EnvValueFromConfigMapOptions	Options to specify an envionment variable value from a ConfigMap key.
EnvValueFromProcessOptions	Options to specify an environment variable value from the process environment.
EnvValueFromSecretOptions	Options to specify an environment variable value from a Secret.
ExposeOptions	Options for exposing a deployment via a service.
HttpGetProbeOptions	Options for `Probe.fromHttpGet()`.
IConfigMap	Represents a config map.
IConfigMap.Jsii$Default	Internal default implementation for `IConfigMap`.
IngressV1Beta1Props	Properties for `Ingress`.
IngressV1Beta1Rule	Represents the rules mapping the paths under a specified host to the related backend services.
IngressV1Beta1Tls	Represents the TLS configuration mapping that is passed to the ingress controller for SSL termination.
IPodSpec	Represents a resource that can be configured with a kuberenets pod spec.
IPodSpec.Jsii$Default	Internal default implementation for `IPodSpec`.
IPodTemplate	Represents a resource that can be configured with a kuberenets pod template.
IPodTemplate.Jsii$Default	Internal default implementation for `IPodTemplate`.
IResource	Represents a resource.
IResource.Jsii$Default	Internal default implementation for `IResource`.
ISecret
ISecret.Jsii$Default	Internal default implementation for `ISecret`.
IServiceAccount
IServiceAccount.Jsii$Default	Internal default implementation for `IServiceAccount`.
JobProps	Properties for initialization of `Job`.
MountOptions	Options for mounts.
PathMapping	Maps a string key to a path within a volume.
PodProps	Properties for initialization of `Pod`.
PodSpecProps	Properties of a `PodSpec`.
PodTemplateProps	Properties of a `PodTemplate`.
ProbeOptions	Probe options.
ResourceProps	Initialization properties for resources.
SecretProps
SecretValue	Represents a specific value in JSON secret.
ServiceAccountProps	Properties for initialization of `ServiceAccount`.
ServiceIngressV1BetaBackendOptions	Options for setting up backends for ingress rules.
ServicePort	Definition of a service port.
ServicePortOptions
ServiceProps	Properties for initialization of `Service`.
StatefulSetProps	Properties for initialization of `StatefulSet`.
VolumeMount	Mount a volume from the pod to the container.

Class Summary
Class	Description
AddDirectoryOptions.Builder	A builder for `AddDirectoryOptions`
AddDirectoryOptions.Jsii$Proxy	An implementation for `AddDirectoryOptions`
CommandProbeOptions.Builder	A builder for `CommandProbeOptions`
CommandProbeOptions.Jsii$Proxy	An implementation for `CommandProbeOptions`
ConfigMap	ConfigMap holds configuration data for pods to consume.
ConfigMap.Builder	A fluent builder for `ConfigMap`.
ConfigMapProps.Builder	A builder for `ConfigMapProps`
ConfigMapProps.Jsii$Proxy	An implementation for `ConfigMapProps`
ConfigMapVolumeOptions.Builder	A builder for `ConfigMapVolumeOptions`
ConfigMapVolumeOptions.Jsii$Proxy	An implementation for `ConfigMapVolumeOptions`
Container	A single application container that you want to run within a pod.
Container.Builder	A fluent builder for `Container`.
ContainerProps.Builder	A builder for `ContainerProps`
ContainerProps.Jsii$Proxy	An implementation for `ContainerProps`
Deployment	A Deployment provides declarative updates for Pods and ReplicaSets.
Deployment.Builder	A fluent builder for `Deployment`.
DeploymentProps.Builder	A builder for `DeploymentProps`
DeploymentProps.Jsii$Proxy	An implementation for `DeploymentProps`
EmptyDirVolumeOptions.Builder	A builder for `EmptyDirVolumeOptions`
EmptyDirVolumeOptions.Jsii$Proxy	An implementation for `EmptyDirVolumeOptions`
EnvValue	Utility class for creating reading env values from various sources.
EnvValueFromConfigMapOptions.Builder	A builder for `EnvValueFromConfigMapOptions`
EnvValueFromConfigMapOptions.Jsii$Proxy	An implementation for `EnvValueFromConfigMapOptions`
EnvValueFromProcessOptions.Builder	A builder for `EnvValueFromProcessOptions`
EnvValueFromProcessOptions.Jsii$Proxy	An implementation for `EnvValueFromProcessOptions`
EnvValueFromSecretOptions.Builder	A builder for `EnvValueFromSecretOptions`
EnvValueFromSecretOptions.Jsii$Proxy	An implementation for `EnvValueFromSecretOptions`
ExposeOptions.Builder	A builder for `ExposeOptions`
ExposeOptions.Jsii$Proxy	An implementation for `ExposeOptions`
HttpGetProbeOptions.Builder	A builder for `HttpGetProbeOptions`
HttpGetProbeOptions.Jsii$Proxy	An implementation for `HttpGetProbeOptions`
IConfigMap.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IngressV1Beta1	Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend.
IngressV1Beta1.Builder	A fluent builder for `IngressV1Beta1`.
IngressV1Beta1Backend	The backend for an ingress path.
IngressV1Beta1Props.Builder	A builder for `IngressV1Beta1Props`
IngressV1Beta1Props.Jsii$Proxy	An implementation for `IngressV1Beta1Props`
IngressV1Beta1Rule.Builder	A builder for `IngressV1Beta1Rule`
IngressV1Beta1Rule.Jsii$Proxy	An implementation for `IngressV1Beta1Rule`
IngressV1Beta1Tls.Builder	A builder for `IngressV1Beta1Tls`
IngressV1Beta1Tls.Jsii$Proxy	An implementation for `IngressV1Beta1Tls`
IPodSpec.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IPodTemplate.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IResource.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
ISecret.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IServiceAccount.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
Job	A Job creates one or more Pods and ensures that a specified number of them successfully terminate.
Job.Builder	A fluent builder for `Job`.
JobProps.Builder	A builder for `JobProps`
JobProps.Jsii$Proxy	An implementation for `JobProps`
MountOptions.Builder	A builder for `MountOptions`
MountOptions.Jsii$Proxy	An implementation for `MountOptions`
PathMapping.Builder	A builder for `PathMapping`
PathMapping.Jsii$Proxy	An implementation for `PathMapping`
Pod	Pod is a collection of containers that can run on a host.
Pod.Builder	A fluent builder for `Pod`.
PodProps.Builder	A builder for `PodProps`
PodProps.Jsii$Proxy	An implementation for `PodProps`
PodSpec	Provides read/write capabilities ontop of a `PodSpecProps`.
PodSpec.Builder	A fluent builder for `PodSpec`.
PodSpecProps.Builder	A builder for `PodSpecProps`
PodSpecProps.Jsii$Proxy	An implementation for `PodSpecProps`
PodTemplate	Provides read/write capabilities ontop of a `PodTemplateProps`.
PodTemplate.Builder	A fluent builder for `PodTemplate`.
PodTemplateProps.Builder	A builder for `PodTemplateProps`
PodTemplateProps.Jsii$Proxy	An implementation for `PodTemplateProps`
Probe	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
ProbeOptions.Builder	A builder for `ProbeOptions`
ProbeOptions.Jsii$Proxy	An implementation for `ProbeOptions`
Resource	Base class for all Kubernetes objects in stdk8s.
ResourceProps.Builder	A builder for `ResourceProps`
ResourceProps.Jsii$Proxy	An implementation for `ResourceProps`
Secret	Kubernetes Secrets let you store and manage sensitive information, such as passwords, OAuth tokens, and ssh keys.
Secret.Builder	A fluent builder for `Secret`.
SecretProps.Builder	A builder for `SecretProps`
SecretProps.Jsii$Proxy	An implementation for `SecretProps`
SecretValue.Builder	A builder for `SecretValue`
SecretValue.Jsii$Proxy	An implementation for `SecretValue`
Service	An abstract way to expose an application running on a set of Pods as a network service.
Service.Builder	A fluent builder for `Service`.
ServiceAccount	A service account provides an identity for processes that run in a Pod.
ServiceAccount.Builder	A fluent builder for `ServiceAccount`.
ServiceAccountProps.Builder	A builder for `ServiceAccountProps`
ServiceAccountProps.Jsii$Proxy	An implementation for `ServiceAccountProps`
ServiceIngressV1BetaBackendOptions.Builder	A builder for `ServiceIngressV1BetaBackendOptions`
ServiceIngressV1BetaBackendOptions.Jsii$Proxy	An implementation for `ServiceIngressV1BetaBackendOptions`
ServicePort.Builder	A builder for `ServicePort`
ServicePort.Jsii$Proxy	An implementation for `ServicePort`
ServicePortOptions.Builder	A builder for `ServicePortOptions`
ServicePortOptions.Jsii$Proxy	An implementation for `ServicePortOptions`
ServiceProps.Builder	A builder for `ServiceProps`
ServiceProps.Jsii$Proxy	An implementation for `ServiceProps`
StatefulSet	StatefulSet is the workload API object used to manage stateful applications.
StatefulSet.Builder	A fluent builder for `StatefulSet`.
StatefulSetProps.Builder	A builder for `StatefulSetProps`
StatefulSetProps.Jsii$Proxy	An implementation for `StatefulSetProps`
Volume	Volume represents a named volume in a pod that may be accessed by any container in the pod.
VolumeMount.Builder	A builder for `VolumeMount`
VolumeMount.Jsii$Proxy	An implementation for `VolumeMount`

Enum Summary
Enum	Description
EmptyDirMedium	The medium on which to store the volume.
ImagePullPolicy
MountPropagation
PodManagementPolicy	Controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down.
Protocol
RestartPolicy	Restart policy for all containers within the pod.
ServiceType	For some parts of your application (for example, frontends) you may want to expose a Service onto an external IP address, that's outside of your cluster.

Package org.cdk8s.plus20 Description

cdk8s+ (cdk8s-plus)

High level constructs for Kubernetes

| k8s version | npm (JS/TS) | PyPI (Python) | NuGet (C#) | Maven (Java) | Go | | --- | --- | --- | --- | --- | --- | | 1.20.0 | Link | Link | Link | Link | Link | | 1.21.0 | Link | Link | Link | Link | Link | | 1.22.0 | Link | Link | Link | Link | Link |

cdk8s+ is a software development framework that provides high level abstractions for authoring Kubernetes applications. Built on top of the auto generated building blocks provided by cdk8s, this library includes a hand crafted construct for each native kubernetes object, exposing richer API's with reduced complexity.

:books: Documentation

See cdk8s.io.

:raised_hand: Contributing

If you'd like to add a new feature or fix a bug, please visit CONTRIBUTING.md!

:balance_scale: License

This project is distributed under the Apache License, Version 2.0.

This module is part of the cdk8s project.