API.md

API Reference

Constructs

Plone

Initializers

import { Plone } from '@bluedynamics/cdk8s-plone'

new Plone(scope: Construct, id: string, options?: PloneOptions)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
options	PloneOptions	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

options^Optional

• Type: PloneOptions

---

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 { Plone } from '@bluedynamics/cdk8s-plone'

Plone.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
backendServiceName	string	No description.
siteId	string	No description.
variant	PloneVariant	No description.
frontendServiceName	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

backendServiceName^Required

public readonly backendServiceName: string;

• Type: string

---

siteId^Required

public readonly siteId: string;

• Type: string

---

variant^Required

public readonly variant: PloneVariant;

• Type: PloneVariant

---

frontendServiceName^Optional

public readonly frontendServiceName: string;

• Type: string

---

PloneHttpcache

Initializers

import { PloneHttpcache } from '@bluedynamics/cdk8s-plone'

new PloneHttpcache(scope: Construct, id: string, options: PloneHttpcacheOptions)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
options	PloneHttpcacheOptions	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

options^Required

• Type: PloneHttpcacheOptions

---

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 { PloneHttpcache } from '@bluedynamics/cdk8s-plone'

PloneHttpcache.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
httpcacheServiceName	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

httpcacheServiceName^Required

public readonly httpcacheServiceName: string;

• Type: string

---

Structs

PloneBaseOptions

Initializer

import { PloneBaseOptions } from '@bluedynamics/cdk8s-plone'

const ploneBaseOptions: PloneBaseOptions = { ... }

Properties

Name	Type	Description
environment	cdk8s-plus-24.Env	No description.
image	string	No description.
imagePullPolicy	string	No description.
limitCpu	string	No description.
limitMemory	string	No description.
livenessEnabled	boolean	No description.
livenessFailureThreshold	number	No description.
livenessIimeoutSeconds	number	No description.
livenessInitialDelaySeconds	number	No description.
livenessPeriodSeconds	number	No description.
livenessSuccessThreshold	number	No description.
maxUnavailable	string | number	No description.
minAvailable	string | number	No description.
readinessEnabled	boolean	No description.
readinessFailureThreshold	number	No description.
readinessIimeoutSeconds	number	No description.
readinessInitialDelaySeconds	number	No description.
readinessPeriodSeconds	number	No description.
readinessSuccessThreshold	number	No description.
replicas	number	No description.
requestCpu	string	No description.
requestMemory	string	No description.

---

environment^Optional

public readonly environment: Env;

• Type: cdk8s-plus-24.Env

---

image^Optional

public readonly image: string;

• Type: string

---

imagePullPolicy^Optional

public readonly imagePullPolicy: string;

• Type: string

---

limitCpu^Optional

public readonly limitCpu: string;

• Type: string

---

limitMemory^Optional

public readonly limitMemory: string;

• Type: string

---

livenessEnabled^Optional

public readonly livenessEnabled: boolean;

• Type: boolean

---

livenessFailureThreshold^Optional

public readonly livenessFailureThreshold: number;

• Type: number

---

livenessIimeoutSeconds^Optional

public readonly livenessIimeoutSeconds: number;

• Type: number

---

livenessInitialDelaySeconds^Optional

public readonly livenessInitialDelaySeconds: number;

• Type: number

---

livenessPeriodSeconds^Optional

public readonly livenessPeriodSeconds: number;

• Type: number

---

livenessSuccessThreshold^Optional

public readonly livenessSuccessThreshold: number;

• Type: number

---

maxUnavailable^Optional

public readonly maxUnavailable: string | number;

• Type: string | number

---

minAvailable^Optional

public readonly minAvailable: string | number;

• Type: string | number

---

readinessEnabled^Optional

public readonly readinessEnabled: boolean;

• Type: boolean

---

readinessFailureThreshold^Optional

public readonly readinessFailureThreshold: number;

• Type: number

---

readinessIimeoutSeconds^Optional

public readonly readinessIimeoutSeconds: number;

• Type: number

---

readinessInitialDelaySeconds^Optional

public readonly readinessInitialDelaySeconds: number;

• Type: number

---

readinessPeriodSeconds^Optional

public readonly readinessPeriodSeconds: number;

• Type: number

---

readinessSuccessThreshold^Optional

public readonly readinessSuccessThreshold: number;

• Type: number

---

replicas^Optional

public readonly replicas: number;

• Type: number

---

requestCpu^Optional

public readonly requestCpu: string;

• Type: string

---

requestMemory^Optional

public readonly requestMemory: string;

• Type: string

---

PloneHttpcacheOptions

Initializer

import { PloneHttpcacheOptions } from '@bluedynamics/cdk8s-plone'

const ploneHttpcacheOptions: PloneHttpcacheOptions = { ... }

Properties

Name	Type	Description
plone	Plone	plone chart.
existingSecret	string	existingSecret - Read admin credentials from user provided secret.
limitCpu	string	No description.
limitMemory	string	No description.
requestCpu	string	No description.
requestMemory	string	No description.
varnishVcl	string	varnishVcl.
varnishVclFile	string	varnishVclFile.

---

plone^Required

public readonly plone: Plone;

• Type: Plone
• Default: none

plone chart.

---

existingSecret^Optional

public readonly existingSecret: string;

• Type: string
• Default: undefined

existingSecret - Read admin credentials from user provided secret.

---

limitCpu^Optional

public readonly limitCpu: string;

• Type: string

---

limitMemory^Optional

public readonly limitMemory: string;

• Type: string

---

requestCpu^Optional

public readonly requestCpu: string;

• Type: string

---

requestMemory^Optional

public readonly requestMemory: string;

• Type: string

---

varnishVcl^Optional

public readonly varnishVcl: string;

• Type: string
• Default: file in config folder

varnishVcl.

---

varnishVclFile^Optional

public readonly varnishVclFile: string;

• Type: string
• Default: undefined

varnishVclFile.

---

PloneOptions

Initializer

import { PloneOptions } from '@bluedynamics/cdk8s-plone'

const ploneOptions: PloneOptions = { ... }

Properties

Name	Type	Description
backend	PloneBaseOptions	No description.
frontend	PloneBaseOptions	No description.
imagePullSecrets	string[]	No description.
siteId	string	No description.
variant	PloneVariant	No description.
version	string	No description.

---

backend^Optional

public readonly backend: PloneBaseOptions;

• Type: PloneBaseOptions

---

frontend^Optional

public readonly frontend: PloneBaseOptions;

• Type: PloneBaseOptions

---

imagePullSecrets^Optional

public readonly imagePullSecrets: string[];

• Type: string[]

---

siteId^Optional

public readonly siteId: string;

• Type: string

---

variant^Optional

public readonly variant: PloneVariant;

• Type: PloneVariant

---

version^Optional

public readonly version: string;

• Type: string

---

Enums

PloneVariant

Members

Name	Description
VOLTO	No description.
CLASSICUI	No description.

---

VOLTO

---

CLASSICUI

---