cdk8s-plus-31 2.0.0

package/lib/probe.d.ts

@@ -0,0 +1,141 @@
+import { Duration } from 'cdk8s';
+import * as container from './container';
+import * as k8s from './imports/k8s';
+/**
+ * Probe options.
+ */
+export interface ProbeOptions {
+    /**
+     * Minimum consecutive failures for the probe to be considered failed after
+     * having succeeded.
+     *
+     * Defaults to 3. Minimum value is 1.
+     *
+     * @default 3
+     */
+    readonly failureThreshold?: number;
+    /**
+     * Number of seconds after the container has started before liveness probes
+     * are initiated.
+     *
+     * @see https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+     * @default - immediate
+     */
+    readonly initialDelaySeconds?: Duration;
+    /**
+     * How often (in seconds) to perform the probe.
+     *
+     * Default to 10 seconds. Minimum value is 1.
+     *
+     * @default Duration.seconds(10) Minimum value is 1.
+     */
+    readonly periodSeconds?: Duration;
+    /**
+     * Minimum consecutive successes for the probe to be considered successful
+     * after having failed. Defaults to 1.
+     *
+     * Must be 1 for liveness and startup. Minimum value is 1.
+     *
+     * @default 1 Must be 1 for liveness and startup. Minimum value is 1.
+     */
+    readonly successThreshold?: number;
+    /**
+     * Number of seconds after which the probe times out.
+     *
+     * Defaults to 1 second. Minimum value is 1.
+     *
+     * @see https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+     * @default Duration.seconds(1)
+     */
+    readonly timeoutSeconds?: Duration;
+}
+export declare enum ConnectionScheme {
+    /**
+     * Use HTTP request for connecting to host.
+     */
+    HTTP = "HTTP",
+    /**
+     * Use HTTPS request for connecting to host.
+     */
+    HTTPS = "HTTPS"
+}
+/**
+ * Options for `Probe.fromHttpGet()`.
+ */
+export interface HttpGetProbeOptions extends ProbeOptions {
+    /**
+     * The TCP port to use when sending the GET request.
+     *
+     * @default - defaults to `container.port`.
+     */
+    readonly port?: number;
+    /**
+     *  Scheme to use for connecting to the host (HTTP or HTTPS).
+     *
+     *  @default ConnectionScheme.HTTP
+     */
+    readonly scheme?: ConnectionScheme;
+    /**
+     * The host name to connect to on the container.
+     *
+     * @default - defaults to the pod IP
+     */
+    readonly host?: string;
+}
+/**
+ * Options for `Probe.fromCommand()`.
+ */
+export interface CommandProbeOptions extends ProbeOptions {
+}
+/**
+ * Options for `Probe.fromTcpSocket()`.
+ */
+export interface TcpSocketProbeOptions extends ProbeOptions {
+    /**
+     * The TCP port to connect to on the container.
+     *
+     * @default - defaults to `container.port`.
+     */
+    readonly port?: number;
+    /**
+     * The host name to connect to on the container.
+     *
+     * @default - defaults to the pod IP
+     */
+    readonly host?: string;
+}
+/**
+ * Probe describes a health check to be performed against a container to
+ * determine whether it is alive or ready to receive traffic.
+ */
+export declare class Probe {
+    private readonly probeOptions;
+    private readonly tcpSocketOptions?;
+    private readonly commandOptions?;
+    private readonly httpGetOptions?;
+    /**
+     * Defines a probe based on an HTTP GET request to the IP address of the container.
+     *
+     * @param path The URL path to hit
+     * @param options Options
+     */
+    static fromHttpGet(path: string, options?: HttpGetProbeOptions): Probe;
+    /**
+     * Defines a probe based on a command which is executed within the container.
+     *
+     * @param command The command to execute
+     * @param options Options
+     */
+    static fromCommand(command: string[], options?: CommandProbeOptions): Probe;
+    /**
+     * Defines a probe based opening a connection to a TCP socket on the container.
+     *
+     * @param options Options
+     */
+    static fromTcpSocket(options?: TcpSocketProbeOptions): Probe;
+    private constructor();
+    /**
+     * @internal
+     */
+    _toKube(cont: container.Container): k8s.Probe;
+}

package/lib/probe.js

@@ -0,0 +1,77 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Probe = exports.ConnectionScheme = void 0;
+const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
+const _action = require("./_action");
+var ConnectionScheme;
+(function (ConnectionScheme) {
+    /**
+     * Use HTTP request for connecting to host.
+     */
+    ConnectionScheme["HTTP"] = "HTTP";
+    /**
+     * Use HTTPS request for connecting to host.
+     */
+    ConnectionScheme["HTTPS"] = "HTTPS";
+})(ConnectionScheme = exports.ConnectionScheme || (exports.ConnectionScheme = {}));
+/**
+ * Probe describes a health check to be performed against a container to
+ * determine whether it is alive or ready to receive traffic.
+ */
+class Probe {
+    constructor(probeOptions, tcpSocketOptions, commandOptions, httpGetOptions) {
+        this.probeOptions = probeOptions;
+        this.tcpSocketOptions = tcpSocketOptions;
+        this.commandOptions = commandOptions;
+        this.httpGetOptions = httpGetOptions;
+    }
+    /**
+     * Defines a probe based on an HTTP GET request to the IP address of the container.
+     *
+     * @param path The URL path to hit
+     * @param options Options
+     */
+    static fromHttpGet(path, options = {}) {
+        return new Probe(options, undefined, undefined, { path, ...options });
+    }
+    /**
+     * Defines a probe based on a command which is executed within the container.
+     *
+     * @param command The command to execute
+     * @param options Options
+     */
+    static fromCommand(command, options = {}) {
+        return new Probe(options, undefined, { command, ...options }, undefined);
+    }
+    /**
+     * Defines a probe based opening a connection to a TCP socket on the container.
+     *
+     * @param options Options
+     */
+    static fromTcpSocket(options = {}) {
+        return new Probe(options, options, undefined, undefined);
+    }
+    /**
+     * @internal
+     */
+    _toKube(cont) {
+        const exec = this.commandOptions ? _action.Action.fromCommand(this.commandOptions.command) : undefined;
+        const httpGet = this.httpGetOptions ? _action.Action.fromHttpGet(cont, this.httpGetOptions.path, this.httpGetOptions) : undefined;
+        const tcpSocket = this.tcpSocketOptions ? _action.Action.fromTcpSocket(cont, this.tcpSocketOptions) : undefined;
+        return {
+            failureThreshold: this.probeOptions.failureThreshold ?? 3,
+            initialDelaySeconds: this.probeOptions.initialDelaySeconds ? this.probeOptions.initialDelaySeconds.toSeconds() : undefined,
+            periodSeconds: this.probeOptions.periodSeconds ? this.probeOptions.periodSeconds.toSeconds() : undefined,
+            successThreshold: this.probeOptions.successThreshold,
+            timeoutSeconds: this.probeOptions.timeoutSeconds ? this.probeOptions.timeoutSeconds.toSeconds() : undefined,
+            exec: exec,
+            httpGet,
+            tcpSocket,
+        };
+    }
+}
+exports.Probe = Probe;
+_a = JSII_RTTI_SYMBOL_1;
+Probe[_a] = { fqn: "cdk8s-plus-31.Probe", version: "2.0.0" };
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"probe.js","sourceRoot":"","sources":["../src/probe.ts"],"names":[],"mappings":";;;;;AACA,qCAAqC;AAyDrC,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B;;OAEG;IACH,iCAAa,CAAA;IAEb;;OAEG;IACH,mCAAe,CAAA;AACjB,CAAC,EAVW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAU3B;AAsDD;;;GAGG;AACH,MAAa,KAAK;IA+BhB,YACmB,YAA0B,EAC1B,gBAAwC,EACxC,cAAqD,EACrD,cAAuD;QAHvD,iBAAY,GAAZ,YAAY,CAAc;QAC1B,qBAAgB,GAAhB,gBAAgB,CAAwB;QACxC,mBAAc,GAAd,cAAc,CAAuC;QACrD,mBAAc,GAAd,cAAc,CAAyC;IAAG,CAAC;IAjC9E;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,IAAY,EAAE,UAA+B,EAAE;QACvE,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,OAAiB,EAAE,UAA+B,EAAE;QAC5E,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,SAAS,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,UAAiC,EAAE;QAC7D,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAC3D,CAAC;IAQD;;OAEG;IACI,OAAO,CAAC,IAAyB;QAEtC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACvG,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClI,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEhH,OAAO;YACL,gBAAgB,EAAE,IAAI,CAAC,YAAY,CAAC,gBAAgB,IAAI,CAAC;YACzD,mBAAmB,EAAE,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS;YAC1H,aAAa,EAAE,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS;YACxG,gBAAgB,EAAE,IAAI,CAAC,YAAY,CAAC,gBAAgB;YACpD,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS;YAC3G,IAAI,EAAE,IAAI;YACV,OAAO;YACP,SAAS;SACV,CAAC;IACJ,CAAC;;AAxDH,sBAyDC","sourcesContent":["import { Duration } from 'cdk8s';\nimport * as _action from './_action';\nimport * as container from './container';\nimport * as k8s from './imports/k8s';\n\n/**\n * Probe options.\n */\nexport interface ProbeOptions {\n  /**\n   * Minimum consecutive failures for the probe to be considered failed after\n   * having succeeded.\n   *\n   * Defaults to 3. Minimum value is 1.\n   *\n   * @default 3\n   */\n  readonly failureThreshold?: number;\n\n  /**\n   * Number of seconds after the container has started before liveness probes\n   * are initiated.\n   *\n   * @see https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n   * @default - immediate\n   */\n  readonly initialDelaySeconds?: Duration;\n\n  /**\n   * How often (in seconds) to perform the probe.\n   *\n   * Default to 10 seconds. Minimum value is 1.\n   *\n   * @default Duration.seconds(10) Minimum value is 1.\n   */\n  readonly periodSeconds?: Duration;\n\n  /**\n   * Minimum consecutive successes for the probe to be considered successful\n   * after having failed. Defaults to 1.\n   *\n   * Must be 1 for liveness and startup. Minimum value is 1.\n   *\n   * @default 1 Must be 1 for liveness and startup. Minimum value is 1.\n   */\n  readonly successThreshold?: number;\n\n  /**\n   * Number of seconds after which the probe times out.\n   *\n   * Defaults to 1 second. Minimum value is 1.\n   *\n   * @see https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n   * @default Duration.seconds(1)\n   */\n  readonly timeoutSeconds?: Duration;\n}\n\nexport enum ConnectionScheme {\n  /**\n   * Use HTTP request for connecting to host.\n   */\n  HTTP = 'HTTP',\n\n  /**\n   * Use HTTPS request for connecting to host.\n   */\n  HTTPS = 'HTTPS'\n}\n\n/**\n * Options for `Probe.fromHttpGet()`.\n */\nexport interface HttpGetProbeOptions extends ProbeOptions {\n  /**\n   * The TCP port to use when sending the GET request.\n   *\n   * @default - defaults to `container.port`.\n   */\n  readonly port?: number;\n\n  /**\n   *  Scheme to use for connecting to the host (HTTP or HTTPS).\n   *\n   *  @default ConnectionScheme.HTTP\n   */\n  readonly scheme?: ConnectionScheme;\n\n  /**\n   * The host name to connect to on the container.\n   *\n   * @default - defaults to the pod IP\n   */\n  readonly host?: string;\n}\n\n/**\n * Options for `Probe.fromCommand()`.\n */\nexport interface CommandProbeOptions extends ProbeOptions {\n\n}\n\n/**\n * Options for `Probe.fromTcpSocket()`.\n */\nexport interface TcpSocketProbeOptions extends ProbeOptions {\n  /**\n   * The TCP port to connect to on the container.\n   *\n   * @default - defaults to `container.port`.\n   */\n  readonly port?: number;\n\n  /**\n   * The host name to connect to on the container.\n   *\n   * @default - defaults to the pod IP\n   */\n  readonly host?: string;\n}\n\n/**\n * Probe describes a health check to be performed against a container to\n * determine whether it is alive or ready to receive traffic.\n */\nexport class Probe {\n\n  /**\n   * Defines a probe based on an HTTP GET request to the IP address of the container.\n   *\n   * @param path The URL path to hit\n   * @param options Options\n   */\n  public static fromHttpGet(path: string, options: HttpGetProbeOptions = {}): Probe {\n    return new Probe(options, undefined, undefined, { path, ...options });\n  }\n\n  /**\n   * Defines a probe based on a command which is executed within the container.\n   *\n   * @param command The command to execute\n   * @param options Options\n   */\n  public static fromCommand(command: string[], options: CommandProbeOptions = {}): Probe {\n    return new Probe(options, undefined, { command, ...options }, undefined);\n  }\n\n  /**\n   * Defines a probe based opening a connection to a TCP socket on the container.\n   *\n   * @param options Options\n   */\n  public static fromTcpSocket(options: TcpSocketProbeOptions = {}): Probe {\n    return new Probe(options, options, undefined, undefined);\n  }\n\n  private constructor(\n    private readonly probeOptions: ProbeOptions,\n    private readonly tcpSocketOptions?: TcpSocketProbeOptions,\n    private readonly commandOptions?: { command: string[] } & ProbeOptions,\n    private readonly httpGetOptions?: { path: string } & HttpGetProbeOptions) {}\n\n  /**\n   * @internal\n   */\n  public _toKube(cont: container.Container): k8s.Probe {\n\n    const exec = this.commandOptions ? _action.Action.fromCommand(this.commandOptions.command) : undefined;\n    const httpGet = this.httpGetOptions ? _action.Action.fromHttpGet(cont, this.httpGetOptions.path, this.httpGetOptions) : undefined;\n    const tcpSocket = this.tcpSocketOptions ? _action.Action.fromTcpSocket(cont, this.tcpSocketOptions) : undefined;\n\n    return {\n      failureThreshold: this.probeOptions.failureThreshold ?? 3,\n      initialDelaySeconds: this.probeOptions.initialDelaySeconds ? this.probeOptions.initialDelaySeconds.toSeconds() : undefined,\n      periodSeconds: this.probeOptions.periodSeconds ? this.probeOptions.periodSeconds.toSeconds() : undefined,\n      successThreshold: this.probeOptions.successThreshold,\n      timeoutSeconds: this.probeOptions.timeoutSeconds ? this.probeOptions.timeoutSeconds.toSeconds() : undefined,\n      exec: exec,\n      httpGet,\n      tcpSocket,\n    };\n  }\n}\n"]}

package/lib/pv.d.ts

@@ -0,0 +1,375 @@
+import { ApiObject, Size } from 'cdk8s';
+import { Construct } from 'constructs';
+import * as base from './base';
+import * as k8s from './imports/k8s';
+import * as pvc from './pvc';
+import * as volume from './volume';
+/**
+ * Contract of a `PersistentVolumeClaim`.
+ */
+export interface IPersistentVolume extends base.IResource {
+}
+/**
+ * Properties for `PersistentVolume`.
+ */
+export interface PersistentVolumeProps extends base.ResourceProps {
+    /**
+     * Contains all ways the volume can be mounted.
+     *
+     * @see https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
+     * @default - No access modes.
+     */
+    readonly accessModes?: pvc.PersistentVolumeAccessMode[];
+    /**
+     * What is the storage capacity of this volume.
+     *
+     * @see https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
+     * @default - No specified.
+     */
+    readonly storage?: Size;
+    /**
+     * Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
+     * Expected to be non-nil when bound.
+     *
+     * @see https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
+     * @default - Not bound to a specific claim.
+     */
+    readonly claim?: pvc.IPersistentVolumeClaim;
+    /**
+     * A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid.
+     *
+     * @see https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
+     * @default - No options.
+     */
+    readonly mountOptions?: string[];
+    /**
+     * When a user is done with their volume, they can delete the PVC objects from the API that
+     * allows reclamation of the resource. The reclaim policy tells the cluster what to do with
+     * the volume after it has been released of its claim.
+     *
+     * @see https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
+     * @default PersistentVolumeReclaimPolicy.RETAIN
+     */
+    readonly reclaimPolicy?: PersistentVolumeReclaimPolicy;
+    /**
+     * Name of StorageClass to which this persistent volume belongs.
+     *
+     * @default - Volume does not belong to any storage class.
+     */
+    readonly storageClassName?: string;
+    /**
+     * Defines what type of volume is required by the claim.
+     *
+     * @default VolumeMode.FILE_SYSTEM
+     */
+    readonly volumeMode?: pvc.PersistentVolumeMode;
+}
+/**
+ * A PersistentVolume (PV) is a piece of storage in the cluster that has been
+ * provisioned by an administrator or dynamically provisioned using Storage Classes.
+ * It is a resource in the cluster just like a node is a cluster resource.
+ * PVs are volume plugins like Volumes, but have a lifecycle independent of any
+ * individual Pod that uses the PV. This API object captures the details of the
+ * implementation of the storage, be that NFS, iSCSI, or a
+ * cloud-provider-specific storage system.
+ */
+export declare class PersistentVolume extends base.Resource implements IPersistentVolume, volume.IStorage {
+    /**
+     * Imports a pv from the cluster as a reference.
+     */
+    static fromPersistentVolumeName(scope: Construct, id: string, volumeName: string): IPersistentVolume;
+    /**
+     * @see base.Resource.apiObject
+     */
+    protected readonly apiObject: ApiObject;
+    readonly resourceType = "persistentvolumes";
+    private _claim?;
+    /**
+     * Storage size of this volume.
+     */
+    readonly storage?: Size;
+    /**
+     * Volume mode of this volume.
+     */
+    readonly mode: pvc.PersistentVolumeMode;
+    /**
+      * Storage class this volume belongs to.
+      */
+    readonly storageClassName?: string;
+    /**
+     * Access modes requirement of this claim.
+     */
+    private readonly _accessModes?;
+    /**
+     * Mount options of this volume.
+     */
+    readonly mountOptions?: string[];
+    /**
+     * Reclaim policy of this volume.
+     */
+    readonly reclaimPolicy: PersistentVolumeReclaimPolicy;
+    protected constructor(scope: Construct, id: string, props?: PersistentVolumeProps);
+    /**
+     * Access modes requirement of this claim.
+     */
+    get accessModes(): pvc.PersistentVolumeAccessMode[] | undefined;
+    /**
+     * PVC this volume is bound to. Undefined means this volume is not yet
+     * claimed by any PVC.
+     */
+    get claim(): pvc.IPersistentVolumeClaim | undefined;
+    /**
+     * Reserve a `PersistentVolume` by creating a `PersistentVolumeClaim`
+     * that is wired to claim this volume.
+     *
+     * Note that this method will throw in case the volume is already claimed.
+     *
+     * @see https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reserving-a-persistentvolume
+     */
+    reserve(): pvc.PersistentVolumeClaim;
+    /**
+     * Bind a volume to a specific claim.
+     * Note that you must also bind the claim to the volume.
+     *
+     * @see https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding
+     *
+     * @param claim The PVC to bind to.
+     */
+    bind(claim: pvc.IPersistentVolumeClaim): void;
+    asVolume(): volume.Volume;
+    /**
+     * @internal
+     */
+    _toKube(): k8s.PersistentVolumeSpec;
+}
+/**
+ * Reclaim Policies.
+ */
+export declare enum PersistentVolumeReclaimPolicy {
+    /**
+     * The Retain reclaim policy allows for manual reclamation of the resource.
+     * When the PersistentVolumeClaim is deleted, the PersistentVolume still exists and the
+     * volume is considered "released". But it is not yet available for another claim
+     * because the previous claimant's data remains on the volume.
+     * An administrator can manually reclaim the volume with the following steps:
+     *
+     * 1. Delete the PersistentVolume. The associated storage asset in external
+     *    infrastructure (such as an AWS EBS, GCE PD, Azure Disk, or Cinder volume) still exists after the PV is deleted.
+     * 2. Manually clean up the data on the associated storage asset accordingly.
+     * 3. Manually delete the associated storage asset.
+     *
+     * If you want to reuse the same storage asset, create a new PersistentVolume
+     * with the same storage asset definition.
+     */
+    RETAIN = "Retain",
+    /**
+     * For volume plugins that support the Delete reclaim policy, deletion removes both the
+     * PersistentVolume object from Kubernetes, as well as the associated storage asset in
+     * the external infrastructure, such as an AWS EBS, GCE PD, Azure Disk, or Cinder volume.
+     * Volumes that were dynamically provisioned inherit the reclaim policy of their StorageClass, which defaults to Delete.
+     * The administrator should configure the StorageClass according to users' expectations; otherwise,
+     * the PV must be edited or patched after it is created
+     */
+    DELETE = "Delete"
+}
+/**
+ * Properties for `AwsElasticBlockStorePersistentVolume`.
+ */
+export interface AwsElasticBlockStorePersistentVolumeProps extends PersistentVolumeProps {
+    /**
+     * Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+     *
+     * @see https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+     */
+    readonly volumeId: string;
+    /**
+     * Filesystem type of the volume that you want to mount.
+     * Tip: Ensure that the filesystem type is supported by the host operating system.
+     *
+     * @see https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+     * @default 'ext4'
+     */
+    readonly fsType?: string;
+    /**
+      * The partition in the volume that you want to mount. If omitted, the default is to mount by volume name.
+      * Examples: For volume /dev/sda1, you specify the partition as "1".
+      * Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+      *
+      * @default - No partition.
+      */
+    readonly partition?: number;
+    /**
+      * Specify "true" to force and set the ReadOnly property in VolumeMounts to "true".
+      *
+      * @see https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+      * @default false
+      */
+    readonly readOnly?: boolean;
+}
+/**
+ * Represents an AWS Disk resource that is attached to a kubelet's host machine and
+ * then exposed to the pod.
+ *
+ * @see https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ */
+export declare class AwsElasticBlockStorePersistentVolume extends PersistentVolume {
+    /**
+     * Volume id of this volume.
+     */
+    readonly volumeId: string;
+    /**
+     * Whether or not it is mounted as a read-only volume.
+     */
+    readonly readOnly: boolean;
+    /**
+     * File system type of this volume.
+     */
+    readonly fsType: string;
+    /**
+     * Partition of this volume.
+     */
+    readonly partition?: number;
+    constructor(scope: Construct, id: string, props: AwsElasticBlockStorePersistentVolumeProps);
+    /**
+     * @internal
+     */
+    _toKube(): k8s.PersistentVolumeSpec;
+}
+/**
+ * Properties for `AzureDiskPersistentVolume`.
+ */
+export interface AzureDiskPersistentVolumeProps extends PersistentVolumeProps {
+    /**
+     * The Name of the data disk in the blob storage
+     */
+    readonly diskName: string;
+    /**
+     * The URI the data disk in the blob storage
+     */
+    readonly diskUri: string;
+    /**
+     * Host Caching mode.
+     *
+     * @default - AzureDiskPersistentVolumeCachingMode.NONE.
+     */
+    readonly cachingMode?: volume.AzureDiskPersistentVolumeCachingMode;
+    /**
+      * Filesystem type to mount. Must be a filesystem type supported by the host operating system.
+      *
+      * @default 'ext4'
+      */
+    readonly fsType?: string;
+    /**
+      * Kind of disk.
+      *
+      * @default AzureDiskPersistentVolumeKind.SHARED
+      */
+    readonly kind?: volume.AzureDiskPersistentVolumeKind;
+    /**
+      * Force the ReadOnly setting in VolumeMounts.
+      *
+      * @default false
+      */
+    readonly readOnly?: boolean;
+}
+/**
+ * AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ */
+export declare class AzureDiskPersistentVolume extends PersistentVolume {
+    /**
+     * Disk name of this volume.
+     */
+    readonly diskName: string;
+    /**
+     * Disk URI of this volume.
+     */
+    readonly diskUri: string;
+    /**
+     * Whether or not it is mounted as a read-only volume.
+     */
+    readonly readOnly: boolean;
+    /**
+     * Caching mode of this volume.
+     */
+    readonly cachingMode: volume.AzureDiskPersistentVolumeCachingMode;
+    /**
+     * File system type of this volume.
+     */
+    readonly fsType: string;
+    /**
+     * Azure kind of this volume.
+     */
+    readonly azureKind: volume.AzureDiskPersistentVolumeKind;
+    constructor(scope: Construct, id: string, props: AzureDiskPersistentVolumeProps);
+    /**
+     * @internal
+     *
+     * @see https://github.com/kubernetes/examples/blob/master/staging/volumes/azure_disk/README.md
+     */
+    _toKube(): k8s.PersistentVolumeSpec;
+}
+/**
+ * Properties for `GCEPersistentDiskPersistentVolume`.
+ */
+export interface GCEPersistentDiskPersistentVolumeProps extends PersistentVolumeProps {
+    /**
+     * Unique name of the PD resource in GCE. Used to identify the disk in GCE.
+     *
+     * @see https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+     */
+    readonly pdName: string;
+    /**
+     * Filesystem type of the volume that you want to mount.
+     * Tip: Ensure that the filesystem type is supported by the host operating system.
+     *
+     * @see https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+     * @default 'ext4'
+     */
+    readonly fsType?: string;
+    /**
+     * The partition in the volume that you want to mount. If omitted, the default is to mount by volume name.
+     * Examples: For volume /dev/sda1, you specify the partition as "1".
+     * Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+     *
+     * @default - No partition.
+     */
+    readonly partition?: number;
+    /**
+     * Specify "true" to force and set the ReadOnly property in VolumeMounts to "true".
+     *
+     * @see https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+     * @default false
+     */
+    readonly readOnly?: boolean;
+}
+/**
+ * GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine
+ * and then exposed to the pod. Provisioned by an admin.
+ *
+ * @see https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ */
+export declare class GCEPersistentDiskPersistentVolume extends PersistentVolume {
+    /**
+     * PD resource in GCE of this volume.
+     */
+    readonly pdName: string;
+    /**
+     * Whether or not it is mounted as a read-only volume.
+     */
+    readonly readOnly: boolean;
+    /**
+     * File system type of this volume.
+     */
+    readonly fsType: string;
+    /**
+     * Partition of this volume.
+     */
+    readonly partition?: number;
+    constructor(scope: Construct, id: string, props: GCEPersistentDiskPersistentVolumeProps);
+    /**
+     * @internal
+     *
+     * @see https://github.com/kubernetes/examples/blob/master/staging/volumes/azure_disk/README.md
+     */
+    _toKube(): k8s.PersistentVolumeSpec;
+}