projen/lib/cdk8s/cdk8s-construct.d.ts

CDK for software projects

import { ConstructLibrary, ConstructLibraryOptions } from "../cdk";
export interface ConstructLibraryCdk8sOptions extends ConstructLibraryOptions {
    /**
     * Minimum target version this library is tested against.
     *
     * @default "1.4.10"
     * @featured
     */
    readonly cdk8sVersion: string;
    /**
     * constructs verion
     *
     * @default "3.3.196"
     */
    readonly constructsVersion?: string;
    /**
     * Use pinned version instead of caret version for CDK8s.
     *
     * You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates.
     * If you use experimental features this will let you define the moment you include breaking changes.
     *
     * @default false
     */
    readonly cdk8sVersionPinning?: boolean;
    /**
     * Use pinned version instead of caret version for constructs.
     *
     * You can use this to prevent yarn to mix versions for your consructs package and to prevent auto-updates.
     * If you use experimental features this will let you define the moment you include breaking changes.
     *
     * @default false
     */
    readonly constructsVersionPinning?: boolean;
    /**
     * Use pinned version instead of caret version for cdk8s-plus-17.
     *
     * You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates.
     * If you use experimental features this will let you define the moment you include breaking changes.
     *
     * @default false
     */
    readonly cdk8sPlusVersionPinning?: boolean;
    /**
     * Automatically adds an `cdk8s.IntegrationTest` for each `.integ.ts` app
     * in your test directory. If this is disabled, you can manually add an
     * `cdk8s.AutoDiscover` component to your project.
     *
     * @default true
     */
    readonly integrationTestAutoDiscover?: boolean;
}
/**
 * CDK8s construct library project
 *
 * A multi-language (jsii) construct library which vends constructs designed to
 * use within the CDK for Kubernetes (CDK8s), with a friendly workflow and
 * automatic publishing to the construct catalog.
 *
 * @pjid cdk8s-construct
 */
export declare class ConstructLibraryCdk8s extends ConstructLibrary {
    /**
     * The CDK8s version this app is using.
     */
    readonly cdk8sVersion: string;
    /**
     * The constructs version this app is using.
     */
    readonly constructsVersion: string;
    constructor(options: ConstructLibraryCdk8sOptions);
}