cdk8s-plus-34 (TypeScript)

Constructs

AbstractPod

• Implements: IPodSelector, INetworkPolicyPeer, ISubject

Initializers

import { AbstractPod } from 'cdk8s-plus-34'

new AbstractPod(scope: Construct, id: string, props?: AbstractPodProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	AbstractPodProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Optional

• Type: AbstractPodProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
addContainer	No description.
addHostAlias	No description.
addInitContainer	No description.
addVolume	No description.
attachContainer	No description.
toNetworkPolicyPeerConfig	Return the configuration of this peer.
toPodSelector	Convert the peer into a pod selector, if possible.
toPodSelectorConfig	Return the configuration of this selector.
toSubjectConfiguration	Return the subject configuration.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

addContainer

public addContainer(cont: ContainerProps): Container

cont^Required

• Type: ContainerProps

---

addHostAlias

public addHostAlias(hostAlias: HostAlias): void

hostAlias^Required

• Type: HostAlias

---

addInitContainer

public addInitContainer(cont: ContainerProps): Container

cont^Required

• Type: ContainerProps

---

addVolume

public addVolume(vol: Volume): void

vol^Required

• Type: Volume

---

attachContainer

public attachContainer(cont: Container): void

cont^Required

• Type: Container

---

toNetworkPolicyPeerConfig

public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig

Return the configuration of this peer.

INetworkPolicyPeer.toNetworkPolicyPeerConfig ()

toPodSelector

public toPodSelector(): IPodSelector

Convert the peer into a pod selector, if possible.

INetworkPolicyPeer.toPodSelector ()

toPodSelectorConfig

public toPodSelectorConfig(): PodSelectorConfig

Return the configuration of this selector.

IPodSelector.toPodSelectorConfig ()

toSubjectConfiguration

public toSubjectConfiguration(): SubjectConfiguration

Return the subject configuration.

ISubect.toSubjectConfiguration ()

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { AbstractPod } from 'cdk8s-plus-34'

AbstractPod.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.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
automountServiceAccountToken	boolean	No description.
containers	Container[]	No description.
dns	PodDns	No description.
hostAliases	HostAlias[]	No description.
initContainers	Container[]	No description.
podMetadata	cdk8s.ApiObjectMetadataDefinition	No description.
securityContext	PodSecurityContext	No description.
shareProcessNamespace	boolean	No description.
volumes	Volume[]	No description.
dockerRegistryAuth	ISecret	No description.
enableServiceLinks	boolean	No description.
hostNetwork	boolean	No description.
restartPolicy	RestartPolicy	No description.
serviceAccount	IServiceAccount	No description.
terminationGracePeriod	cdk8s.Duration	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

automountServiceAccountToken^Required

public readonly automountServiceAccountToken: boolean;

• Type: boolean

---

containers^Required

public readonly containers: Container[];

• Type: Container[]

---

dns^Required

public readonly dns: PodDns;

• Type: PodDns

---

hostAliases^Required

public readonly hostAliases: HostAlias[];

• Type: HostAlias[]

---

initContainers^Required

public readonly initContainers: Container[];

• Type: Container[]

---

podMetadata^Required

public readonly podMetadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

securityContext^Required

public readonly securityContext: PodSecurityContext;

• Type: PodSecurityContext

---

shareProcessNamespace^Required

public readonly shareProcessNamespace: boolean;

• Type: boolean

---

volumes^Required

public readonly volumes: Volume[];

• Type: Volume[]

---

dockerRegistryAuth^Optional

public readonly dockerRegistryAuth: ISecret;

• Type: ISecret

---

enableServiceLinks^Optional

public readonly enableServiceLinks: boolean;

• Type: boolean

---

hostNetwork^Optional

public readonly hostNetwork: boolean;

• Type: boolean

---

restartPolicy^Optional

public readonly restartPolicy: RestartPolicy;

• Type: RestartPolicy

---

serviceAccount^Optional

public readonly serviceAccount: IServiceAccount;

• Type: IServiceAccount

---

terminationGracePeriod^Optional

public readonly terminationGracePeriod: Duration;

• Type: cdk8s.Duration

---

AwsElasticBlockStorePersistentVolume

Represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod.

https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Initializers

import { AwsElasticBlockStorePersistentVolume } from 'cdk8s-plus-34'

new AwsElasticBlockStorePersistentVolume(scope: Construct, id: string, props: AwsElasticBlockStorePersistentVolumeProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	AwsElasticBlockStorePersistentVolumeProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: AwsElasticBlockStorePersistentVolumeProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
asVolume	Convert the piece of storage into a concrete volume.
bind	Bind a volume to a specific claim.
reserve	Reserve a PersistentVolume by creating a PersistentVolumeClaim that is wired to claim this volume.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

asVolume

public asVolume(): Volume

Convert the piece of storage into a concrete volume.

bind

public bind(claim: IPersistentVolumeClaim): void

Bind a volume to a specific claim.

Note that you must also bind the claim to the volume.

https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding

claim^Required

• Type: IPersistentVolumeClaim

The PVC to bind to.

---

reserve

public reserve(): PersistentVolumeClaim

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.

https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reserving-a-persistentvolume

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
fromPersistentVolumeName	Imports a pv from the cluster as a reference.

---

isConstruct

import { AwsElasticBlockStorePersistentVolume } from 'cdk8s-plus-34'

AwsElasticBlockStorePersistentVolume.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.

---

fromPersistentVolumeName

import { AwsElasticBlockStorePersistentVolume } from 'cdk8s-plus-34'

AwsElasticBlockStorePersistentVolume.fromPersistentVolumeName(scope: Construct, id: string, volumeName: string)

Imports a pv from the cluster as a reference.

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

volumeName^Required

• Type: string

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
mode	PersistentVolumeMode	Volume mode of this volume.
reclaimPolicy	PersistentVolumeReclaimPolicy	Reclaim policy of this volume.
accessModes	PersistentVolumeAccessMode[]	Access modes requirement of this claim.
claim	IPersistentVolumeClaim	PVC this volume is bound to.
mountOptions	string[]	Mount options of this volume.
storage	cdk8s.Size	Storage size of this volume.
storageClassName	string	Storage class this volume belongs to.
fsType	string	File system type of this volume.
readOnly	boolean	Whether or not it is mounted as a read-only volume.
volumeId	string	Volume id of this volume.
partition	number	Partition of this volume.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

mode^Required

public readonly mode: PersistentVolumeMode;

• Type: PersistentVolumeMode

Volume mode of this volume.

---

reclaimPolicy^Required

public readonly reclaimPolicy: PersistentVolumeReclaimPolicy;

• Type: PersistentVolumeReclaimPolicy

Reclaim policy of this volume.

---

accessModes^Optional

public readonly accessModes: PersistentVolumeAccessMode[];

• Type: PersistentVolumeAccessMode[]

Access modes requirement of this claim.

---

claim^Optional

public readonly claim: IPersistentVolumeClaim;

• Type: IPersistentVolumeClaim

PVC this volume is bound to.

Undefined means this volume is not yet claimed by any PVC.

---

mountOptions^Optional

public readonly mountOptions: string[];

• Type: string[]

Mount options of this volume.

---

storage^Optional

public readonly storage: Size;

• Type: cdk8s.Size

Storage size of this volume.

---

storageClassName^Optional

public readonly storageClassName: string;

• Type: string

Storage class this volume belongs to.

---

fsType^Required

public readonly fsType: string;

• Type: string

File system type of this volume.

---

readOnly^Required

public readonly readOnly: boolean;

• Type: boolean

Whether or not it is mounted as a read-only volume.

---

volumeId^Required

public readonly volumeId: string;

• Type: string

Volume id of this volume.

---

partition^Optional

public readonly partition: number;

• Type: number

Partition of this volume.

---

AzureDiskPersistentVolume

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Initializers

import { AzureDiskPersistentVolume } from 'cdk8s-plus-34'

new AzureDiskPersistentVolume(scope: Construct, id: string, props: AzureDiskPersistentVolumeProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	AzureDiskPersistentVolumeProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: AzureDiskPersistentVolumeProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
asVolume	Convert the piece of storage into a concrete volume.
bind	Bind a volume to a specific claim.
reserve	Reserve a PersistentVolume by creating a PersistentVolumeClaim that is wired to claim this volume.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

asVolume

public asVolume(): Volume

Convert the piece of storage into a concrete volume.

bind

public bind(claim: IPersistentVolumeClaim): void

Bind a volume to a specific claim.

Note that you must also bind the claim to the volume.

https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding

claim^Required

• Type: IPersistentVolumeClaim

The PVC to bind to.

---

reserve

public reserve(): PersistentVolumeClaim

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.

https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reserving-a-persistentvolume

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
fromPersistentVolumeName	Imports a pv from the cluster as a reference.

---

isConstruct

import { AzureDiskPersistentVolume } from 'cdk8s-plus-34'

AzureDiskPersistentVolume.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.

---

fromPersistentVolumeName

import { AzureDiskPersistentVolume } from 'cdk8s-plus-34'

AzureDiskPersistentVolume.fromPersistentVolumeName(scope: Construct, id: string, volumeName: string)

Imports a pv from the cluster as a reference.

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

volumeName^Required

• Type: string

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
mode	PersistentVolumeMode	Volume mode of this volume.
reclaimPolicy	PersistentVolumeReclaimPolicy	Reclaim policy of this volume.
accessModes	PersistentVolumeAccessMode[]	Access modes requirement of this claim.
claim	IPersistentVolumeClaim	PVC this volume is bound to.
mountOptions	string[]	Mount options of this volume.
storage	cdk8s.Size	Storage size of this volume.
storageClassName	string	Storage class this volume belongs to.
azureKind	AzureDiskPersistentVolumeKind	Azure kind of this volume.
cachingMode	AzureDiskPersistentVolumeCachingMode	Caching mode of this volume.
diskName	string	Disk name of this volume.
diskUri	string	Disk URI of this volume.
fsType	string	File system type of this volume.
readOnly	boolean	Whether or not it is mounted as a read-only volume.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

mode^Required

public readonly mode: PersistentVolumeMode;

• Type: PersistentVolumeMode

Volume mode of this volume.

---

reclaimPolicy^Required

public readonly reclaimPolicy: PersistentVolumeReclaimPolicy;

• Type: PersistentVolumeReclaimPolicy

Reclaim policy of this volume.

---

accessModes^Optional

public readonly accessModes: PersistentVolumeAccessMode[];

• Type: PersistentVolumeAccessMode[]

Access modes requirement of this claim.

---

claim^Optional

public readonly claim: IPersistentVolumeClaim;

• Type: IPersistentVolumeClaim

PVC this volume is bound to.

Undefined means this volume is not yet claimed by any PVC.

---

mountOptions^Optional

public readonly mountOptions: string[];

• Type: string[]

Mount options of this volume.

---

storage^Optional

public readonly storage: Size;

• Type: cdk8s.Size

Storage size of this volume.

---

storageClassName^Optional

public readonly storageClassName: string;

• Type: string

Storage class this volume belongs to.

---

azureKind^Required

public readonly azureKind: AzureDiskPersistentVolumeKind;

• Type: AzureDiskPersistentVolumeKind

Azure kind of this volume.

---

cachingMode^Required

public readonly cachingMode: AzureDiskPersistentVolumeCachingMode;

• Type: AzureDiskPersistentVolumeCachingMode

Caching mode of this volume.

---

diskName^Required

public readonly diskName: string;

• Type: string

Disk name of this volume.

---

diskUri^Required

public readonly diskUri: string;

• Type: string

Disk URI of this volume.

---

fsType^Required

public readonly fsType: string;

• Type: string

File system type of this volume.

---

readOnly^Required

public readonly readOnly: boolean;

• Type: boolean

Whether or not it is mounted as a read-only volume.

---

BasicAuthSecret

Create a secret for basic authentication.

https://kubernetes.io/docs/concepts/configuration/secret/#basic-authentication-secret

Initializers

import { BasicAuthSecret } from 'cdk8s-plus-34'

new BasicAuthSecret(scope: Construct, id: string, props: BasicAuthSecretProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	BasicAuthSecretProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: BasicAuthSecretProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
addStringData	Adds a string data field to the secret.
envValue	Returns EnvValue object from a secret’s key.
getStringData	Gets a string data by key or undefined.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

addStringData

public addStringData(key: string, value: string): void

Adds a string data field to the secret.

key^Required

• Type: string

Key.

---

value^Required

• Type: string

Value.

---

envValue

public envValue(key: string, options?: EnvValueFromSecretOptions): EnvValue

Returns EnvValue object from a secret’s key.

key^Required

• Type: string

---

options^Optional

• Type: EnvValueFromSecretOptions

---

getStringData

public getStringData(key: string): string

Gets a string data by key or undefined.

key^Required

• Type: string

Key.

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
fromSecretName	Imports a secret from the cluster as a reference.

---

isConstruct

import { BasicAuthSecret } from 'cdk8s-plus-34'

BasicAuthSecret.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.

---

fromSecretName

import { BasicAuthSecret } from 'cdk8s-plus-34'

BasicAuthSecret.fromSecretName(scope: Construct, id: string, name: string)

Imports a secret from the cluster as a reference.

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

name^Required

• Type: string

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
immutable	boolean	Whether or not the secret is immutable.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

immutable^Required

public readonly immutable: boolean;

• Type: boolean

Whether or not the secret is immutable.

---

ClusterRole

• Implements: IClusterRole, IRole

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

Initializers

import { ClusterRole } from 'cdk8s-plus-34'

new ClusterRole(scope: Construct, id: string, props?: ClusterRoleProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	ClusterRoleProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Optional

• Type: ClusterRoleProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
aggregate	Aggregate rules from roles matching this label selector.
allow	Add permission to perform a list of HTTP verbs on a collection of resources.
allowCreate	Add “create” permission for the resources.
allowDelete	Add “delete” permission for the resources.
allowDeleteCollection	Add “deletecollection” permission for the resources.
allowGet	Add “get” permission for the resources.
allowList	Add “list” permission for the resources.
allowPatch	Add “patch” permission for the resources.
allowRead	Add “get”, “list”, and “watch” permissions for the resources.
allowReadWrite	Add “get”, “list”, “watch”, “create”, “update”, “patch”, “delete”, and “deletecollection” permissions for the resources.
allowUpdate	Add “update” permission for the resources.
allowWatch	Add “watch” permission for the resources.
bind	Create a ClusterRoleBinding that binds the permissions in this ClusterRole to a list of subjects, without namespace restrictions.
bindInNamespace	Create a RoleBinding that binds the permissions in this ClusterRole to a list of subjects, that will only apply to the given namespace.
combine	Combines the rules of the argument ClusterRole into this ClusterRole using aggregation labels.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

aggregate

public aggregate(key: string, value: string): void

Aggregate rules from roles matching this label selector.

key^Required

• Type: string

---

value^Required

• Type: string

---

allow

public allow(verbs: string[], endpoints: ...IApiEndpoint[]): void

Add permission to perform a list of HTTP verbs on a collection of resources.

https://kubernetes.io/docs/reference/access-authn-authz/authorization/#determine-the-request-verb

verbs^Required

• Type: string[]

---

endpoints^Required

• Type: …IApiEndpoint[]

The endpoints(s) to apply to.

---

allowCreate

public allowCreate(endpoints: ...IApiEndpoint[]): void

Add “create” permission for the resources.

endpoints^Required

• Type: …IApiEndpoint[]

The resource(s) to apply to.

---

allowDelete

public allowDelete(endpoints: ...IApiEndpoint[]): void

Add “delete” permission for the resources.

endpoints^Required

• Type: …IApiEndpoint[]

The resource(s) to apply to.

---

allowDeleteCollection

public allowDeleteCollection(endpoints: ...IApiEndpoint[]): void

Add “deletecollection” permission for the resources.

endpoints^Required

• Type: …IApiEndpoint[]

The resource(s) to apply to.

---

allowGet

public allowGet(endpoints: ...IApiEndpoint[]): void

Add “get” permission for the resources.

endpoints^Required

• Type: …IApiEndpoint[]

The resource(s) to apply to.

---

allowList

public allowList(endpoints: ...IApiEndpoint[]): void

Add “list” permission for the resources.

endpoints^Required

• Type: …IApiEndpoint[]

The resource(s) to apply to.

---

allowPatch

public allowPatch(endpoints: ...IApiEndpoint[]): void

Add “patch” permission for the resources.

endpoints^Required

• Type: …IApiEndpoint[]

The resource(s) to apply to.

---

allowRead

public allowRead(endpoints: ...IApiEndpoint[]): void

Add “get”, “list”, and “watch” permissions for the resources.

endpoints^Required

• Type: …IApiEndpoint[]

The resource(s) to apply to.

---

allowReadWrite

public allowReadWrite(endpoints: ...IApiEndpoint[]): void

Add “get”, “list”, “watch”, “create”, “update”, “patch”, “delete”, and “deletecollection” permissions for the resources.

endpoints^Required

• Type: …IApiEndpoint[]

The resource(s) to apply to.

---

allowUpdate

public allowUpdate(endpoints: ...IApiEndpoint[]): void

Add “update” permission for the resources.

endpoints^Required

• Type: …IApiEndpoint[]

The resource(s) to apply to.

---

allowWatch

public allowWatch(endpoints: ...IApiEndpoint[]): void

Add “watch” permission for the resources.

endpoints^Required

• Type: …IApiEndpoint[]

The resource(s) to apply to.

---

bind

public bind(subjects: ...ISubject[]): ClusterRoleBinding

Create a ClusterRoleBinding that binds the permissions in this ClusterRole to a list of subjects, without namespace restrictions.

subjects^Required

• Type: …ISubject[]

a list of subjects to bind to.

---

bindInNamespace

public bindInNamespace(namespace: string, subjects: ...ISubject[]): RoleBinding

Create a RoleBinding that binds the permissions in this ClusterRole to a list of subjects, that will only apply to the given namespace.

namespace^Required

• Type: string

the namespace to limit permissions to.

---

subjects^Required

• Type: …ISubject[]

a list of subjects to bind to.

---

combine

public combine(rol: ClusterRole): void

Combines the rules of the argument ClusterRole into this ClusterRole using aggregation labels.

rol^Required

• Type: ClusterRole

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
fromClusterRoleName	Imports a role from the cluster as a reference.

---

isConstruct

import { ClusterRole } from 'cdk8s-plus-34'

ClusterRole.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.

---

fromClusterRoleName

import { ClusterRole } from 'cdk8s-plus-34'

ClusterRole.fromClusterRoleName(scope: Construct, id: string, name: string)

Imports a role from the cluster as a reference.

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

name^Required

• Type: string

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
rules	ClusterRolePolicyRule[]	Rules associaated with this Role.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

rules^Required

public readonly rules: ClusterRolePolicyRule[];

• Type: ClusterRolePolicyRule[]

Rules associaated with this Role.

Returns a copy, use allow to add rules.

---

ClusterRoleBinding

A ClusterRoleBinding grants permissions cluster-wide to a user or set of users.

Initializers

import { ClusterRoleBinding } from 'cdk8s-plus-34'

new ClusterRoleBinding(scope: Construct, id: string, props: ClusterRoleBindingProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	ClusterRoleBindingProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: ClusterRoleBindingProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
addSubjects	Adds a subject to the role.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

addSubjects

public addSubjects(subjects: ...ISubject[]): void

Adds a subject to the role.

subjects^Required

• Type: …ISubject[]

The subjects to add.

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { ClusterRoleBinding } from 'cdk8s-plus-34'

ClusterRoleBinding.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.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
role	IClusterRole	No description.
subjects	ISubject[]	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

role^Required

public readonly role: IClusterRole;

• Type: IClusterRole

---

subjects^Required

public readonly subjects: ISubject[];

• Type: ISubject[]

---

ConfigMap

• Implements: IConfigMap

ConfigMap holds configuration data for pods to consume.

Initializers

import { ConfigMap } from 'cdk8s-plus-34'

new ConfigMap(scope: Construct, id: string, props?: ConfigMapProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	ConfigMapProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Optional

• Type: ConfigMapProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
addBinaryData	Adds a binary data entry to the config map.
addData	Adds a data entry to the config map.
addDirectory	Adds a directory to the ConfigMap.
addFile	Adds a file to the ConfigMap.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

addBinaryData

public addBinaryData(key: string, value: string): void

Adds a binary data entry to the config map.

BinaryData can contain byte sequences that are not in the UTF-8 range.

key^Required

• Type: string

The key.

---

value^Required

• Type: string

The value.

---

addData

public addData(key: string, value: string): void

Adds a data entry to the config map.

key^Required

• Type: string

The key.

---

value^Required

• Type: string

The value.

---

addDirectory

public addDirectory(localDir: string, options?: AddDirectoryOptions): void

Adds a directory to the ConfigMap.

localDir^Required

• Type: string

A path to a local directory.

---

options^Optional

• Type: AddDirectoryOptions

Options.

---

addFile

public addFile(localFile: string, key?: string): void

Adds a file to the ConfigMap.

localFile^Required

• Type: string

The path to the local file.

---

key^Optional

• Type: string

The ConfigMap key (default to the file name).

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
fromConfigMapName	Represents a ConfigMap created elsewhere.

---

isConstruct

import { ConfigMap } from 'cdk8s-plus-34'

ConfigMap.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.

---

fromConfigMapName

import { ConfigMap } from 'cdk8s-plus-34'

ConfigMap.fromConfigMapName(scope: Construct, id: string, name: string)

Represents a ConfigMap created elsewhere.

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

name^Required

• Type: string

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
binaryData	{[ key: string ]: string}	The binary data associated with this config map.
data	{[ key: string ]: string}	The data associated with this config map.
immutable	boolean	Whether or not this config map is immutable.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

binaryData^Required

public readonly binaryData: {[ key: string ]: string};

• Type: {[ key: string ]: string}

The binary data associated with this config map.

Returns a copy. To add data records, use addBinaryData() or addData().

---

data^Required

public readonly data: {[ key: string ]: string};

• Type: {[ key: string ]: string}

The data associated with this config map.

Returns an copy. To add data records, use addData() or addBinaryData().

---

immutable^Required

public readonly immutable: boolean;

• Type: boolean

Whether or not this config map is immutable.

---

CronJob

A CronJob is responsible for creating a Job and scheduling it based on provided cron schedule.

This helps running Jobs in a recurring manner.

Initializers

import { CronJob } from 'cdk8s-plus-34'

new CronJob(scope: Construct, id: string, props: CronJobProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	CronJobProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: CronJobProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
addContainer	No description.
addHostAlias	No description.
addInitContainer	No description.
addVolume	No description.
attachContainer	No description.
toNetworkPolicyPeerConfig	Return the configuration of this peer.
toPodSelector	Convert the peer into a pod selector, if possible.
toPodSelectorConfig	Return the configuration of this selector.
toSubjectConfiguration	Return the subject configuration.
select	Configure selectors for this workload.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

addContainer

public addContainer(cont: ContainerProps): Container

cont^Required

• Type: ContainerProps

---

addHostAlias

public addHostAlias(hostAlias: HostAlias): void

hostAlias^Required

• Type: HostAlias

---

addInitContainer

public addInitContainer(cont: ContainerProps): Container

cont^Required

• Type: ContainerProps

---

addVolume

public addVolume(vol: Volume): void

vol^Required

• Type: Volume

---

attachContainer

public attachContainer(cont: Container): void

cont^Required

• Type: Container

---

toNetworkPolicyPeerConfig

public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig

Return the configuration of this peer.

INetworkPolicyPeer.toNetworkPolicyPeerConfig ()

toPodSelector

public toPodSelector(): IPodSelector

Convert the peer into a pod selector, if possible.

INetworkPolicyPeer.toPodSelector ()

toPodSelectorConfig

public toPodSelectorConfig(): PodSelectorConfig

Return the configuration of this selector.

IPodSelector.toPodSelectorConfig ()

toSubjectConfiguration

public toSubjectConfiguration(): SubjectConfiguration

Return the subject configuration.

ISubect.toSubjectConfiguration ()

select

public select(selectors: ...LabelSelector[]): void

Configure selectors for this workload.

selectors^Required

• Type: …LabelSelector[]

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { CronJob } from 'cdk8s-plus-34'

CronJob.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.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	Represents the resource type.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
automountServiceAccountToken	boolean	No description.
containers	Container[]	No description.
dns	PodDns	No description.
hostAliases	HostAlias[]	No description.
initContainers	Container[]	No description.
podMetadata	cdk8s.ApiObjectMetadataDefinition	The metadata of pods in this workload.
securityContext	PodSecurityContext	No description.
shareProcessNamespace	boolean	No description.
volumes	Volume[]	No description.
dockerRegistryAuth	ISecret	No description.
enableServiceLinks	boolean	No description.
hostNetwork	boolean	No description.
restartPolicy	RestartPolicy	No description.
serviceAccount	IServiceAccount	No description.
terminationGracePeriod	cdk8s.Duration	No description.
connections	PodConnections	No description.
matchExpressions	LabelSelectorRequirement[]	The expression matchers this workload will use in order to select pods.
matchLabels	{[ key: string ]: string}	The label matchers this workload will use in order to select pods.
scheduling	WorkloadScheduling	No description.
concurrencyPolicy	string	The policy used by this cron job to determine the concurrency mode in which to schedule jobs.
failedJobsRetained	number	The number of failed jobs retained by this cron job.
schedule	cdk8s.Cron	The schedule this cron job is scheduled to run in.
startingDeadline	cdk8s.Duration	The time by which the running cron job needs to schedule the next job execution.
successfulJobsRetained	number	The number of successful jobs retained by this cron job.
suspend	boolean	Whether or not the cron job is currently suspended or not.
timeZone	string	The timezone which this cron job would follow to schedule jobs.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

Represents the resource type.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

automountServiceAccountToken^Required

public readonly automountServiceAccountToken: boolean;

• Type: boolean

---

containers^Required

public readonly containers: Container[];

• Type: Container[]

---

dns^Required

public readonly dns: PodDns;

• Type: PodDns

---

hostAliases^Required

public readonly hostAliases: HostAlias[];

• Type: HostAlias[]

---

initContainers^Required

public readonly initContainers: Container[];

• Type: Container[]

---

podMetadata^Required

public readonly podMetadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

The metadata of pods in this workload.

---

securityContext^Required

public readonly securityContext: PodSecurityContext;

• Type: PodSecurityContext

---

shareProcessNamespace^Required

public readonly shareProcessNamespace: boolean;

• Type: boolean

---

volumes^Required

public readonly volumes: Volume[];

• Type: Volume[]

---

dockerRegistryAuth^Optional

public readonly dockerRegistryAuth: ISecret;

• Type: ISecret

---

enableServiceLinks^Optional

public readonly enableServiceLinks: boolean;

• Type: boolean

---

hostNetwork^Optional

public readonly hostNetwork: boolean;

• Type: boolean

---

restartPolicy^Optional

public readonly restartPolicy: RestartPolicy;

• Type: RestartPolicy

---

serviceAccount^Optional

public readonly serviceAccount: IServiceAccount;

• Type: IServiceAccount

---

terminationGracePeriod^Optional

public readonly terminationGracePeriod: Duration;

• Type: cdk8s.Duration

---

connections^Required

public readonly connections: PodConnections;

• Type: PodConnections

---

matchExpressions^Required

public readonly matchExpressions: LabelSelectorRequirement[];

• Type: LabelSelectorRequirement[]

The expression matchers this workload will use in order to select pods.

Returns a a copy. Use select() to add expression matchers.

---

matchLabels^Required

public readonly matchLabels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

The label matchers this workload will use in order to select pods.

Returns a a copy. Use select() to add label matchers.

---

scheduling^Required

public readonly scheduling: WorkloadScheduling;

• Type: WorkloadScheduling

---

concurrencyPolicy^Required

public readonly concurrencyPolicy: string;

• Type: string

The policy used by this cron job to determine the concurrency mode in which to schedule jobs.

---

failedJobsRetained^Required

public readonly failedJobsRetained: number;

• Type: number

The number of failed jobs retained by this cron job.

---

schedule^Required

public readonly schedule: Cron;

• Type: cdk8s.Cron

The schedule this cron job is scheduled to run in.

---

startingDeadline^Required

public readonly startingDeadline: Duration;

• Type: cdk8s.Duration

The time by which the running cron job needs to schedule the next job execution.

The job is considered as failed if it misses this deadline.

---

successfulJobsRetained^Required

public readonly successfulJobsRetained: number;

• Type: number

The number of successful jobs retained by this cron job.

---

suspend^Required

public readonly suspend: boolean;

• Type: boolean

Whether or not the cron job is currently suspended or not.

---

timeZone^Optional

public readonly timeZone: string;

• Type: string

The timezone which this cron job would follow to schedule jobs.

---

DaemonSet

A DaemonSet ensures that all (or some) Nodes run a copy of a Pod.

As nodes are added to the cluster, Pods are added to them. As nodes are removed from the cluster, those Pods are garbage collected. Deleting a DaemonSet will clean up the Pods it created.

Some typical uses of a DaemonSet are:

• running a cluster storage daemon on every node
• running a logs collection daemon on every node
• running a node monitoring daemon on every node

In a simple case, one DaemonSet, covering all nodes, would be used for each type of daemon. A more complex setup might use multiple DaemonSets for a single type of daemon, but with different flags and/or different memory and cpu requests for different hardware types.

Initializers

import { DaemonSet } from 'cdk8s-plus-34'

new DaemonSet(scope: Construct, id: string, props?: DaemonSetProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	DaemonSetProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Optional

• Type: DaemonSetProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
addContainer	No description.
addHostAlias	No description.
addInitContainer	No description.
addVolume	No description.
attachContainer	No description.
toNetworkPolicyPeerConfig	Return the configuration of this peer.
toPodSelector	Convert the peer into a pod selector, if possible.
toPodSelectorConfig	Return the configuration of this selector.
toSubjectConfiguration	Return the subject configuration.
select	Configure selectors for this workload.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

addContainer

public addContainer(cont: ContainerProps): Container

cont^Required

• Type: ContainerProps

---

addHostAlias

public addHostAlias(hostAlias: HostAlias): void

hostAlias^Required

• Type: HostAlias

---

addInitContainer

public addInitContainer(cont: ContainerProps): Container

cont^Required

• Type: ContainerProps

---

addVolume

public addVolume(vol: Volume): void

vol^Required

• Type: Volume

---

attachContainer

public attachContainer(cont: Container): void

cont^Required

• Type: Container

---

toNetworkPolicyPeerConfig

public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig

Return the configuration of this peer.

INetworkPolicyPeer.toNetworkPolicyPeerConfig ()

toPodSelector

public toPodSelector(): IPodSelector

Convert the peer into a pod selector, if possible.

INetworkPolicyPeer.toPodSelector ()

toPodSelectorConfig

public toPodSelectorConfig(): PodSelectorConfig

Return the configuration of this selector.

IPodSelector.toPodSelectorConfig ()

toSubjectConfiguration

public toSubjectConfiguration(): SubjectConfiguration

Return the subject configuration.

ISubect.toSubjectConfiguration ()

select

public select(selectors: ...LabelSelector[]): void

Configure selectors for this workload.

selectors^Required

• Type: …LabelSelector[]

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { DaemonSet } from 'cdk8s-plus-34'

DaemonSet.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.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
automountServiceAccountToken	boolean	No description.
containers	Container[]	No description.
dns	PodDns	No description.
hostAliases	HostAlias[]	No description.
initContainers	Container[]	No description.
podMetadata	cdk8s.ApiObjectMetadataDefinition	The metadata of pods in this workload.
securityContext	PodSecurityContext	No description.
shareProcessNamespace	boolean	No description.
volumes	Volume[]	No description.
dockerRegistryAuth	ISecret	No description.
enableServiceLinks	boolean	No description.
hostNetwork	boolean	No description.
restartPolicy	RestartPolicy	No description.
serviceAccount	IServiceAccount	No description.
terminationGracePeriod	cdk8s.Duration	No description.
connections	PodConnections	No description.
matchExpressions	LabelSelectorRequirement[]	The expression matchers this workload will use in order to select pods.
matchLabels	{[ key: string ]: string}	The label matchers this workload will use in order to select pods.
scheduling	WorkloadScheduling	No description.
minReadySeconds	number	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

automountServiceAccountToken^Required

public readonly automountServiceAccountToken: boolean;

• Type: boolean

---

containers^Required

public readonly containers: Container[];

• Type: Container[]

---

dns^Required

public readonly dns: PodDns;

• Type: PodDns

---

hostAliases^Required

public readonly hostAliases: HostAlias[];

• Type: HostAlias[]

---

initContainers^Required

public readonly initContainers: Container[];

• Type: Container[]

---

podMetadata^Required

public readonly podMetadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

The metadata of pods in this workload.

---

securityContext^Required

public readonly securityContext: PodSecurityContext;

• Type: PodSecurityContext

---

shareProcessNamespace^Required

public readonly shareProcessNamespace: boolean;

• Type: boolean

---

volumes^Required

public readonly volumes: Volume[];

• Type: Volume[]

---

dockerRegistryAuth^Optional

public readonly dockerRegistryAuth: ISecret;

• Type: ISecret

---

enableServiceLinks^Optional

public readonly enableServiceLinks: boolean;

• Type: boolean

---

hostNetwork^Optional

public readonly hostNetwork: boolean;

• Type: boolean

---

restartPolicy^Optional

public readonly restartPolicy: RestartPolicy;

• Type: RestartPolicy

---

serviceAccount^Optional

public readonly serviceAccount: IServiceAccount;

• Type: IServiceAccount

---

terminationGracePeriod^Optional

public readonly terminationGracePeriod: Duration;

• Type: cdk8s.Duration

---

connections^Required

public readonly connections: PodConnections;

• Type: PodConnections

---

matchExpressions^Required

public readonly matchExpressions: LabelSelectorRequirement[];

• Type: LabelSelectorRequirement[]

The expression matchers this workload will use in order to select pods.

Returns a a copy. Use select() to add expression matchers.

---

matchLabels^Required

public readonly matchLabels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

The label matchers this workload will use in order to select pods.

Returns a a copy. Use select() to add label matchers.

---

scheduling^Required

public readonly scheduling: WorkloadScheduling;

• Type: WorkloadScheduling

---

minReadySeconds^Required

public readonly minReadySeconds: number;

• Type: number

---

Deployment

• Implements: IScalable

A Deployment provides declarative updates for Pods and ReplicaSets.

You describe a desired state in a Deployment, and the Deployment Controller changes the actual state to the desired state at a controlled rate. You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments.

Note: Do not manage ReplicaSets owned by a Deployment. Consider opening an issue in the main Kubernetes repository if your use case is not covered below.

Use Case

The following are typical use cases for Deployments:

• Create a Deployment to rollout a ReplicaSet. The ReplicaSet creates Pods in the background. Check the status of the rollout to see if it succeeds or not.
• Declare the new state of the Pods by updating the PodTemplateSpec of the Deployment. A new ReplicaSet is created and the Deployment manages moving the Pods from the old ReplicaSet to the new one at a controlled rate. Each new ReplicaSet updates the revision of the Deployment.
• Rollback to an earlier Deployment revision if the current state of the Deployment is not stable. Each rollback updates the revision of the Deployment.
• Scale up the Deployment to facilitate more load.
• Pause the Deployment to apply multiple fixes to its PodTemplateSpec and then resume it to start a new rollout.
• Use the status of the Deployment as an indicator that a rollout has stuck.
• Clean up older ReplicaSets that you don’t need anymore.

Initializers

import { Deployment } from 'cdk8s-plus-34'

new Deployment(scope: Construct, id: string, props?: DeploymentProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	DeploymentProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Optional

• Type: DeploymentProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
addContainer	No description.
addHostAlias	No description.
addInitContainer	No description.
addVolume	No description.
attachContainer	No description.
toNetworkPolicyPeerConfig	Return the configuration of this peer.
toPodSelector	Convert the peer into a pod selector, if possible.
toPodSelectorConfig	Return the configuration of this selector.
toSubjectConfiguration	Return the subject configuration.
select	Configure selectors for this workload.
exposeViaIngress	Expose a deployment via an ingress.
exposeViaService	Expose a deployment via a service.
markHasAutoscaler	Called on all IScalable targets when they are associated with an autoscaler.
toScalingTarget	Return the target spec properties of this Scalable.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

addContainer

public addContainer(cont: ContainerProps): Container

cont^Required

• Type: ContainerProps

---

addHostAlias

public addHostAlias(hostAlias: HostAlias): void

hostAlias^Required

• Type: HostAlias

---

addInitContainer

public addInitContainer(cont: ContainerProps): Container

cont^Required

• Type: ContainerProps

---

addVolume

public addVolume(vol: Volume): void

vol^Required

• Type: Volume

---

attachContainer

public attachContainer(cont: Container): void

cont^Required

• Type: Container

---

toNetworkPolicyPeerConfig

public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig

Return the configuration of this peer.

INetworkPolicyPeer.toNetworkPolicyPeerConfig ()

toPodSelector

public toPodSelector(): IPodSelector

Convert the peer into a pod selector, if possible.

INetworkPolicyPeer.toPodSelector ()

toPodSelectorConfig

public toPodSelectorConfig(): PodSelectorConfig

Return the configuration of this selector.

IPodSelector.toPodSelectorConfig ()

toSubjectConfiguration

public toSubjectConfiguration(): SubjectConfiguration

Return the subject configuration.

ISubect.toSubjectConfiguration ()

select

public select(selectors: ...LabelSelector[]): void

Configure selectors for this workload.

selectors^Required

• Type: …LabelSelector[]

---

exposeViaIngress

public exposeViaIngress(path: string, options?: ExposeDeploymentViaIngressOptions): Ingress

Expose a deployment via an ingress.

This will first expose the deployment with a service, and then expose the service via an ingress.

path^Required

• Type: string

The ingress path to register under.

---

options^Optional

• Type: ExposeDeploymentViaIngressOptions

Additional options.

---

exposeViaService

public exposeViaService(options?: DeploymentExposeViaServiceOptions): Service

Expose a deployment via a service.

This is equivalent to running kubectl expose deployment <deployment-name>.

options^Optional

• Type: DeploymentExposeViaServiceOptions

Options to determine details of the service and port exposed.

---

markHasAutoscaler

public markHasAutoscaler(): void

Called on all IScalable targets when they are associated with an autoscaler.

IScalable.markHasAutoscaler ()

toScalingTarget

public toScalingTarget(): ScalingTarget

Return the target spec properties of this Scalable.

IScalable.toScalingTarget ()

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Deployment } from 'cdk8s-plus-34'

Deployment.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.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
automountServiceAccountToken	boolean	No description.
containers	Container[]	No description.
dns	PodDns	No description.
hostAliases	HostAlias[]	No description.
initContainers	Container[]	No description.
podMetadata	cdk8s.ApiObjectMetadataDefinition	The metadata of pods in this workload.
securityContext	PodSecurityContext	No description.
shareProcessNamespace	boolean	No description.
volumes	Volume[]	No description.
dockerRegistryAuth	ISecret	No description.
enableServiceLinks	boolean	No description.
hostNetwork	boolean	No description.
restartPolicy	RestartPolicy	No description.
serviceAccount	IServiceAccount	No description.
terminationGracePeriod	cdk8s.Duration	No description.
connections	PodConnections	No description.
matchExpressions	LabelSelectorRequirement[]	The expression matchers this workload will use in order to select pods.
matchLabels	{[ key: string ]: string}	The label matchers this workload will use in order to select pods.
scheduling	WorkloadScheduling	No description.
minReady	cdk8s.Duration	Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available.
progressDeadline	cdk8s.Duration	The maximum duration for a deployment to make progress before it is considered to be failed.
revisionHistoryLimit	number	Number of desired replicasets history.
strategy	DeploymentStrategy	No description.
replicas	number	Number of desired pods.
hasAutoscaler	boolean	If this is a target of an autoscaler.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

automountServiceAccountToken^Required

public readonly automountServiceAccountToken: boolean;

• Type: boolean

---

containers^Required

public readonly containers: Container[];

• Type: Container[]

---

dns^Required

public readonly dns: PodDns;

• Type: PodDns

---

hostAliases^Required

public readonly hostAliases: HostAlias[];

• Type: HostAlias[]

---

initContainers^Required

public readonly initContainers: Container[];

• Type: Container[]

---

podMetadata^Required

public readonly podMetadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

The metadata of pods in this workload.

---

securityContext^Required

public readonly securityContext: PodSecurityContext;

• Type: PodSecurityContext

---

shareProcessNamespace^Required

public readonly shareProcessNamespace: boolean;

• Type: boolean

---

volumes^Required

public readonly volumes: Volume[];

• Type: Volume[]

---

dockerRegistryAuth^Optional

public readonly dockerRegistryAuth: ISecret;

• Type: ISecret

---

enableServiceLinks^Optional

public readonly enableServiceLinks: boolean;

• Type: boolean

---

hostNetwork^Optional

public readonly hostNetwork: boolean;

• Type: boolean

---

restartPolicy^Optional

public readonly restartPolicy: RestartPolicy;

• Type: RestartPolicy

---

serviceAccount^Optional

public readonly serviceAccount: IServiceAccount;

• Type: IServiceAccount

---

terminationGracePeriod^Optional

public readonly terminationGracePeriod: Duration;

• Type: cdk8s.Duration

---

connections^Required

public readonly connections: PodConnections;

• Type: PodConnections

---

matchExpressions^Required

public readonly matchExpressions: LabelSelectorRequirement[];

• Type: LabelSelectorRequirement[]

The expression matchers this workload will use in order to select pods.

Returns a a copy. Use select() to add expression matchers.

---

matchLabels^Required

public readonly matchLabels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

The label matchers this workload will use in order to select pods.

Returns a a copy. Use select() to add label matchers.

---

scheduling^Required

public readonly scheduling: WorkloadScheduling;

• Type: WorkloadScheduling

---

minReady^Required

public readonly minReady: Duration;

• Type: cdk8s.Duration

Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available.

---

progressDeadline^Required

public readonly progressDeadline: Duration;

• Type: cdk8s.Duration

The maximum duration for a deployment to make progress before it is considered to be failed.

---

revisionHistoryLimit^Required

public readonly revisionHistoryLimit: number;

• Type: number
• Default: 10

Number of desired replicasets history.

---

strategy^Required

public readonly strategy: DeploymentStrategy;

• Type: DeploymentStrategy

---

replicas^Optional

public readonly replicas: number;

• Type: number

Number of desired pods.

---

hasAutoscaler^Required

public readonly hasAutoscaler: boolean;

• Type: boolean

If this is a target of an autoscaler.

---

DockerConfigSecret

Create a secret for storing credentials for accessing a container image registry.

https://kubernetes.io/docs/concepts/configuration/secret/#docker-config-secrets

Initializers

import { DockerConfigSecret } from 'cdk8s-plus-34'

new DockerConfigSecret(scope: Construct, id: string, props: DockerConfigSecretProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	DockerConfigSecretProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: DockerConfigSecretProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
addStringData	Adds a string data field to the secret.
envValue	Returns EnvValue object from a secret’s key.
getStringData	Gets a string data by key or undefined.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

addStringData

public addStringData(key: string, value: string): void

Adds a string data field to the secret.

key^Required

• Type: string

Key.

---

value^Required

• Type: string

Value.

---

envValue

public envValue(key: string, options?: EnvValueFromSecretOptions): EnvValue

Returns EnvValue object from a secret’s key.

key^Required

• Type: string

---

options^Optional

• Type: EnvValueFromSecretOptions

---

getStringData

public getStringData(key: string): string

Gets a string data by key or undefined.

key^Required

• Type: string

Key.

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
fromSecretName	Imports a secret from the cluster as a reference.

---

isConstruct

import { DockerConfigSecret } from 'cdk8s-plus-34'

DockerConfigSecret.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.

---

fromSecretName

import { DockerConfigSecret } from 'cdk8s-plus-34'

DockerConfigSecret.fromSecretName(scope: Construct, id: string, name: string)

Imports a secret from the cluster as a reference.

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

name^Required

• Type: string

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
immutable	boolean	Whether or not the secret is immutable.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

immutable^Required

public readonly immutable: boolean;

• Type: boolean

Whether or not the secret is immutable.

---

GCEPersistentDiskPersistentVolume

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.

https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Initializers

import { GCEPersistentDiskPersistentVolume } from 'cdk8s-plus-34'

new GCEPersistentDiskPersistentVolume(scope: Construct, id: string, props: GCEPersistentDiskPersistentVolumeProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	GCEPersistentDiskPersistentVolumeProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: GCEPersistentDiskPersistentVolumeProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
asVolume	Convert the piece of storage into a concrete volume.
bind	Bind a volume to a specific claim.
reserve	Reserve a PersistentVolume by creating a PersistentVolumeClaim that is wired to claim this volume.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

asVolume

public asVolume(): Volume

Convert the piece of storage into a concrete volume.

bind

public bind(claim: IPersistentVolumeClaim): void

Bind a volume to a specific claim.

Note that you must also bind the claim to the volume.

https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding

claim^Required

• Type: IPersistentVolumeClaim

The PVC to bind to.

---

reserve

public reserve(): PersistentVolumeClaim

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.

https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reserving-a-persistentvolume

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
fromPersistentVolumeName	Imports a pv from the cluster as a reference.

---

isConstruct

import { GCEPersistentDiskPersistentVolume } from 'cdk8s-plus-34'

GCEPersistentDiskPersistentVolume.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.

---

fromPersistentVolumeName

import { GCEPersistentDiskPersistentVolume } from 'cdk8s-plus-34'

GCEPersistentDiskPersistentVolume.fromPersistentVolumeName(scope: Construct, id: string, volumeName: string)

Imports a pv from the cluster as a reference.

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

volumeName^Required

• Type: string

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
mode	PersistentVolumeMode	Volume mode of this volume.
reclaimPolicy	PersistentVolumeReclaimPolicy	Reclaim policy of this volume.
accessModes	PersistentVolumeAccessMode[]	Access modes requirement of this claim.
claim	IPersistentVolumeClaim	PVC this volume is bound to.
mountOptions	string[]	Mount options of this volume.
storage	cdk8s.Size	Storage size of this volume.
storageClassName	string	Storage class this volume belongs to.
fsType	string	File system type of this volume.
pdName	string	PD resource in GCE of this volume.
readOnly	boolean	Whether or not it is mounted as a read-only volume.
partition	number	Partition of this volume.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

mode^Required

public readonly mode: PersistentVolumeMode;

• Type: PersistentVolumeMode

Volume mode of this volume.

---

reclaimPolicy^Required

public readonly reclaimPolicy: PersistentVolumeReclaimPolicy;

• Type: PersistentVolumeReclaimPolicy

Reclaim policy of this volume.

---

accessModes^Optional

public readonly accessModes: PersistentVolumeAccessMode[];

• Type: PersistentVolumeAccessMode[]

Access modes requirement of this claim.

---

claim^Optional

public readonly claim: IPersistentVolumeClaim;

• Type: IPersistentVolumeClaim

PVC this volume is bound to.

Undefined means this volume is not yet claimed by any PVC.

---

mountOptions^Optional

public readonly mountOptions: string[];

• Type: string[]

Mount options of this volume.

---

storage^Optional

public readonly storage: Size;

• Type: cdk8s.Size

Storage size of this volume.

---

storageClassName^Optional

public readonly storageClassName: string;

• Type: string

Storage class this volume belongs to.

---

fsType^Required

public readonly fsType: string;

• Type: string

File system type of this volume.

---

pdName^Required

public readonly pdName: string;

• Type: string

PD resource in GCE of this volume.

---

readOnly^Required

public readonly readOnly: boolean;

• Type: boolean

Whether or not it is mounted as a read-only volume.

---

partition^Optional

public readonly partition: number;

• Type: number

Partition of this volume.

---

Group

• Implements: ISubject

Represents a group.

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
toSubjectConfiguration	Return the subject configuration.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

toSubjectConfiguration

public toSubjectConfiguration(): SubjectConfiguration

Return the subject configuration.

ISubect.toSubjectConfiguration ()

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
fromName	Reference a group by name.

---

isConstruct

import { Group } from 'cdk8s-plus-34'

Group.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.

---

fromName

import { Group } from 'cdk8s-plus-34'

Group.fromName(scope: Construct, id: string, name: string)

Reference a group by name.

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

name^Required

• Type: string

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
kind	string	No description.
name	string	No description.
apiGroup	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

kind^Required

public readonly kind: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

apiGroup^Optional

public readonly apiGroup: string;

• Type: string

---

HorizontalPodAutoscaler

A HorizontalPodAutoscaler scales a workload up or down in response to a metric change.

This allows your services to scale up when demand is high and scale down when they are no longer needed.

Typical use cases for HorizontalPodAutoscaler:

• When Memory usage is above 70%, scale up the number of replicas to meet the demand.
• When CPU usage is below 30%, scale down the number of replicas to save resources.
• When a service is experiencing a spike in traffic, scale up the number of replicas to meet the demand. Then, when the traffic subsides, scale down the number of replicas to save resources.

The autoscaler uses the following algorithm to determine the number of replicas to scale:

desiredReplicas = ceil[currentReplicas * ( currentMetricValue / desiredMetricValue )]

HorizontalPodAutoscaler’s can be used to with any Scalable workload: * Deployment * StatefulSet

Targets that already have a replica count defined:

Remove any replica counts from the target resource before associating with a HorizontalPodAutoscaler. If this isn’t done, then any time a change to that object is applied, Kubernetes will scale the current number of Pods to the value of the target.replicas key. This may not be desired and could lead to unexpected behavior.

https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#implicit-maintenance-mode-deactivation

Example

const backend = new kplus.Deployment(this, 'Backend', ...);

const hpa = new kplus.HorizontalPodAutoscaler(chart, 'Hpa', {
 target: backend,
 maxReplicas: 10,
 scaleUp: {
   policies: [
     {
       replicas: kplus.Replicas.absolute(3),
       duration: Duration.minutes(5),
     },
   ],
 },
});

Initializers

import { HorizontalPodAutoscaler } from 'cdk8s-plus-34'

new HorizontalPodAutoscaler(scope: Construct, id: string, props: HorizontalPodAutoscalerProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	HorizontalPodAutoscalerProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: HorizontalPodAutoscalerProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { HorizontalPodAutoscaler } from 'cdk8s-plus-34'

HorizontalPodAutoscaler.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.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
maxReplicas	number	The maximum number of replicas that can be scaled up to.
minReplicas	number	The minimum number of replicas that can be scaled down to.
scaleDown	ScalingRules	The scaling behavior when scaling down.
scaleUp	ScalingRules	The scaling behavior when scaling up.
target	IScalable	The workload to scale up or down.
metrics	Metric[]	The metric conditions that trigger a scale up or scale down.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

maxReplicas^Required

public readonly maxReplicas: number;

• Type: number

The maximum number of replicas that can be scaled up to.

---

minReplicas^Required

public readonly minReplicas: number;

• Type: number

The minimum number of replicas that can be scaled down to.

---

scaleDown^Required

public readonly scaleDown: ScalingRules;

• Type: ScalingRules

The scaling behavior when scaling down.

---

scaleUp^Required

public readonly scaleUp: ScalingRules;

• Type: ScalingRules

The scaling behavior when scaling up.

---

target^Required

public readonly target: IScalable;

• Type: IScalable

The workload to scale up or down.

---

metrics^Optional

public readonly metrics: Metric[];

• Type: Metric[]

The metric conditions that trigger a scale up or scale down.

---

Ingress

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend.

An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

Initializers

import { Ingress } from 'cdk8s-plus-34'

new Ingress(scope: Construct, id: string, props?: IngressProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	IngressProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Optional

• Type: IngressProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
addDefaultBackend	Defines the default backend for this ingress.
addHostDefaultBackend	Specify a default backend for a specific host name.
addHostRule	Adds an ingress rule applied to requests to a specific host and a specific HTTP path (the Host header matches this value).
addRule	Adds an ingress rule applied to requests sent to a specific HTTP path.
addRules	Adds rules to this ingress.
addTls	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

addDefaultBackend

public addDefaultBackend(backend: IngressBackend): void

Defines the default backend for this ingress.

A default backend capable of servicing requests that don’t match any rule.

backend^Required

• Type: IngressBackend

The backend to use for requests that do not match any rule.

---

addHostDefaultBackend

public addHostDefaultBackend(host: string, backend: IngressBackend): void

Specify a default backend for a specific host name.

This backend will be used as a catch-all for requests targeted to this host name (the Host header matches this value).

host^Required

• Type: string

The host name to match.

---

backend^Required

• Type: IngressBackend

The backend to route to.

---

addHostRule

public addHostRule(host: string, path: string, backend: IngressBackend, pathType?: HttpIngressPathType): void

Adds an ingress rule applied to requests to a specific host and a specific HTTP path (the Host header matches this value).

host^Required

• Type: string

The host name.

---

path^Required

• Type: string

The HTTP path.

---

backend^Required

• Type: IngressBackend

The backend to route requests to.

---

pathType^Optional

• Type: HttpIngressPathType

How the path is matched against request paths.

---

addRule

public addRule(path: string, backend: IngressBackend, pathType?: HttpIngressPathType): void

Adds an ingress rule applied to requests sent to a specific HTTP path.

path^Required

• Type: string

The HTTP path.

---

backend^Required

• Type: IngressBackend

The backend to route requests to.

---

pathType^Optional

• Type: HttpIngressPathType

How the path is matched against request paths.

---

addRules

public addRules(rules: ...IngressRule[]): void

Adds rules to this ingress.

rules^Required

• Type: …IngressRule[]

The rules to add.

---

addTls

public addTls(tls: IngressTls[]): void

tls^Required

• Type: IngressTls[]

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Ingress } from 'cdk8s-plus-34'

Ingress.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.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

Job

A Job creates one or more Pods and ensures that a specified number of them successfully terminate.

As pods successfully complete, the Job tracks the successful completions. When a specified number of successful completions is reached, the task (ie, Job) is complete. Deleting a Job will clean up the Pods it created. A simple case is to create one Job object in order to reliably run one Pod to completion. The Job object will start a new Pod if the first Pod fails or is deleted (for example due to a node hardware failure or a node reboot). You can also use a Job to run multiple Pods in parallel.

Initializers

import { Job } from 'cdk8s-plus-34'

new Job(scope: Construct, id: string, props?: JobProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	JobProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Optional

• Type: JobProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
asApiResource	Return the IApiResource this object represents.
asNonApiResource	Return the non resource url this object represents.
addContainer	No description.
addHostAlias	No description.
addInitContainer	No description.
addVolume	No description.
attachContainer	No description.
toNetworkPolicyPeerConfig	Return the configuration of this peer.
toPodSelector	Convert the peer into a pod selector, if possible.
toPodSelectorConfig	Return the configuration of this selector.
toSubjectConfiguration	Return the subject configuration.
select	Configure selectors for this workload.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

asApiResource

public asApiResource(): IApiResource

Return the IApiResource this object represents.

asNonApiResource

public asNonApiResource(): string

Return the non resource url this object represents.

addContainer

public addContainer(cont: ContainerProps): Container

cont^Required

• Type: ContainerProps

---

addHostAlias

public addHostAlias(hostAlias: HostAlias): void

hostAlias^Required

• Type: HostAlias

---

addInitContainer

public addInitContainer(cont: ContainerProps): Container

cont^Required

• Type: ContainerProps

---

addVolume

public addVolume(vol: Volume): void

vol^Required

• Type: Volume

---

attachContainer

public attachContainer(cont: Container): void

cont^Required

• Type: Container

---

toNetworkPolicyPeerConfig

public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig

Return the configuration of this peer.

INetworkPolicyPeer.toNetworkPolicyPeerConfig ()

toPodSelector

public toPodSelector(): IPodSelector

Convert the peer into a pod selector, if possible.

INetworkPolicyPeer.toPodSelector ()

toPodSelectorConfig

public toPodSelectorConfig(): PodSelectorConfig

Return the configuration of this selector.

IPodSelector.toPodSelectorConfig ()

toSubjectConfiguration

public toSubjectConfiguration(): SubjectConfiguration

Return the subject configuration.

ISubect.toSubjectConfiguration ()

select

public select(selectors: ...LabelSelector[]): void

Configure selectors for this workload.

selectors^Required

• Type: …LabelSelector[]

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Job } from 'cdk8s-plus-34'

Job.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.
apiGroup	string	The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersion	string	The object’s API version (e.g. “authorization.k8s.io/v1”).
kind	string	The object kind (e.g. “Deployment”).
metadata	cdk8s.ApiObjectMetadataDefinition	No description.
name	string	The name of this API object.
permissions	ResourcePermissions	No description.
resourceType	string	The name of a resource type as it appears in the relevant API endpoint.
resourceName	string	The unique, namespace-global, name of an object inside the Kubernetes cluster.
automountServiceAccountToken	boolean	No description.
containers	Container[]	No description.
dns	PodDns	No description.
hostAliases	HostAlias[]	No description.
initContainers	Container[]	No description.
podMetadata	cdk8s.ApiObjectMetadataDefinition	The metadata of pods in this workload.
securityContext	PodSecurityContext	No description.
shareProcessNamespace	boolean	No description.
volumes	Volume[]	No description.
dockerRegistryAuth	ISecret	No description.
enableServiceLinks	boolean	No description.
hostNetwork	boolean	No description.
restartPolicy	RestartPolicy	No description.
serviceAccount	IServiceAccount	No description.
terminationGracePeriod	cdk8s.Duration	No description.
connections	PodConnections	No description.
matchExpressions	LabelSelectorRequirement[]	The expression matchers this workload will use in order to select pods.
matchLabels	{[ key: string ]: string}	The label matchers this workload will use in order to select pods.
scheduling	WorkloadScheduling	No description.
activeDeadline	cdk8s.Duration	Duration before job is terminated.
backoffLimit	number	Number of retries before marking failed.
ttlAfterFinished	cdk8s.Duration	TTL before the job is deleted after it is finished.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).

---

kind^Required

public readonly kind: string;

• Type: string

The object kind (e.g. “Deployment”).

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

---

name^Required

public readonly name: string;

• Type: string

The name of this API object.

---

permissions^Required

public readonly permissions: ResourcePermissions;

• Type: ResourcePermissions

---

resourceType^Required

public readonly resourceType: string;

• Type: string

The name of a resource type as it appears in the relevant API endpoint.

---

resourceName^Optional

public readonly resourceName: string;

• Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.

---

automountServiceAccountToken^Required

public readonly automountServiceAccountToken: boolean;

• Type: boolean

---

containers^Required

public readonly containers: Container[];

• Type: Container[]

---

dns^Required

public readonly dns: PodDns;

• Type: PodDns

---

hostAliases^Required

public readonly hostAliases: HostAlias[];

• Type: HostAlias[]

---

initContainers^Required

public readonly initContainers: Container[];

• Type: Container[]

---

podMetadata^Required

public readonly podMetadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

The metadata of pods in this workload.

---

securityContext^Required

public readonly securityContext: PodSecurityContext;

• Type: PodSecurityContext

---

shareProcessNamespace^Required

public readonly shareProcessNamespace: boolean;

• Type: boolean

---

volumes^Required

public readonly volumes: Volume[];

• Type: Volume[]

---

dockerRegistryAuth^Optional

public readonly dockerRegistryAuth: ISecret;

• Type: ISecret

---

enableServiceLinks^Optional

public readonly enableServiceLinks: boolean;

• Type: boolean

---

hostNetwork^Optional

public readonly hostNetwork: boolean;

• Type: boolean

---

restartPolicy^Optional

public readonly restartPolicy: RestartPolicy;

• Type: RestartPolicy

---

serviceAccount^Optional

public readonly serviceAccount: IServiceAccount;

• Type: IServiceAccount

---

terminationGracePeriod^Optional

public readonly terminationGracePeriod: Duration;

• Type: cdk8s.Duration

---

connections^Required

public readonly connections: PodConnections;

• Type: PodConnections

---

matchExpressions^Required

public readonly matchExpressions: LabelSelectorRequirement[];

• Type: LabelSelectorRequirement[]

The expression matchers this workload will use in order to select pods.

Returns a a copy. Use select() to add expression matchers.

---

matchLabels^Required

public readonly matchLabels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

The label matchers this workload will use in order to select pods.

Returns a a copy. Use select() to add label matchers.

---

scheduling^Required

public readonly scheduling: WorkloadScheduling;

• Type: WorkloadScheduling

---

activeDeadline^Optional

public readonly activeDeadline: Duration;

• Type: cdk8s.Duration

Duration before job is terminated.

If undefined, there is no deadline.

---

backoffLimit^Optional

public readonly backoffLimit: number;

• Type: number

Number of retries before marking failed.

---

ttlAfterFinished^Optional

public readonly ttlAfterFinished: Duration;

• Type: cdk8s.Duration

TTL before the job is deleted after it is finished.

---

KubeApiService

APIService represents a server for a particular GroupVersion.

Name must be “version.group”.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeApiService(scope: Construct, id: string, props?: KubeApiServiceProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeApiServiceProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeApiServiceProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeApiService.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeApiService.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeApiService.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeApiService.manifest(props?: KubeApiServiceProps)

Renders a Kubernetes manifest for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeApiServiceProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService”.

---

KubeApiServiceList

APIServiceList is a list of APIService objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeApiServiceList(scope: Construct, id: string, props: KubeApiServiceListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeApiServiceListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeApiServiceListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeApiServiceList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeApiServiceList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeApiServiceList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeApiServiceList.manifest(props: KubeApiServiceListProps)

Renders a Kubernetes manifest for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeApiServiceListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList”.

---

KubeBinding

Binding ties one object to another;

for example, a pod is bound to a node by a scheduler.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeBinding(scope: Construct, id: string, props: KubeBindingProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeBindingProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeBindingProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.Binding”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeBinding.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeBinding.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeBinding.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeBinding.manifest(props: KubeBindingProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.Binding”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeBindingProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.Binding”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.Binding”.

---

KubeCertificateSigningRequest

CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued.

Kubelets use this API to obtain: 1. client certificates to authenticate to kube-apiserver (with the “kubernetes.io/kube-apiserver-client-kubelet” signerName). 2. serving certificates for TLS endpoints kube-apiserver can connect to securely (with the “kubernetes.io/kubelet-serving” signerName).

This API can be used to request client certificates to authenticate to kube-apiserver (with the “kubernetes.io/kube-apiserver-client” signerName), or to obtain certificates from custom non-Kubernetes signers.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeCertificateSigningRequest(scope: Construct, id: string, props: KubeCertificateSigningRequestProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeCertificateSigningRequestProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeCertificateSigningRequestProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.certificates.v1.CertificateSigningRequest”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCertificateSigningRequest.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCertificateSigningRequest.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCertificateSigningRequest.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCertificateSigningRequest.manifest(props: KubeCertificateSigningRequestProps)

Renders a Kubernetes manifest for “io.k8s.api.certificates.v1.CertificateSigningRequest”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeCertificateSigningRequestProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.certificates.v1.CertificateSigningRequest”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.certificates.v1.CertificateSigningRequest”.

---

KubeCertificateSigningRequestList

CertificateSigningRequestList is a collection of CertificateSigningRequest objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeCertificateSigningRequestList(scope: Construct, id: string, props: KubeCertificateSigningRequestListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeCertificateSigningRequestListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeCertificateSigningRequestListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.certificates.v1.CertificateSigningRequestList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCertificateSigningRequestList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCertificateSigningRequestList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCertificateSigningRequestList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCertificateSigningRequestList.manifest(props: KubeCertificateSigningRequestListProps)

Renders a Kubernetes manifest for “io.k8s.api.certificates.v1.CertificateSigningRequestList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeCertificateSigningRequestListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.certificates.v1.CertificateSigningRequestList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.certificates.v1.CertificateSigningRequestList”.

---

KubeClusterRole

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeClusterRole(scope: Construct, id: string, props?: KubeClusterRoleProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeClusterRoleProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeClusterRoleProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRole”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRole.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRole.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRole.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRole.manifest(props?: KubeClusterRoleProps)

Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRole”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeClusterRoleProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRole”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRole”.

---

KubeClusterRoleBinding

ClusterRoleBinding references a ClusterRole, but not contain it.

It can reference a ClusterRole in the global namespace, and adds who information via Subject.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeClusterRoleBinding(scope: Construct, id: string, props: KubeClusterRoleBindingProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeClusterRoleBindingProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterRoleBindingProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRoleBinding”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRoleBinding.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRoleBinding.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRoleBinding.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRoleBinding.manifest(props: KubeClusterRoleBindingProps)

Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRoleBinding”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterRoleBindingProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRoleBinding”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRoleBinding”.

---

KubeClusterRoleBindingList

ClusterRoleBindingList is a collection of ClusterRoleBindings.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeClusterRoleBindingList(scope: Construct, id: string, props: KubeClusterRoleBindingListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeClusterRoleBindingListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterRoleBindingListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRoleBindingList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRoleBindingList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRoleBindingList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRoleBindingList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRoleBindingList.manifest(props: KubeClusterRoleBindingListProps)

Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRoleBindingList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterRoleBindingListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRoleBindingList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRoleBindingList”.

---

KubeClusterRoleList

ClusterRoleList is a collection of ClusterRoles.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeClusterRoleList(scope: Construct, id: string, props: KubeClusterRoleListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeClusterRoleListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterRoleListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRoleList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRoleList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRoleList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRoleList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterRoleList.manifest(props: KubeClusterRoleListProps)

Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRoleList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterRoleListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRoleList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRoleList”.

---

KubeClusterTrustBundleListV1Alpha1

ClusterTrustBundleList is a collection of ClusterTrustBundle objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeClusterTrustBundleListV1Alpha1(scope: Construct, id: string, props: KubeClusterTrustBundleListV1Alpha1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeClusterTrustBundleListV1Alpha1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterTrustBundleListV1Alpha1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundleList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleListV1Alpha1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleListV1Alpha1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleListV1Alpha1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleListV1Alpha1.manifest(props: KubeClusterTrustBundleListV1Alpha1Props)

Renders a Kubernetes manifest for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundleList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterTrustBundleListV1Alpha1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundleList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundleList”.

---

KubeClusterTrustBundleListV1Beta1

ClusterTrustBundleList is a collection of ClusterTrustBundle objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeClusterTrustBundleListV1Beta1(scope: Construct, id: string, props: KubeClusterTrustBundleListV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeClusterTrustBundleListV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterTrustBundleListV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.certificates.v1beta1.ClusterTrustBundleList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleListV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleListV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleListV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleListV1Beta1.manifest(props: KubeClusterTrustBundleListV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.certificates.v1beta1.ClusterTrustBundleList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterTrustBundleListV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.certificates.v1beta1.ClusterTrustBundleList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.certificates.v1beta1.ClusterTrustBundleList”.

---

KubeClusterTrustBundleV1Alpha1

ClusterTrustBundle is a cluster-scoped container for X.509 trust anchors (root certificates).

ClusterTrustBundle objects are considered to be readable by any authenticated user in the cluster, because they can be mounted by pods using the clusterTrustBundle projection. All service accounts have read access to ClusterTrustBundles by default. Users who only have namespace-level access to a cluster can read ClusterTrustBundles by impersonating a serviceaccount that they have access to.

It can be optionally associated with a particular assigner, in which case it contains one valid set of trust anchors for that signer. Signers may have multiple associated ClusterTrustBundles; each is an independent set of trust anchors for that signer. Admission control is used to enforce that only users with permissions on the signer can create or modify the corresponding bundle.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeClusterTrustBundleV1Alpha1(scope: Construct, id: string, props: KubeClusterTrustBundleV1Alpha1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeClusterTrustBundleV1Alpha1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterTrustBundleV1Alpha1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundle”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleV1Alpha1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleV1Alpha1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleV1Alpha1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleV1Alpha1.manifest(props: KubeClusterTrustBundleV1Alpha1Props)

Renders a Kubernetes manifest for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundle”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterTrustBundleV1Alpha1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundle”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundle”.

---

KubeClusterTrustBundleV1Beta1

ClusterTrustBundle is a cluster-scoped container for X.509 trust anchors (root certificates).

ClusterTrustBundle objects are considered to be readable by any authenticated user in the cluster, because they can be mounted by pods using the clusterTrustBundle projection. All service accounts have read access to ClusterTrustBundles by default. Users who only have namespace-level access to a cluster can read ClusterTrustBundles by impersonating a serviceaccount that they have access to.

It can be optionally associated with a particular assigner, in which case it contains one valid set of trust anchors for that signer. Signers may have multiple associated ClusterTrustBundles; each is an independent set of trust anchors for that signer. Admission control is used to enforce that only users with permissions on the signer can create or modify the corresponding bundle.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeClusterTrustBundleV1Beta1(scope: Construct, id: string, props: KubeClusterTrustBundleV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeClusterTrustBundleV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterTrustBundleV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.certificates.v1beta1.ClusterTrustBundle”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeClusterTrustBundleV1Beta1.manifest(props: KubeClusterTrustBundleV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.certificates.v1beta1.ClusterTrustBundle”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeClusterTrustBundleV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.certificates.v1beta1.ClusterTrustBundle”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.certificates.v1beta1.ClusterTrustBundle”.

---

KubeComponentStatus

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

Deprecated: This API is deprecated in v1.19+

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeComponentStatus(scope: Construct, id: string, props?: KubeComponentStatusProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeComponentStatusProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeComponentStatusProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.ComponentStatus”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeComponentStatus.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeComponentStatus.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeComponentStatus.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeComponentStatus.manifest(props?: KubeComponentStatusProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.ComponentStatus”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeComponentStatusProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.ComponentStatus”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.ComponentStatus”.

---

KubeComponentStatusList

Status of all the conditions for the component as a list of ComponentStatus objects.

Deprecated: This API is deprecated in v1.19+

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeComponentStatusList(scope: Construct, id: string, props: KubeComponentStatusListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeComponentStatusListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeComponentStatusListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.ComponentStatusList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeComponentStatusList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeComponentStatusList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeComponentStatusList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeComponentStatusList.manifest(props: KubeComponentStatusListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.ComponentStatusList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeComponentStatusListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.ComponentStatusList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.ComponentStatusList”.

---

KubeConfigMap

ConfigMap holds configuration data for pods to consume.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeConfigMap(scope: Construct, id: string, props?: KubeConfigMapProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeConfigMapProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeConfigMapProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.ConfigMap”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeConfigMap.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeConfigMap.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeConfigMap.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeConfigMap.manifest(props?: KubeConfigMapProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.ConfigMap”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeConfigMapProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.ConfigMap”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.ConfigMap”.

---

KubeConfigMapList

ConfigMapList is a resource containing a list of ConfigMap objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeConfigMapList(scope: Construct, id: string, props: KubeConfigMapListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeConfigMapListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeConfigMapListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.ConfigMapList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeConfigMapList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeConfigMapList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeConfigMapList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeConfigMapList.manifest(props: KubeConfigMapListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.ConfigMapList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeConfigMapListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.ConfigMapList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.ConfigMapList”.

---

KubeControllerRevision

ControllerRevision implements an immutable snapshot of state data.

Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeControllerRevision(scope: Construct, id: string, props: KubeControllerRevisionProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeControllerRevisionProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeControllerRevisionProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ControllerRevision”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeControllerRevision.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeControllerRevision.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeControllerRevision.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeControllerRevision.manifest(props: KubeControllerRevisionProps)

Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ControllerRevision”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeControllerRevisionProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.apps.v1.ControllerRevision”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.apps.v1.ControllerRevision”.

---

KubeControllerRevisionList

ControllerRevisionList is a resource containing a list of ControllerRevision objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeControllerRevisionList(scope: Construct, id: string, props: KubeControllerRevisionListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeControllerRevisionListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeControllerRevisionListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ControllerRevisionList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeControllerRevisionList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeControllerRevisionList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeControllerRevisionList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeControllerRevisionList.manifest(props: KubeControllerRevisionListProps)

Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ControllerRevisionList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeControllerRevisionListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.apps.v1.ControllerRevisionList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.apps.v1.ControllerRevisionList”.

---

KubeCronJob

CronJob represents the configuration of a single cron job.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeCronJob(scope: Construct, id: string, props?: KubeCronJobProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeCronJobProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeCronJobProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.batch.v1.CronJob”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCronJob.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCronJob.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCronJob.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCronJob.manifest(props?: KubeCronJobProps)

Renders a Kubernetes manifest for “io.k8s.api.batch.v1.CronJob”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeCronJobProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.batch.v1.CronJob”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.batch.v1.CronJob”.

---

KubeCronJobList

CronJobList is a collection of cron jobs.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeCronJobList(scope: Construct, id: string, props: KubeCronJobListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeCronJobListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeCronJobListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.batch.v1.CronJobList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCronJobList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCronJobList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCronJobList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCronJobList.manifest(props: KubeCronJobListProps)

Renders a Kubernetes manifest for “io.k8s.api.batch.v1.CronJobList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeCronJobListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.batch.v1.CronJobList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.batch.v1.CronJobList”.

---

KubeCsiDriver

CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster.

Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeCsiDriver(scope: Construct, id: string, props: KubeCsiDriverProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeCsiDriverProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeCsiDriverProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIDriver”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiDriver.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiDriver.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiDriver.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiDriver.manifest(props: KubeCsiDriverProps)

Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIDriver”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeCsiDriverProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIDriver”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIDriver”.

---

KubeCsiDriverList

CSIDriverList is a collection of CSIDriver objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeCsiDriverList(scope: Construct, id: string, props: KubeCsiDriverListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeCsiDriverListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeCsiDriverListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIDriverList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiDriverList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiDriverList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiDriverList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiDriverList.manifest(props: KubeCsiDriverListProps)

Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIDriverList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeCsiDriverListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIDriverList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIDriverList”.

---

KubeCsiNode

CSINode holds information about all CSI drivers installed on a node.

CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn’t create this object. CSINode has an OwnerReference that points to the corresponding node object.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeCsiNode(scope: Construct, id: string, props: KubeCsiNodeProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeCsiNodeProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeCsiNodeProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSINode”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiNode.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiNode.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiNode.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiNode.manifest(props: KubeCsiNodeProps)

Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSINode”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeCsiNodeProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSINode”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSINode”.

---

KubeCsiNodeList

CSINodeList is a collection of CSINode objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeCsiNodeList(scope: Construct, id: string, props: KubeCsiNodeListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeCsiNodeListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeCsiNodeListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSINodeList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiNodeList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiNodeList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiNodeList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiNodeList.manifest(props: KubeCsiNodeListProps)

Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSINodeList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeCsiNodeListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSINodeList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSINodeList”.

---

KubeCsiStorageCapacity

CSIStorageCapacity stores the result of one CSI GetCapacity call.

For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes.

For example this can express things like: - StorageClass “standard” has “1234 GiB” available in “topology.kubernetes.io/zone=us-east1” - StorageClass “localssd” has “10 GiB” available in “kubernetes.io/hostname=knode-abc123”

The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero

The producer of these objects can decide which approach is more suitable.

They are consumed by the kube-scheduler when a CSI driver opts into capacity-aware scheduling with CSIDriverSpec.StorageCapacity. The scheduler compares the MaximumVolumeSize against the requested size of pending volumes to filter out unsuitable nodes. If MaximumVolumeSize is unset, it falls back to a comparison against the less precise Capacity. If that is also unset, the scheduler assumes that capacity is insufficient and tries some other node.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeCsiStorageCapacity(scope: Construct, id: string, props: KubeCsiStorageCapacityProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeCsiStorageCapacityProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeCsiStorageCapacityProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIStorageCapacity”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiStorageCapacity.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiStorageCapacity.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiStorageCapacity.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiStorageCapacity.manifest(props: KubeCsiStorageCapacityProps)

Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIStorageCapacity”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeCsiStorageCapacityProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIStorageCapacity”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIStorageCapacity”.

---

KubeCsiStorageCapacityList

CSIStorageCapacityList is a collection of CSIStorageCapacity objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeCsiStorageCapacityList(scope: Construct, id: string, props: KubeCsiStorageCapacityListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeCsiStorageCapacityListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeCsiStorageCapacityListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIStorageCapacityList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiStorageCapacityList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiStorageCapacityList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiStorageCapacityList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCsiStorageCapacityList.manifest(props: KubeCsiStorageCapacityListProps)

Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIStorageCapacityList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeCsiStorageCapacityListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIStorageCapacityList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIStorageCapacityList”.

---

KubeCustomResourceDefinition

CustomResourceDefinition represents a resource that should be exposed on the API server.

Its name MUST be in the format <.spec.name>.<.spec.group>.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeCustomResourceDefinition(scope: Construct, id: string, props: KubeCustomResourceDefinitionProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeCustomResourceDefinitionProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeCustomResourceDefinitionProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCustomResourceDefinition.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCustomResourceDefinition.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCustomResourceDefinition.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCustomResourceDefinition.manifest(props: KubeCustomResourceDefinitionProps)

Renders a Kubernetes manifest for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeCustomResourceDefinitionProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition”.

---

KubeCustomResourceDefinitionList

CustomResourceDefinitionList is a list of CustomResourceDefinition objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeCustomResourceDefinitionList(scope: Construct, id: string, props: KubeCustomResourceDefinitionListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeCustomResourceDefinitionListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeCustomResourceDefinitionListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCustomResourceDefinitionList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCustomResourceDefinitionList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCustomResourceDefinitionList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeCustomResourceDefinitionList.manifest(props: KubeCustomResourceDefinitionListProps)

Renders a Kubernetes manifest for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeCustomResourceDefinitionListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList”.

---

KubeDaemonSet

DaemonSet represents the configuration of a daemon set.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeDaemonSet(scope: Construct, id: string, props?: KubeDaemonSetProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeDaemonSetProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeDaemonSetProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.apps.v1.DaemonSet”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDaemonSet.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDaemonSet.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDaemonSet.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDaemonSet.manifest(props?: KubeDaemonSetProps)

Renders a Kubernetes manifest for “io.k8s.api.apps.v1.DaemonSet”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeDaemonSetProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.apps.v1.DaemonSet”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.apps.v1.DaemonSet”.

---

KubeDaemonSetList

DaemonSetList is a collection of daemon sets.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeDaemonSetList(scope: Construct, id: string, props: KubeDaemonSetListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeDaemonSetListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeDaemonSetListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.apps.v1.DaemonSetList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDaemonSetList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDaemonSetList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDaemonSetList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDaemonSetList.manifest(props: KubeDaemonSetListProps)

Renders a Kubernetes manifest for “io.k8s.api.apps.v1.DaemonSetList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeDaemonSetListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.apps.v1.DaemonSetList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.apps.v1.DaemonSetList”.

---

KubeDeployment

Deployment enables declarative updates for Pods and ReplicaSets.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeDeployment(scope: Construct, id: string, props?: KubeDeploymentProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeDeploymentProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeDeploymentProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.apps.v1.Deployment”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeployment.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeployment.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeployment.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeployment.manifest(props?: KubeDeploymentProps)

Renders a Kubernetes manifest for “io.k8s.api.apps.v1.Deployment”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeDeploymentProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.apps.v1.Deployment”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.apps.v1.Deployment”.

---

KubeDeploymentList

DeploymentList is a list of Deployments.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeDeploymentList(scope: Construct, id: string, props: KubeDeploymentListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeDeploymentListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeploymentListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.apps.v1.DeploymentList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeploymentList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeploymentList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeploymentList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeploymentList.manifest(props: KubeDeploymentListProps)

Renders a Kubernetes manifest for “io.k8s.api.apps.v1.DeploymentList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeploymentListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.apps.v1.DeploymentList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.apps.v1.DeploymentList”.

---

KubeDeviceClass

DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors.

It can be referenced in the device requests of a claim to apply these presets. Cluster scoped.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeDeviceClass(scope: Construct, id: string, props: KubeDeviceClassProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeDeviceClassProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceClassProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1.DeviceClass”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClass.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClass.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClass.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClass.manifest(props: KubeDeviceClassProps)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1.DeviceClass”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceClassProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1.DeviceClass”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1.DeviceClass”.

---

KubeDeviceClassList

DeviceClassList is a collection of classes.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeDeviceClassList(scope: Construct, id: string, props: KubeDeviceClassListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeDeviceClassListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceClassListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1.DeviceClassList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassList.manifest(props: KubeDeviceClassListProps)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1.DeviceClassList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceClassListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1.DeviceClassList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1.DeviceClassList”.

---

KubeDeviceClassListV1Beta1

DeviceClassList is a collection of classes.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeDeviceClassListV1Beta1(scope: Construct, id: string, props: KubeDeviceClassListV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeDeviceClassListV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceClassListV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.DeviceClassList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassListV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassListV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassListV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassListV1Beta1.manifest(props: KubeDeviceClassListV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.DeviceClassList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceClassListV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.DeviceClassList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.DeviceClassList”.

---

KubeDeviceClassListV1Beta2

DeviceClassList is a collection of classes.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeDeviceClassListV1Beta2(scope: Construct, id: string, props: KubeDeviceClassListV1Beta2Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeDeviceClassListV1Beta2Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceClassListV1Beta2Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.DeviceClassList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassListV1Beta2.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassListV1Beta2.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassListV1Beta2.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassListV1Beta2.manifest(props: KubeDeviceClassListV1Beta2Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.DeviceClassList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceClassListV1Beta2Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.DeviceClassList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.DeviceClassList”.

---

KubeDeviceClassV1Beta1

DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors.

It can be referenced in the device requests of a claim to apply these presets. Cluster scoped.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeDeviceClassV1Beta1(scope: Construct, id: string, props: KubeDeviceClassV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeDeviceClassV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceClassV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.DeviceClass”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassV1Beta1.manifest(props: KubeDeviceClassV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.DeviceClass”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceClassV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.DeviceClass”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.DeviceClass”.

---

KubeDeviceClassV1Beta2

DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors.

It can be referenced in the device requests of a claim to apply these presets. Cluster scoped.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeDeviceClassV1Beta2(scope: Construct, id: string, props: KubeDeviceClassV1Beta2Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeDeviceClassV1Beta2Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceClassV1Beta2Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.DeviceClass”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassV1Beta2.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassV1Beta2.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassV1Beta2.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceClassV1Beta2.manifest(props: KubeDeviceClassV1Beta2Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.DeviceClass”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceClassV1Beta2Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.DeviceClass”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.DeviceClass”.

---

KubeDeviceTaintRuleListV1Alpha3

DeviceTaintRuleList is a collection of DeviceTaintRules.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeDeviceTaintRuleListV1Alpha3(scope: Construct, id: string, props: KubeDeviceTaintRuleListV1Alpha3Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeDeviceTaintRuleListV1Alpha3Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceTaintRuleListV1Alpha3Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1alpha3.DeviceTaintRuleList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceTaintRuleListV1Alpha3.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceTaintRuleListV1Alpha3.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceTaintRuleListV1Alpha3.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceTaintRuleListV1Alpha3.manifest(props: KubeDeviceTaintRuleListV1Alpha3Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1alpha3.DeviceTaintRuleList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceTaintRuleListV1Alpha3Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1alpha3.DeviceTaintRuleList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1alpha3.DeviceTaintRuleList”.

---

KubeDeviceTaintRuleV1Alpha3

DeviceTaintRule adds one taint to all devices which match the selector.

This has the same effect as if the taint was specified directly in the ResourceSlice by the DRA driver.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeDeviceTaintRuleV1Alpha3(scope: Construct, id: string, props: KubeDeviceTaintRuleV1Alpha3Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeDeviceTaintRuleV1Alpha3Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceTaintRuleV1Alpha3Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1alpha3.DeviceTaintRule”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceTaintRuleV1Alpha3.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceTaintRuleV1Alpha3.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceTaintRuleV1Alpha3.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeDeviceTaintRuleV1Alpha3.manifest(props: KubeDeviceTaintRuleV1Alpha3Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1alpha3.DeviceTaintRule”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeDeviceTaintRuleV1Alpha3Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1alpha3.DeviceTaintRule”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1alpha3.DeviceTaintRule”.

---

KubeEndpoints

Endpoints is a collection of endpoints that implement the actual service. Example:.

Name: “mysvc”, Subsets: [ { Addresses: [{“ip”: “10.10.1.1”}, {“ip”: “10.10.2.2”}], Ports: [{“name”: “a”, “port”: 8675}, {“name”: “b”, “port”: 309}] }, { Addresses: [{“ip”: “10.10.3.3”}], Ports: [{“name”: “a”, “port”: 93}, {“name”: “b”, “port”: 76}] }, ]

Endpoints is a legacy API and does not contain information about all Service features. Use discoveryv1.EndpointSlice for complete information about Service endpoints.

Deprecated: This API is deprecated in v1.33+. Use discoveryv1.EndpointSlice.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeEndpoints(scope: Construct, id: string, props?: KubeEndpointsProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeEndpointsProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeEndpointsProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.Endpoints”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpoints.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpoints.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpoints.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpoints.manifest(props?: KubeEndpointsProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.Endpoints”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeEndpointsProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.Endpoints”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.Endpoints”.

---

KubeEndpointSlice

EndpointSlice represents a set of service endpoints.

Most EndpointSlices are created by the EndpointSlice controller to represent the Pods selected by Service objects. For a given service there may be multiple EndpointSlice objects which must be joined to produce the full set of endpoints; you can find all of the slices for a given service by listing EndpointSlices in the service’s namespace whose kubernetes.io/service-name label contains the service’s name.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeEndpointSlice(scope: Construct, id: string, props: KubeEndpointSliceProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeEndpointSliceProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeEndpointSliceProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.discovery.v1.EndpointSlice”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpointSlice.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpointSlice.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpointSlice.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpointSlice.manifest(props: KubeEndpointSliceProps)

Renders a Kubernetes manifest for “io.k8s.api.discovery.v1.EndpointSlice”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeEndpointSliceProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.discovery.v1.EndpointSlice”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.discovery.v1.EndpointSlice”.

---

KubeEndpointSliceList

EndpointSliceList represents a list of endpoint slices.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeEndpointSliceList(scope: Construct, id: string, props: KubeEndpointSliceListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeEndpointSliceListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeEndpointSliceListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.discovery.v1.EndpointSliceList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpointSliceList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpointSliceList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpointSliceList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpointSliceList.manifest(props: KubeEndpointSliceListProps)

Renders a Kubernetes manifest for “io.k8s.api.discovery.v1.EndpointSliceList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeEndpointSliceListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.discovery.v1.EndpointSliceList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.discovery.v1.EndpointSliceList”.

---

KubeEndpointsList

EndpointsList is a list of endpoints.

Deprecated: This API is deprecated in v1.33+.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeEndpointsList(scope: Construct, id: string, props: KubeEndpointsListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeEndpointsListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeEndpointsListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.EndpointsList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpointsList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpointsList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpointsList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEndpointsList.manifest(props: KubeEndpointsListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.EndpointsList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeEndpointsListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.EndpointsList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.EndpointsList”.

---

KubeEvent

Event is a report of an event somewhere in the cluster.

It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeEvent(scope: Construct, id: string, props: KubeEventProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeEventProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeEventProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.events.v1.Event”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEvent.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEvent.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEvent.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEvent.manifest(props: KubeEventProps)

Renders a Kubernetes manifest for “io.k8s.api.events.v1.Event”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeEventProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.events.v1.Event”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.events.v1.Event”.

---

KubeEventList

EventList is a list of Event objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeEventList(scope: Construct, id: string, props: KubeEventListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeEventListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeEventListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.events.v1.EventList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEventList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEventList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEventList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEventList.manifest(props: KubeEventListProps)

Renders a Kubernetes manifest for “io.k8s.api.events.v1.EventList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeEventListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.events.v1.EventList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.events.v1.EventList”.

---

KubeEviction

Eviction evicts a pod from its node subject to certain policies and safety constraints.

This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …/pods//evictions.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeEviction(scope: Construct, id: string, props?: KubeEvictionProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeEvictionProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeEvictionProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.policy.v1.Eviction”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEviction.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEviction.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEviction.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeEviction.manifest(props?: KubeEvictionProps)

Renders a Kubernetes manifest for “io.k8s.api.policy.v1.Eviction”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeEvictionProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.policy.v1.Eviction”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.policy.v1.Eviction”.

---

KubeFlowSchema

FlowSchema defines the schema of a group of flows.

Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a “flow distinguisher”.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeFlowSchema(scope: Construct, id: string, props?: KubeFlowSchemaProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeFlowSchemaProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeFlowSchemaProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.FlowSchema”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeFlowSchema.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeFlowSchema.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeFlowSchema.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeFlowSchema.manifest(props?: KubeFlowSchemaProps)

Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.FlowSchema”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeFlowSchemaProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.FlowSchema”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.FlowSchema”.

---

KubeFlowSchemaList

FlowSchemaList is a list of FlowSchema objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeFlowSchemaList(scope: Construct, id: string, props: KubeFlowSchemaListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeFlowSchemaListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeFlowSchemaListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.FlowSchemaList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeFlowSchemaList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeFlowSchemaList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeFlowSchemaList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeFlowSchemaList.manifest(props: KubeFlowSchemaListProps)

Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.FlowSchemaList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeFlowSchemaListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.FlowSchemaList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.FlowSchemaList”.

---

KubeHorizontalPodAutoscaler

configuration of a horizontal pod autoscaler.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeHorizontalPodAutoscaler(scope: Construct, id: string, props?: KubeHorizontalPodAutoscalerProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeHorizontalPodAutoscalerProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeHorizontalPodAutoscalerProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscaler.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscaler.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscaler.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscaler.manifest(props?: KubeHorizontalPodAutoscalerProps)

Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeHorizontalPodAutoscalerProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler”.

---

KubeHorizontalPodAutoscalerList

list of horizontal pod autoscaler objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeHorizontalPodAutoscalerList(scope: Construct, id: string, props: KubeHorizontalPodAutoscalerListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeHorizontalPodAutoscalerListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeHorizontalPodAutoscalerListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscalerList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscalerList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscalerList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscalerList.manifest(props: KubeHorizontalPodAutoscalerListProps)

Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeHorizontalPodAutoscalerListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList”.

---

KubeHorizontalPodAutoscalerListV2

HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeHorizontalPodAutoscalerListV2(scope: Construct, id: string, props: KubeHorizontalPodAutoscalerListV2Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeHorizontalPodAutoscalerListV2Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeHorizontalPodAutoscalerListV2Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscalerListV2.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscalerListV2.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscalerListV2.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscalerListV2.manifest(props: KubeHorizontalPodAutoscalerListV2Props)

Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeHorizontalPodAutoscalerListV2Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerList”.

---

KubeHorizontalPodAutoscalerV2

HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeHorizontalPodAutoscalerV2(scope: Construct, id: string, props?: KubeHorizontalPodAutoscalerV2Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeHorizontalPodAutoscalerV2Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeHorizontalPodAutoscalerV2Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscaler”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscalerV2.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscalerV2.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscalerV2.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeHorizontalPodAutoscalerV2.manifest(props?: KubeHorizontalPodAutoscalerV2Props)

Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscaler”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeHorizontalPodAutoscalerV2Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscaler”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscaler”.

---

KubeIngress

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend.

An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeIngress(scope: Construct, id: string, props?: KubeIngressProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeIngressProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeIngressProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1.Ingress”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngress.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngress.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngress.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngress.manifest(props?: KubeIngressProps)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1.Ingress”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeIngressProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1.Ingress”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1.Ingress”.

---

KubeIngressClass

IngressClass represents the class of the Ingress, referenced by the Ingress Spec.

The ingressclass.kubernetes.io/is-default-class annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeIngressClass(scope: Construct, id: string, props?: KubeIngressClassProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeIngressClassProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeIngressClassProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IngressClass”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngressClass.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngressClass.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngressClass.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngressClass.manifest(props?: KubeIngressClassProps)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IngressClass”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeIngressClassProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1.IngressClass”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1.IngressClass”.

---

KubeIngressClassList

IngressClassList is a collection of IngressClasses.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeIngressClassList(scope: Construct, id: string, props: KubeIngressClassListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeIngressClassListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeIngressClassListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IngressClassList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngressClassList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngressClassList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngressClassList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngressClassList.manifest(props: KubeIngressClassListProps)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IngressClassList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeIngressClassListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1.IngressClassList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1.IngressClassList”.

---

KubeIngressList

IngressList is a collection of Ingress.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeIngressList(scope: Construct, id: string, props: KubeIngressListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeIngressListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeIngressListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IngressList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngressList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngressList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngressList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIngressList.manifest(props: KubeIngressListProps)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IngressList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeIngressListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1.IngressList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1.IngressList”.

---

KubeIpAddress

IPAddress represents a single IP of a single IP Family.

The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeIpAddress(scope: Construct, id: string, props?: KubeIpAddressProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeIpAddressProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeIpAddressProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IPAddress”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddress.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddress.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddress.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddress.manifest(props?: KubeIpAddressProps)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IPAddress”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeIpAddressProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1.IPAddress”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1.IPAddress”.

---

KubeIpAddressList

IPAddressList contains a list of IPAddress.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeIpAddressList(scope: Construct, id: string, props: KubeIpAddressListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeIpAddressListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeIpAddressListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IPAddressList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddressList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddressList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddressList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddressList.manifest(props: KubeIpAddressListProps)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IPAddressList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeIpAddressListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1.IPAddressList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1.IPAddressList”.

---

KubeIpAddressListV1Beta1

IPAddressList contains a list of IPAddress.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeIpAddressListV1Beta1(scope: Construct, id: string, props: KubeIpAddressListV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeIpAddressListV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeIpAddressListV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.IPAddressList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddressListV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddressListV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddressListV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddressListV1Beta1.manifest(props: KubeIpAddressListV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.IPAddressList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeIpAddressListV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.IPAddressList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.IPAddressList”.

---

KubeIpAddressV1Beta1

IPAddress represents a single IP of a single IP Family.

The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeIpAddressV1Beta1(scope: Construct, id: string, props?: KubeIpAddressV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeIpAddressV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeIpAddressV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.IPAddress”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddressV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddressV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddressV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeIpAddressV1Beta1.manifest(props?: KubeIpAddressV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.IPAddress”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeIpAddressV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.IPAddress”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.IPAddress”.

---

KubeJob

Job represents the configuration of a single job.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeJob(scope: Construct, id: string, props?: KubeJobProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeJobProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeJobProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.batch.v1.Job”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeJob.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeJob.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeJob.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeJob.manifest(props?: KubeJobProps)

Renders a Kubernetes manifest for “io.k8s.api.batch.v1.Job”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeJobProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.batch.v1.Job”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.batch.v1.Job”.

---

KubeJobList

JobList is a collection of jobs.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeJobList(scope: Construct, id: string, props: KubeJobListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeJobListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeJobListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.batch.v1.JobList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeJobList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeJobList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeJobList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeJobList.manifest(props: KubeJobListProps)

Renders a Kubernetes manifest for “io.k8s.api.batch.v1.JobList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeJobListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.batch.v1.JobList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.batch.v1.JobList”.

---

KubeLease

Lease defines a lease concept.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeLease(scope: Construct, id: string, props?: KubeLeaseProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeLeaseProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeLeaseProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.coordination.v1.Lease”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLease.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLease.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLease.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLease.manifest(props?: KubeLeaseProps)

Renders a Kubernetes manifest for “io.k8s.api.coordination.v1.Lease”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeLeaseProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.coordination.v1.Lease”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.coordination.v1.Lease”.

---

KubeLeaseCandidateListV1Alpha2

LeaseCandidateList is a list of Lease objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeLeaseCandidateListV1Alpha2(scope: Construct, id: string, props: KubeLeaseCandidateListV1Alpha2Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeLeaseCandidateListV1Alpha2Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeLeaseCandidateListV1Alpha2Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.coordination.v1alpha2.LeaseCandidateList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateListV1Alpha2.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateListV1Alpha2.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateListV1Alpha2.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateListV1Alpha2.manifest(props: KubeLeaseCandidateListV1Alpha2Props)

Renders a Kubernetes manifest for “io.k8s.api.coordination.v1alpha2.LeaseCandidateList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeLeaseCandidateListV1Alpha2Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.coordination.v1alpha2.LeaseCandidateList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.coordination.v1alpha2.LeaseCandidateList”.

---

KubeLeaseCandidateListV1Beta1

LeaseCandidateList is a list of Lease objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeLeaseCandidateListV1Beta1(scope: Construct, id: string, props: KubeLeaseCandidateListV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeLeaseCandidateListV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeLeaseCandidateListV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.coordination.v1beta1.LeaseCandidateList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateListV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateListV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateListV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateListV1Beta1.manifest(props: KubeLeaseCandidateListV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.coordination.v1beta1.LeaseCandidateList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeLeaseCandidateListV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.coordination.v1beta1.LeaseCandidateList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.coordination.v1beta1.LeaseCandidateList”.

---

KubeLeaseCandidateV1Alpha2

LeaseCandidate defines a candidate for a Lease object.

Candidates are created such that coordinated leader election will pick the best leader from the list of candidates.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeLeaseCandidateV1Alpha2(scope: Construct, id: string, props?: KubeLeaseCandidateV1Alpha2Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeLeaseCandidateV1Alpha2Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeLeaseCandidateV1Alpha2Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.coordination.v1alpha2.LeaseCandidate”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateV1Alpha2.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateV1Alpha2.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateV1Alpha2.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateV1Alpha2.manifest(props?: KubeLeaseCandidateV1Alpha2Props)

Renders a Kubernetes manifest for “io.k8s.api.coordination.v1alpha2.LeaseCandidate”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeLeaseCandidateV1Alpha2Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.coordination.v1alpha2.LeaseCandidate”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.coordination.v1alpha2.LeaseCandidate”.

---

KubeLeaseCandidateV1Beta1

LeaseCandidate defines a candidate for a Lease object.

Candidates are created such that coordinated leader election will pick the best leader from the list of candidates.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeLeaseCandidateV1Beta1(scope: Construct, id: string, props?: KubeLeaseCandidateV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeLeaseCandidateV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeLeaseCandidateV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.coordination.v1beta1.LeaseCandidate”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseCandidateV1Beta1.manifest(props?: KubeLeaseCandidateV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.coordination.v1beta1.LeaseCandidate”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeLeaseCandidateV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.coordination.v1beta1.LeaseCandidate”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.coordination.v1beta1.LeaseCandidate”.

---

KubeLeaseList

LeaseList is a list of Lease objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeLeaseList(scope: Construct, id: string, props: KubeLeaseListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeLeaseListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeLeaseListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.coordination.v1.LeaseList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLeaseList.manifest(props: KubeLeaseListProps)

Renders a Kubernetes manifest for “io.k8s.api.coordination.v1.LeaseList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeLeaseListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.coordination.v1.LeaseList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.coordination.v1.LeaseList”.

---

KubeLimitRange

LimitRange sets resource usage limits for each kind of resource in a Namespace.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeLimitRange(scope: Construct, id: string, props?: KubeLimitRangeProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeLimitRangeProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeLimitRangeProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.LimitRange”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLimitRange.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLimitRange.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLimitRange.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLimitRange.manifest(props?: KubeLimitRangeProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.LimitRange”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeLimitRangeProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.LimitRange”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.LimitRange”.

---

KubeLimitRangeList

LimitRangeList is a list of LimitRange items.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeLimitRangeList(scope: Construct, id: string, props: KubeLimitRangeListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeLimitRangeListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeLimitRangeListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.LimitRangeList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLimitRangeList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLimitRangeList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLimitRangeList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLimitRangeList.manifest(props: KubeLimitRangeListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.LimitRangeList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeLimitRangeListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.LimitRangeList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.LimitRangeList”.

---

KubeLocalSubjectAccessReview

LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace.

Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeLocalSubjectAccessReview(scope: Construct, id: string, props: KubeLocalSubjectAccessReviewProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeLocalSubjectAccessReviewProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeLocalSubjectAccessReviewProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.LocalSubjectAccessReview”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLocalSubjectAccessReview.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLocalSubjectAccessReview.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLocalSubjectAccessReview.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeLocalSubjectAccessReview.manifest(props: KubeLocalSubjectAccessReviewProps)

Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.LocalSubjectAccessReview”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeLocalSubjectAccessReviewProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.authorization.v1.LocalSubjectAccessReview”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.authorization.v1.LocalSubjectAccessReview”.

---

KubeMutatingAdmissionPolicyBindingListV1Alpha1

MutatingAdmissionPolicyBindingList is a list of MutatingAdmissionPolicyBinding.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1(scope: Construct, id: string, props: KubeMutatingAdmissionPolicyBindingListV1Alpha1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBindingList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1.manifest(props: KubeMutatingAdmissionPolicyBindingListV1Alpha1Props)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBindingList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBindingList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBindingList”.

---

KubeMutatingAdmissionPolicyBindingListV1Beta1

MutatingAdmissionPolicyBindingList is a list of MutatingAdmissionPolicyBinding.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1(scope: Construct, id: string, props: KubeMutatingAdmissionPolicyBindingListV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBindingList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1.manifest(props: KubeMutatingAdmissionPolicyBindingListV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBindingList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBindingList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBindingList”.

---

KubeMutatingAdmissionPolicyBindingV1Alpha1

MutatingAdmissionPolicyBinding binds the MutatingAdmissionPolicy with parametrized resources.

MutatingAdmissionPolicyBinding and the optional parameter resource together define how cluster administrators configure policies for clusters.

For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don’t use params, otherwise N is the number of parameters selected by the binding. Each evaluation is constrained by a runtime cost budget.

Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1(scope: Construct, id: string, props?: KubeMutatingAdmissionPolicyBindingV1Alpha1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBinding”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1.manifest(props?: KubeMutatingAdmissionPolicyBindingV1Alpha1Props)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBinding”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBinding”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBinding”.

---

KubeMutatingAdmissionPolicyBindingV1Beta1

MutatingAdmissionPolicyBinding binds the MutatingAdmissionPolicy with parametrized resources.

MutatingAdmissionPolicyBinding and the optional parameter resource together define how cluster administrators configure policies for clusters.

For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don’t use params, otherwise N is the number of parameters selected by the binding. Each evaluation is constrained by a runtime cost budget.

Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeMutatingAdmissionPolicyBindingV1Beta1(scope: Construct, id: string, props?: KubeMutatingAdmissionPolicyBindingV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyBindingV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyBindingV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBinding”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyBindingV1Beta1.manifest(props?: KubeMutatingAdmissionPolicyBindingV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBinding”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyBindingV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBinding”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBinding”.

---

KubeMutatingAdmissionPolicyListV1Alpha1

MutatingAdmissionPolicyList is a list of MutatingAdmissionPolicy.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeMutatingAdmissionPolicyListV1Alpha1(scope: Construct, id: string, props: KubeMutatingAdmissionPolicyListV1Alpha1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyListV1Alpha1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyListV1Alpha1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyListV1Alpha1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyListV1Alpha1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyListV1Alpha1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyListV1Alpha1.manifest(props: KubeMutatingAdmissionPolicyListV1Alpha1Props)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyListV1Alpha1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyList”.

---

KubeMutatingAdmissionPolicyListV1Beta1

MutatingAdmissionPolicyList is a list of MutatingAdmissionPolicy.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeMutatingAdmissionPolicyListV1Beta1(scope: Construct, id: string, props: KubeMutatingAdmissionPolicyListV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyListV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyListV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyListV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyListV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyListV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyListV1Beta1.manifest(props: KubeMutatingAdmissionPolicyListV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyListV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyList”.

---

KubeMutatingAdmissionPolicyV1Alpha1

MutatingAdmissionPolicy describes the definition of an admission mutation policy that mutates the object coming into admission chain.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeMutatingAdmissionPolicyV1Alpha1(scope: Construct, id: string, props?: KubeMutatingAdmissionPolicyV1Alpha1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyV1Alpha1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyV1Alpha1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicy”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyV1Alpha1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyV1Alpha1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyV1Alpha1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyV1Alpha1.manifest(props?: KubeMutatingAdmissionPolicyV1Alpha1Props)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicy”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyV1Alpha1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicy”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicy”.

---

KubeMutatingAdmissionPolicyV1Beta1

MutatingAdmissionPolicy describes the definition of an admission mutation policy that mutates the object coming into admission chain.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeMutatingAdmissionPolicyV1Beta1(scope: Construct, id: string, props?: KubeMutatingAdmissionPolicyV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicy”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingAdmissionPolicyV1Beta1.manifest(props?: KubeMutatingAdmissionPolicyV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicy”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeMutatingAdmissionPolicyV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicy”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicy”.

---

KubeMutatingWebhookConfiguration

MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeMutatingWebhookConfiguration(scope: Construct, id: string, props?: KubeMutatingWebhookConfigurationProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeMutatingWebhookConfigurationProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeMutatingWebhookConfigurationProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingWebhookConfiguration.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingWebhookConfiguration.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingWebhookConfiguration.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingWebhookConfiguration.manifest(props?: KubeMutatingWebhookConfigurationProps)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeMutatingWebhookConfigurationProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration”.

---

KubeMutatingWebhookConfigurationList

MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeMutatingWebhookConfigurationList(scope: Construct, id: string, props: KubeMutatingWebhookConfigurationListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeMutatingWebhookConfigurationListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeMutatingWebhookConfigurationListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingWebhookConfigurationList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingWebhookConfigurationList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingWebhookConfigurationList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeMutatingWebhookConfigurationList.manifest(props: KubeMutatingWebhookConfigurationListProps)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeMutatingWebhookConfigurationListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList”.

---

KubeNamespace

Namespace provides a scope for Names.

Use of multiple namespaces is optional.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeNamespace(scope: Construct, id: string, props?: KubeNamespaceProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeNamespaceProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeNamespaceProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.Namespace”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNamespace.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNamespace.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNamespace.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNamespace.manifest(props?: KubeNamespaceProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.Namespace”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeNamespaceProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.Namespace”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.Namespace”.

---

KubeNamespaceList

NamespaceList is a list of Namespaces.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeNamespaceList(scope: Construct, id: string, props: KubeNamespaceListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeNamespaceListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeNamespaceListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.NamespaceList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNamespaceList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNamespaceList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNamespaceList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNamespaceList.manifest(props: KubeNamespaceListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.NamespaceList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeNamespaceListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.NamespaceList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.NamespaceList”.

---

KubeNetworkPolicy

NetworkPolicy describes what network traffic is allowed for a set of Pods.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeNetworkPolicy(scope: Construct, id: string, props?: KubeNetworkPolicyProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeNetworkPolicyProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeNetworkPolicyProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1.NetworkPolicy”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNetworkPolicy.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNetworkPolicy.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNetworkPolicy.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNetworkPolicy.manifest(props?: KubeNetworkPolicyProps)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1.NetworkPolicy”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeNetworkPolicyProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1.NetworkPolicy”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1.NetworkPolicy”.

---

KubeNetworkPolicyList

NetworkPolicyList is a list of NetworkPolicy objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeNetworkPolicyList(scope: Construct, id: string, props: KubeNetworkPolicyListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeNetworkPolicyListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeNetworkPolicyListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1.NetworkPolicyList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNetworkPolicyList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNetworkPolicyList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNetworkPolicyList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNetworkPolicyList.manifest(props: KubeNetworkPolicyListProps)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1.NetworkPolicyList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeNetworkPolicyListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1.NetworkPolicyList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1.NetworkPolicyList”.

---

KubeNode

Node is a worker node in Kubernetes.

Each node will have a unique identifier in the cache (i.e. in etcd).

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeNode(scope: Construct, id: string, props?: KubeNodeProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeNodeProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeNodeProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.Node”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNode.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNode.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNode.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNode.manifest(props?: KubeNodeProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.Node”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeNodeProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.Node”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.Node”.

---

KubeNodeList

NodeList is the whole list of all Nodes which have been registered with master.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeNodeList(scope: Construct, id: string, props: KubeNodeListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeNodeListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeNodeListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.NodeList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNodeList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNodeList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNodeList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeNodeList.manifest(props: KubeNodeListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.NodeList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeNodeListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.NodeList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.NodeList”.

---

KubePersistentVolume

PersistentVolume (PV) is a storage resource provisioned by an administrator.

It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePersistentVolume(scope: Construct, id: string, props?: KubePersistentVolumeProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePersistentVolumeProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubePersistentVolumeProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolume”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolume.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolume.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolume.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolume.manifest(props?: KubePersistentVolumeProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolume”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubePersistentVolumeProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolume”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolume”.

---

KubePersistentVolumeClaim

PersistentVolumeClaim is a user’s request for and claim to a persistent volume.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePersistentVolumeClaim(scope: Construct, id: string, props?: KubePersistentVolumeClaimProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePersistentVolumeClaimProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubePersistentVolumeClaimProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolumeClaim”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolumeClaim.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolumeClaim.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolumeClaim.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolumeClaim.manifest(props?: KubePersistentVolumeClaimProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolumeClaim”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubePersistentVolumeClaimProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolumeClaim”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolumeClaim”.

---

KubePersistentVolumeClaimList

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePersistentVolumeClaimList(scope: Construct, id: string, props: KubePersistentVolumeClaimListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePersistentVolumeClaimListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubePersistentVolumeClaimListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolumeClaimList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolumeClaimList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolumeClaimList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolumeClaimList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolumeClaimList.manifest(props: KubePersistentVolumeClaimListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolumeClaimList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubePersistentVolumeClaimListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolumeClaimList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolumeClaimList”.

---

KubePersistentVolumeList

PersistentVolumeList is a list of PersistentVolume items.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePersistentVolumeList(scope: Construct, id: string, props: KubePersistentVolumeListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePersistentVolumeListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubePersistentVolumeListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolumeList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolumeList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolumeList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolumeList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePersistentVolumeList.manifest(props: KubePersistentVolumeListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolumeList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubePersistentVolumeListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolumeList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolumeList”.

---

KubePod

Pod is a collection of containers that can run on a host.

This resource is created by clients and scheduled onto hosts.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePod(scope: Construct, id: string, props?: KubePodProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePodProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubePodProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.Pod”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePod.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePod.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePod.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePod.manifest(props?: KubePodProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.Pod”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubePodProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.Pod”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.Pod”.

---

KubePodCertificateRequestListV1Alpha1

PodCertificateRequestList is a collection of PodCertificateRequest objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePodCertificateRequestListV1Alpha1(scope: Construct, id: string, props: KubePodCertificateRequestListV1Alpha1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePodCertificateRequestListV1Alpha1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubePodCertificateRequestListV1Alpha1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.certificates.v1alpha1.PodCertificateRequestList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodCertificateRequestListV1Alpha1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodCertificateRequestListV1Alpha1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodCertificateRequestListV1Alpha1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodCertificateRequestListV1Alpha1.manifest(props: KubePodCertificateRequestListV1Alpha1Props)

Renders a Kubernetes manifest for “io.k8s.api.certificates.v1alpha1.PodCertificateRequestList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubePodCertificateRequestListV1Alpha1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.certificates.v1alpha1.PodCertificateRequestList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.certificates.v1alpha1.PodCertificateRequestList”.

---

KubePodCertificateRequestV1Alpha1

PodCertificateRequest encodes a pod requesting a certificate from a given signer.

Kubelets use this API to implement podCertificate projected volumes

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePodCertificateRequestV1Alpha1(scope: Construct, id: string, props: KubePodCertificateRequestV1Alpha1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePodCertificateRequestV1Alpha1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubePodCertificateRequestV1Alpha1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.certificates.v1alpha1.PodCertificateRequest”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodCertificateRequestV1Alpha1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodCertificateRequestV1Alpha1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodCertificateRequestV1Alpha1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodCertificateRequestV1Alpha1.manifest(props: KubePodCertificateRequestV1Alpha1Props)

Renders a Kubernetes manifest for “io.k8s.api.certificates.v1alpha1.PodCertificateRequest”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubePodCertificateRequestV1Alpha1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.certificates.v1alpha1.PodCertificateRequest”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.certificates.v1alpha1.PodCertificateRequest”.

---

KubePodDisruptionBudget

PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePodDisruptionBudget(scope: Construct, id: string, props?: KubePodDisruptionBudgetProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePodDisruptionBudgetProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubePodDisruptionBudgetProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.policy.v1.PodDisruptionBudget”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodDisruptionBudget.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodDisruptionBudget.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodDisruptionBudget.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodDisruptionBudget.manifest(props?: KubePodDisruptionBudgetProps)

Renders a Kubernetes manifest for “io.k8s.api.policy.v1.PodDisruptionBudget”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubePodDisruptionBudgetProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.policy.v1.PodDisruptionBudget”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.policy.v1.PodDisruptionBudget”.

---

KubePodDisruptionBudgetList

PodDisruptionBudgetList is a collection of PodDisruptionBudgets.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePodDisruptionBudgetList(scope: Construct, id: string, props: KubePodDisruptionBudgetListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePodDisruptionBudgetListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubePodDisruptionBudgetListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.policy.v1.PodDisruptionBudgetList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodDisruptionBudgetList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodDisruptionBudgetList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodDisruptionBudgetList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodDisruptionBudgetList.manifest(props: KubePodDisruptionBudgetListProps)

Renders a Kubernetes manifest for “io.k8s.api.policy.v1.PodDisruptionBudgetList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubePodDisruptionBudgetListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.policy.v1.PodDisruptionBudgetList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.policy.v1.PodDisruptionBudgetList”.

---

KubePodList

PodList is a list of Pods.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePodList(scope: Construct, id: string, props: KubePodListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePodListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubePodListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.PodList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodList.manifest(props: KubePodListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.PodList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubePodListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.PodList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.PodList”.

---

KubePodTemplate

PodTemplate describes a template for creating copies of a predefined pod.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePodTemplate(scope: Construct, id: string, props?: KubePodTemplateProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePodTemplateProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubePodTemplateProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.PodTemplate”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodTemplate.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodTemplate.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodTemplate.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodTemplate.manifest(props?: KubePodTemplateProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.PodTemplate”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubePodTemplateProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.PodTemplate”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.PodTemplate”.

---

KubePodTemplateList

PodTemplateList is a list of PodTemplates.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePodTemplateList(scope: Construct, id: string, props: KubePodTemplateListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePodTemplateListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubePodTemplateListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.PodTemplateList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodTemplateList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodTemplateList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodTemplateList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePodTemplateList.manifest(props: KubePodTemplateListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.PodTemplateList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubePodTemplateListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.PodTemplateList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.PodTemplateList”.

---

KubePriorityClass

PriorityClass defines mapping from a priority class name to the priority integer value.

The value can be any valid integer.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePriorityClass(scope: Construct, id: string, props: KubePriorityClassProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePriorityClassProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubePriorityClassProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.scheduling.v1.PriorityClass”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityClass.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityClass.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityClass.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityClass.manifest(props: KubePriorityClassProps)

Renders a Kubernetes manifest for “io.k8s.api.scheduling.v1.PriorityClass”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubePriorityClassProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.scheduling.v1.PriorityClass”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.scheduling.v1.PriorityClass”.

---

KubePriorityClassList

PriorityClassList is a collection of priority classes.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePriorityClassList(scope: Construct, id: string, props: KubePriorityClassListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePriorityClassListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubePriorityClassListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.scheduling.v1.PriorityClassList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityClassList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityClassList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityClassList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityClassList.manifest(props: KubePriorityClassListProps)

Renders a Kubernetes manifest for “io.k8s.api.scheduling.v1.PriorityClassList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubePriorityClassListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.scheduling.v1.PriorityClassList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.scheduling.v1.PriorityClassList”.

---

KubePriorityLevelConfiguration

PriorityLevelConfiguration represents the configuration of a priority level.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePriorityLevelConfiguration(scope: Construct, id: string, props?: KubePriorityLevelConfigurationProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePriorityLevelConfigurationProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubePriorityLevelConfigurationProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.PriorityLevelConfiguration”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityLevelConfiguration.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityLevelConfiguration.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityLevelConfiguration.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityLevelConfiguration.manifest(props?: KubePriorityLevelConfigurationProps)

Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.PriorityLevelConfiguration”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubePriorityLevelConfigurationProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.PriorityLevelConfiguration”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.PriorityLevelConfiguration”.

---

KubePriorityLevelConfigurationList

PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubePriorityLevelConfigurationList(scope: Construct, id: string, props: KubePriorityLevelConfigurationListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubePriorityLevelConfigurationListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubePriorityLevelConfigurationListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.PriorityLevelConfigurationList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityLevelConfigurationList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityLevelConfigurationList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityLevelConfigurationList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubePriorityLevelConfigurationList.manifest(props: KubePriorityLevelConfigurationListProps)

Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.PriorityLevelConfigurationList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubePriorityLevelConfigurationListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.PriorityLevelConfigurationList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.PriorityLevelConfigurationList”.

---

KubeReplicaSet

ReplicaSet ensures that a specified number of pod replicas are running at any given time.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeReplicaSet(scope: Construct, id: string, props?: KubeReplicaSetProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeReplicaSetProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeReplicaSetProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ReplicaSet”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicaSet.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicaSet.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicaSet.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicaSet.manifest(props?: KubeReplicaSetProps)

Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ReplicaSet”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeReplicaSetProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.apps.v1.ReplicaSet”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.apps.v1.ReplicaSet”.

---

KubeReplicaSetList

ReplicaSetList is a collection of ReplicaSets.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeReplicaSetList(scope: Construct, id: string, props: KubeReplicaSetListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeReplicaSetListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeReplicaSetListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ReplicaSetList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicaSetList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicaSetList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicaSetList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicaSetList.manifest(props: KubeReplicaSetListProps)

Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ReplicaSetList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeReplicaSetListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.apps.v1.ReplicaSetList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.apps.v1.ReplicaSetList”.

---

KubeReplicationController

ReplicationController represents the configuration of a replication controller.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeReplicationController(scope: Construct, id: string, props?: KubeReplicationControllerProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeReplicationControllerProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeReplicationControllerProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.ReplicationController”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicationController.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicationController.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicationController.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicationController.manifest(props?: KubeReplicationControllerProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.ReplicationController”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeReplicationControllerProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.ReplicationController”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.ReplicationController”.

---

KubeReplicationControllerList

ReplicationControllerList is a collection of replication controllers.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeReplicationControllerList(scope: Construct, id: string, props: KubeReplicationControllerListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeReplicationControllerListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeReplicationControllerListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.ReplicationControllerList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicationControllerList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicationControllerList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicationControllerList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeReplicationControllerList.manifest(props: KubeReplicationControllerListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.ReplicationControllerList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeReplicationControllerListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.ReplicationControllerList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.ReplicationControllerList”.

---

KubeResourceClaim

ResourceClaim describes a request for access to resources in the cluster, for use by workloads.

For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceClaim(scope: Construct, id: string, props: KubeResourceClaimProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceClaimProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaim”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaim.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaim.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaim.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaim.manifest(props: KubeResourceClaimProps)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaim”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaim”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaim”.

---

KubeResourceClaimList

ResourceClaimList is a collection of claims.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceClaimList(scope: Construct, id: string, props: KubeResourceClaimListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceClaimListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaimList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimList.manifest(props: KubeResourceClaimListProps)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaimList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaimList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaimList”.

---

KubeResourceClaimListV1Beta1

ResourceClaimList is a collection of claims.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceClaimListV1Beta1(scope: Construct, id: string, props: KubeResourceClaimListV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceClaimListV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimListV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaimList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimListV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimListV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimListV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimListV1Beta1.manifest(props: KubeResourceClaimListV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaimList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimListV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaimList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaimList”.

---

KubeResourceClaimListV1Beta2

ResourceClaimList is a collection of claims.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceClaimListV1Beta2(scope: Construct, id: string, props: KubeResourceClaimListV1Beta2Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceClaimListV1Beta2Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimListV1Beta2Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaimList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimListV1Beta2.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimListV1Beta2.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimListV1Beta2.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimListV1Beta2.manifest(props: KubeResourceClaimListV1Beta2Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaimList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimListV1Beta2Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaimList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaimList”.

---

KubeResourceClaimTemplate

ResourceClaimTemplate is used to produce ResourceClaim objects.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceClaimTemplate(scope: Construct, id: string, props: KubeResourceClaimTemplateProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceClaimTemplateProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimTemplateProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaimTemplate”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplate.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplate.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplate.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplate.manifest(props: KubeResourceClaimTemplateProps)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaimTemplate”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimTemplateProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaimTemplate”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaimTemplate”.

---

KubeResourceClaimTemplateList

ResourceClaimTemplateList is a collection of claim templates.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceClaimTemplateList(scope: Construct, id: string, props: KubeResourceClaimTemplateListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceClaimTemplateListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimTemplateListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaimTemplateList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateList.manifest(props: KubeResourceClaimTemplateListProps)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaimTemplateList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimTemplateListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaimTemplateList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaimTemplateList”.

---

KubeResourceClaimTemplateListV1Beta1

ResourceClaimTemplateList is a collection of claim templates.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceClaimTemplateListV1Beta1(scope: Construct, id: string, props: KubeResourceClaimTemplateListV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceClaimTemplateListV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimTemplateListV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaimTemplateList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateListV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateListV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateListV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateListV1Beta1.manifest(props: KubeResourceClaimTemplateListV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaimTemplateList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimTemplateListV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaimTemplateList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaimTemplateList”.

---

KubeResourceClaimTemplateListV1Beta2

ResourceClaimTemplateList is a collection of claim templates.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceClaimTemplateListV1Beta2(scope: Construct, id: string, props: KubeResourceClaimTemplateListV1Beta2Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceClaimTemplateListV1Beta2Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimTemplateListV1Beta2Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaimTemplateList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateListV1Beta2.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateListV1Beta2.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateListV1Beta2.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateListV1Beta2.manifest(props: KubeResourceClaimTemplateListV1Beta2Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaimTemplateList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimTemplateListV1Beta2Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaimTemplateList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaimTemplateList”.

---

KubeResourceClaimTemplateV1Beta1

ResourceClaimTemplate is used to produce ResourceClaim objects.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceClaimTemplateV1Beta1(scope: Construct, id: string, props: KubeResourceClaimTemplateV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceClaimTemplateV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimTemplateV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaimTemplate”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateV1Beta1.manifest(props: KubeResourceClaimTemplateV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaimTemplate”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimTemplateV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaimTemplate”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaimTemplate”.

---

KubeResourceClaimTemplateV1Beta2

ResourceClaimTemplate is used to produce ResourceClaim objects.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceClaimTemplateV1Beta2(scope: Construct, id: string, props: KubeResourceClaimTemplateV1Beta2Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceClaimTemplateV1Beta2Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimTemplateV1Beta2Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaimTemplate”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateV1Beta2.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateV1Beta2.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateV1Beta2.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimTemplateV1Beta2.manifest(props: KubeResourceClaimTemplateV1Beta2Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaimTemplate”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimTemplateV1Beta2Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaimTemplate”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaimTemplate”.

---

KubeResourceClaimV1Beta1

ResourceClaim describes a request for access to resources in the cluster, for use by workloads.

For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceClaimV1Beta1(scope: Construct, id: string, props: KubeResourceClaimV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceClaimV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaim”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimV1Beta1.manifest(props: KubeResourceClaimV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaim”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaim”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaim”.

---

KubeResourceClaimV1Beta2

ResourceClaim describes a request for access to resources in the cluster, for use by workloads.

For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceClaimV1Beta2(scope: Construct, id: string, props: KubeResourceClaimV1Beta2Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceClaimV1Beta2Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimV1Beta2Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaim”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimV1Beta2.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimV1Beta2.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimV1Beta2.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceClaimV1Beta2.manifest(props: KubeResourceClaimV1Beta2Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaim”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceClaimV1Beta2Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaim”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaim”.

---

KubeResourceQuota

ResourceQuota sets aggregate quota restrictions enforced per namespace.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceQuota(scope: Construct, id: string, props?: KubeResourceQuotaProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceQuotaProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeResourceQuotaProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.ResourceQuota”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceQuota.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceQuota.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceQuota.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceQuota.manifest(props?: KubeResourceQuotaProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.ResourceQuota”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeResourceQuotaProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.ResourceQuota”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.ResourceQuota”.

---

KubeResourceQuotaList

ResourceQuotaList is a list of ResourceQuota items.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceQuotaList(scope: Construct, id: string, props: KubeResourceQuotaListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceQuotaListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceQuotaListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.ResourceQuotaList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceQuotaList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceQuotaList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceQuotaList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceQuotaList.manifest(props: KubeResourceQuotaListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.ResourceQuotaList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceQuotaListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.ResourceQuotaList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.ResourceQuotaList”.

---

KubeResourceSlice

ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver.

A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.

At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple , , .

Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.

When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.

For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceSlice(scope: Construct, id: string, props: KubeResourceSliceProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceSliceProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceSliceProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceSlice”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSlice.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSlice.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSlice.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSlice.manifest(props: KubeResourceSliceProps)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceSlice”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceSliceProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceSlice”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceSlice”.

---

KubeResourceSliceList

ResourceSliceList is a collection of ResourceSlices.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceSliceList(scope: Construct, id: string, props: KubeResourceSliceListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceSliceListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceSliceListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceSliceList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceList.manifest(props: KubeResourceSliceListProps)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceSliceList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceSliceListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceSliceList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceSliceList”.

---

KubeResourceSliceListV1Beta1

ResourceSliceList is a collection of ResourceSlices.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceSliceListV1Beta1(scope: Construct, id: string, props: KubeResourceSliceListV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceSliceListV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceSliceListV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceSliceList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceListV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceListV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceListV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceListV1Beta1.manifest(props: KubeResourceSliceListV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceSliceList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceSliceListV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceSliceList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceSliceList”.

---

KubeResourceSliceListV1Beta2

ResourceSliceList is a collection of ResourceSlices.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceSliceListV1Beta2(scope: Construct, id: string, props: KubeResourceSliceListV1Beta2Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceSliceListV1Beta2Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceSliceListV1Beta2Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceSliceList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceListV1Beta2.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceListV1Beta2.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceListV1Beta2.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceListV1Beta2.manifest(props: KubeResourceSliceListV1Beta2Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceSliceList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceSliceListV1Beta2Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceSliceList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceSliceList”.

---

KubeResourceSliceV1Beta1

ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver.

A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.

At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple , , .

Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.

When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.

For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceSliceV1Beta1(scope: Construct, id: string, props: KubeResourceSliceV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceSliceV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceSliceV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceSlice”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceV1Beta1.manifest(props: KubeResourceSliceV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceSlice”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceSliceV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceSlice”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceSlice”.

---

KubeResourceSliceV1Beta2

ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver.

A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.

At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple , , .

Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.

When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.

For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeResourceSliceV1Beta2(scope: Construct, id: string, props: KubeResourceSliceV1Beta2Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeResourceSliceV1Beta2Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceSliceV1Beta2Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceSlice”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceV1Beta2.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceV1Beta2.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceV1Beta2.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeResourceSliceV1Beta2.manifest(props: KubeResourceSliceV1Beta2Props)

Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceSlice”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeResourceSliceV1Beta2Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceSlice”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceSlice”.

---

KubeRole

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeRole(scope: Construct, id: string, props?: KubeRoleProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeRoleProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeRoleProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.Role”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRole.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRole.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRole.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRole.manifest(props?: KubeRoleProps)

Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.Role”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeRoleProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.rbac.v1.Role”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.rbac.v1.Role”.

---

KubeRoleBinding

RoleBinding references a role, but does not contain it.

It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeRoleBinding(scope: Construct, id: string, props: KubeRoleBindingProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeRoleBindingProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeRoleBindingProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.RoleBinding”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRoleBinding.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRoleBinding.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRoleBinding.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRoleBinding.manifest(props: KubeRoleBindingProps)

Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.RoleBinding”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeRoleBindingProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.rbac.v1.RoleBinding”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.rbac.v1.RoleBinding”.

---

KubeRoleBindingList

RoleBindingList is a collection of RoleBindings.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeRoleBindingList(scope: Construct, id: string, props: KubeRoleBindingListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeRoleBindingListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeRoleBindingListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.RoleBindingList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRoleBindingList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRoleBindingList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRoleBindingList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRoleBindingList.manifest(props: KubeRoleBindingListProps)

Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.RoleBindingList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeRoleBindingListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.rbac.v1.RoleBindingList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.rbac.v1.RoleBindingList”.

---

KubeRoleList

RoleList is a collection of Roles.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeRoleList(scope: Construct, id: string, props: KubeRoleListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeRoleListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeRoleListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.RoleList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRoleList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRoleList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRoleList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRoleList.manifest(props: KubeRoleListProps)

Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.RoleList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeRoleListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.rbac.v1.RoleList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.rbac.v1.RoleList”.

---

KubeRuntimeClass

RuntimeClass defines a class of container runtime supported in the cluster.

The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://kubernetes.io/docs/concepts/containers/runtime-class/

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeRuntimeClass(scope: Construct, id: string, props: KubeRuntimeClassProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeRuntimeClassProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeRuntimeClassProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.node.v1.RuntimeClass”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRuntimeClass.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRuntimeClass.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRuntimeClass.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRuntimeClass.manifest(props: KubeRuntimeClassProps)

Renders a Kubernetes manifest for “io.k8s.api.node.v1.RuntimeClass”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeRuntimeClassProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.node.v1.RuntimeClass”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.node.v1.RuntimeClass”.

---

KubeRuntimeClassList

RuntimeClassList is a list of RuntimeClass objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeRuntimeClassList(scope: Construct, id: string, props: KubeRuntimeClassListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeRuntimeClassListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeRuntimeClassListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.node.v1.RuntimeClassList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRuntimeClassList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRuntimeClassList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRuntimeClassList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeRuntimeClassList.manifest(props: KubeRuntimeClassListProps)

Renders a Kubernetes manifest for “io.k8s.api.node.v1.RuntimeClassList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeRuntimeClassListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.node.v1.RuntimeClassList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.node.v1.RuntimeClassList”.

---

KubeScale

Scale represents a scaling request for a resource.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeScale(scope: Construct, id: string, props?: KubeScaleProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeScaleProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeScaleProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v1.Scale”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeScale.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeScale.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeScale.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeScale.manifest(props?: KubeScaleProps)

Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v1.Scale”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeScaleProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.autoscaling.v1.Scale”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.autoscaling.v1.Scale”.

---

KubeSecret

Secret holds secret data of a certain type.

The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeSecret(scope: Construct, id: string, props?: KubeSecretProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeSecretProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeSecretProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.Secret”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSecret.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSecret.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSecret.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSecret.manifest(props?: KubeSecretProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.Secret”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeSecretProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.Secret”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.Secret”.

---

KubeSecretList

SecretList is a list of Secret.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeSecretList(scope: Construct, id: string, props: KubeSecretListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeSecretListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeSecretListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.SecretList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSecretList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSecretList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSecretList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSecretList.manifest(props: KubeSecretListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.SecretList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeSecretListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.SecretList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.SecretList”.

---

KubeSelfSubjectAccessReview

SelfSubjectAccessReview checks whether or the current user can perform an action.

Not filling in a spec.namespace means “in all namespaces”. Self is a special case, because users should always be able to check whether they can perform an action

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeSelfSubjectAccessReview(scope: Construct, id: string, props: KubeSelfSubjectAccessReviewProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeSelfSubjectAccessReviewProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeSelfSubjectAccessReviewProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.SelfSubjectAccessReview”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSelfSubjectAccessReview.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSelfSubjectAccessReview.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSelfSubjectAccessReview.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSelfSubjectAccessReview.manifest(props: KubeSelfSubjectAccessReviewProps)

Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.SelfSubjectAccessReview”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeSelfSubjectAccessReviewProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.authorization.v1.SelfSubjectAccessReview”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.authorization.v1.SelfSubjectAccessReview”.

---

KubeSelfSubjectReview

SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request.

When using impersonation, users will receive the user info of the user being impersonated. If impersonation or request header authentication is used, any extra keys will have their case ignored and returned as lowercase.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeSelfSubjectReview(scope: Construct, id: string, props?: KubeSelfSubjectReviewProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeSelfSubjectReviewProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeSelfSubjectReviewProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.authentication.v1.SelfSubjectReview”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSelfSubjectReview.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSelfSubjectReview.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSelfSubjectReview.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSelfSubjectReview.manifest(props?: KubeSelfSubjectReviewProps)

Renders a Kubernetes manifest for “io.k8s.api.authentication.v1.SelfSubjectReview”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeSelfSubjectReviewProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.authentication.v1.SelfSubjectReview”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.authentication.v1.SelfSubjectReview”.

---

KubeSelfSubjectRulesReview

SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace.

The returned list of actions may be incomplete depending on the server’s authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeSelfSubjectRulesReview(scope: Construct, id: string, props: KubeSelfSubjectRulesReviewProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeSelfSubjectRulesReviewProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeSelfSubjectRulesReviewProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.SelfSubjectRulesReview”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSelfSubjectRulesReview.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSelfSubjectRulesReview.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSelfSubjectRulesReview.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSelfSubjectRulesReview.manifest(props: KubeSelfSubjectRulesReviewProps)

Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.SelfSubjectRulesReview”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeSelfSubjectRulesReviewProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.authorization.v1.SelfSubjectRulesReview”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.authorization.v1.SelfSubjectRulesReview”.

---

KubeService

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeService(scope: Construct, id: string, props?: KubeServiceProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeServiceProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeServiceProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.Service”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeService.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeService.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeService.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeService.manifest(props?: KubeServiceProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.Service”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeServiceProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.Service”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.Service”.

---

KubeServiceAccount

ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeServiceAccount(scope: Construct, id: string, props?: KubeServiceAccountProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeServiceAccountProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeServiceAccountProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.ServiceAccount”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceAccount.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceAccount.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceAccount.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceAccount.manifest(props?: KubeServiceAccountProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.ServiceAccount”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeServiceAccountProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.ServiceAccount”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.ServiceAccount”.

---

KubeServiceAccountList

ServiceAccountList is a list of ServiceAccount objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeServiceAccountList(scope: Construct, id: string, props: KubeServiceAccountListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeServiceAccountListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeServiceAccountListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.ServiceAccountList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceAccountList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceAccountList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceAccountList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceAccountList.manifest(props: KubeServiceAccountListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.ServiceAccountList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeServiceAccountListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.ServiceAccountList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.ServiceAccountList”.

---

KubeServiceCidr

ServiceCIDR defines a range of IP addresses using CIDR format (e.g. 192.168.0.0/24 or 2001:db2::/64). This range is used to allocate ClusterIPs to Service objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeServiceCidr(scope: Construct, id: string, props?: KubeServiceCidrProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeServiceCidrProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeServiceCidrProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1.ServiceCIDR”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidr.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidr.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidr.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidr.manifest(props?: KubeServiceCidrProps)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1.ServiceCIDR”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeServiceCidrProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1.ServiceCIDR”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1.ServiceCIDR”.

---

KubeServiceCidrList

ServiceCIDRList contains a list of ServiceCIDR objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeServiceCidrList(scope: Construct, id: string, props: KubeServiceCidrListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeServiceCidrListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeServiceCidrListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1.ServiceCIDRList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidrList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidrList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidrList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidrList.manifest(props: KubeServiceCidrListProps)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1.ServiceCIDRList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeServiceCidrListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1.ServiceCIDRList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1.ServiceCIDRList”.

---

KubeServiceCidrListV1Beta1

ServiceCIDRList contains a list of ServiceCIDR objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeServiceCidrListV1Beta1(scope: Construct, id: string, props: KubeServiceCidrListV1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeServiceCidrListV1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeServiceCidrListV1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.ServiceCIDRList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidrListV1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidrListV1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidrListV1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidrListV1Beta1.manifest(props: KubeServiceCidrListV1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.ServiceCIDRList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeServiceCidrListV1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.ServiceCIDRList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.ServiceCIDRList”.

---

KubeServiceCidrv1Beta1

ServiceCIDR defines a range of IP addresses using CIDR format (e.g. 192.168.0.0/24 or 2001:db2::/64). This range is used to allocate ClusterIPs to Service objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeServiceCidrv1Beta1(scope: Construct, id: string, props?: KubeServiceCidrv1Beta1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeServiceCidrv1Beta1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeServiceCidrv1Beta1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.ServiceCIDR”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidrv1Beta1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidrv1Beta1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidrv1Beta1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceCidrv1Beta1.manifest(props?: KubeServiceCidrv1Beta1Props)

Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.ServiceCIDR”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeServiceCidrv1Beta1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.ServiceCIDR”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.ServiceCIDR”.

---

KubeServiceList

ServiceList holds a list of services.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeServiceList(scope: Construct, id: string, props: KubeServiceListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeServiceListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeServiceListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.core.v1.ServiceList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeServiceList.manifest(props: KubeServiceListProps)

Renders a Kubernetes manifest for “io.k8s.api.core.v1.ServiceList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeServiceListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.core.v1.ServiceList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.core.v1.ServiceList”.

---

KubeStatefulSet

StatefulSet represents a set of pods with consistent identities.

Identities are defined as: - Network: A single stable DNS and hostname. - Storage: As many VolumeClaims as requested.

The StatefulSet guarantees that a given network identity will always map to the same storage identity.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeStatefulSet(scope: Construct, id: string, props?: KubeStatefulSetProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeStatefulSetProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeStatefulSetProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.apps.v1.StatefulSet”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStatefulSet.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStatefulSet.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStatefulSet.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStatefulSet.manifest(props?: KubeStatefulSetProps)

Renders a Kubernetes manifest for “io.k8s.api.apps.v1.StatefulSet”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeStatefulSetProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.apps.v1.StatefulSet”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.apps.v1.StatefulSet”.

---

KubeStatefulSetList

StatefulSetList is a collection of StatefulSets.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeStatefulSetList(scope: Construct, id: string, props: KubeStatefulSetListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeStatefulSetListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeStatefulSetListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.apps.v1.StatefulSetList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStatefulSetList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStatefulSetList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStatefulSetList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStatefulSetList.manifest(props: KubeStatefulSetListProps)

Renders a Kubernetes manifest for “io.k8s.api.apps.v1.StatefulSetList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeStatefulSetListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.apps.v1.StatefulSetList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.apps.v1.StatefulSetList”.

---

KubeStatus

Status is a return value for calls that don’t return other objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeStatus(scope: Construct, id: string, props?: KubeStatusProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeStatusProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeStatusProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.apimachinery.pkg.apis.meta.v1.Status”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStatus.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStatus.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStatus.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStatus.manifest(props?: KubeStatusProps)

Renders a Kubernetes manifest for “io.k8s.apimachinery.pkg.apis.meta.v1.Status”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeStatusProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.apimachinery.pkg.apis.meta.v1.Status”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.apimachinery.pkg.apis.meta.v1.Status”.

---

KubeStorageClass

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeStorageClass(scope: Construct, id: string, props: KubeStorageClassProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeStorageClassProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeStorageClassProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.storage.v1.StorageClass”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageClass.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageClass.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageClass.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageClass.manifest(props: KubeStorageClassProps)

Renders a Kubernetes manifest for “io.k8s.api.storage.v1.StorageClass”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeStorageClassProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.storage.v1.StorageClass”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.storage.v1.StorageClass”.

---

KubeStorageClassList

StorageClassList is a collection of storage classes.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeStorageClassList(scope: Construct, id: string, props: KubeStorageClassListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeStorageClassListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeStorageClassListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.storage.v1.StorageClassList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageClassList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageClassList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageClassList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageClassList.manifest(props: KubeStorageClassListProps)

Renders a Kubernetes manifest for “io.k8s.api.storage.v1.StorageClassList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeStorageClassListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.storage.v1.StorageClassList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.storage.v1.StorageClassList”.

---

KubeStorageVersionListV1Alpha1

A list of StorageVersions.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeStorageVersionListV1Alpha1(scope: Construct, id: string, props: KubeStorageVersionListV1Alpha1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeStorageVersionListV1Alpha1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeStorageVersionListV1Alpha1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionListV1Alpha1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionListV1Alpha1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionListV1Alpha1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionListV1Alpha1.manifest(props: KubeStorageVersionListV1Alpha1Props)

Renders a Kubernetes manifest for “io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeStorageVersionListV1Alpha1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList”.

---

KubeStorageVersionMigrationListV1Alpha1

StorageVersionMigrationList is a collection of storage version migrations.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeStorageVersionMigrationListV1Alpha1(scope: Construct, id: string, props: KubeStorageVersionMigrationListV1Alpha1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeStorageVersionMigrationListV1Alpha1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeStorageVersionMigrationListV1Alpha1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.storagemigration.v1alpha1.StorageVersionMigrationList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionMigrationListV1Alpha1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionMigrationListV1Alpha1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionMigrationListV1Alpha1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionMigrationListV1Alpha1.manifest(props: KubeStorageVersionMigrationListV1Alpha1Props)

Renders a Kubernetes manifest for “io.k8s.api.storagemigration.v1alpha1.StorageVersionMigrationList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeStorageVersionMigrationListV1Alpha1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.storagemigration.v1alpha1.StorageVersionMigrationList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.storagemigration.v1alpha1.StorageVersionMigrationList”.

---

KubeStorageVersionMigrationV1Alpha1

StorageVersionMigration represents a migration of stored data to the latest storage version.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeStorageVersionMigrationV1Alpha1(scope: Construct, id: string, props?: KubeStorageVersionMigrationV1Alpha1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeStorageVersionMigrationV1Alpha1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeStorageVersionMigrationV1Alpha1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.storagemigration.v1alpha1.StorageVersionMigration”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionMigrationV1Alpha1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionMigrationV1Alpha1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionMigrationV1Alpha1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionMigrationV1Alpha1.manifest(props?: KubeStorageVersionMigrationV1Alpha1Props)

Renders a Kubernetes manifest for “io.k8s.api.storagemigration.v1alpha1.StorageVersionMigration”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeStorageVersionMigrationV1Alpha1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.storagemigration.v1alpha1.StorageVersionMigration”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.storagemigration.v1alpha1.StorageVersionMigration”.

---

KubeStorageVersionV1Alpha1

Storage version of a specific resource.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeStorageVersionV1Alpha1(scope: Construct, id: string, props: KubeStorageVersionV1Alpha1Props)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeStorageVersionV1Alpha1Props	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeStorageVersionV1Alpha1Props

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.apiserverinternal.v1alpha1.StorageVersion”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionV1Alpha1.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionV1Alpha1.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionV1Alpha1.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeStorageVersionV1Alpha1.manifest(props: KubeStorageVersionV1Alpha1Props)

Renders a Kubernetes manifest for “io.k8s.api.apiserverinternal.v1alpha1.StorageVersion”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeStorageVersionV1Alpha1Props

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.apiserverinternal.v1alpha1.StorageVersion”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.apiserverinternal.v1alpha1.StorageVersion”.

---

KubeSubjectAccessReview

SubjectAccessReview checks whether or not a user or group can perform an action.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeSubjectAccessReview(scope: Construct, id: string, props: KubeSubjectAccessReviewProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeSubjectAccessReviewProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeSubjectAccessReviewProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.SubjectAccessReview”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSubjectAccessReview.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSubjectAccessReview.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSubjectAccessReview.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeSubjectAccessReview.manifest(props: KubeSubjectAccessReviewProps)

Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.SubjectAccessReview”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeSubjectAccessReviewProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.authorization.v1.SubjectAccessReview”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.authorization.v1.SubjectAccessReview”.

---

KubeTokenRequest

TokenRequest requests a token for a given service account.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeTokenRequest(scope: Construct, id: string, props: KubeTokenRequestProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeTokenRequestProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeTokenRequestProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.authentication.v1.TokenRequest”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeTokenRequest.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeTokenRequest.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeTokenRequest.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeTokenRequest.manifest(props: KubeTokenRequestProps)

Renders a Kubernetes manifest for “io.k8s.api.authentication.v1.TokenRequest”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeTokenRequestProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.authentication.v1.TokenRequest”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.authentication.v1.TokenRequest”.

---

KubeTokenReview

TokenReview attempts to authenticate a token to a known user.

Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeTokenReview(scope: Construct, id: string, props: KubeTokenReviewProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeTokenReviewProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeTokenReviewProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.authentication.v1.TokenReview”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeTokenReview.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeTokenReview.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeTokenReview.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeTokenReview.manifest(props: KubeTokenReviewProps)

Renders a Kubernetes manifest for “io.k8s.api.authentication.v1.TokenReview”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeTokenReviewProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.authentication.v1.TokenReview”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.authentication.v1.TokenReview”.

---

KubeValidatingAdmissionPolicy

ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeValidatingAdmissionPolicy(scope: Construct, id: string, props?: KubeValidatingAdmissionPolicyProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeValidatingAdmissionPolicyProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeValidatingAdmissionPolicyProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicy”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicy.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicy.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicy.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicy.manifest(props?: KubeValidatingAdmissionPolicyProps)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicy”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeValidatingAdmissionPolicyProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicy”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicy”.

---

KubeValidatingAdmissionPolicyBinding

ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources.

ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters.

For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don’t use params, otherwise N is the number of parameters selected by the binding.

The CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeValidatingAdmissionPolicyBinding(scope: Construct, id: string, props?: KubeValidatingAdmissionPolicyBindingProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeValidatingAdmissionPolicyBindingProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeValidatingAdmissionPolicyBindingProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBinding”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicyBinding.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicyBinding.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicyBinding.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicyBinding.manifest(props?: KubeValidatingAdmissionPolicyBindingProps)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBinding”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeValidatingAdmissionPolicyBindingProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBinding”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBinding”.

---

KubeValidatingAdmissionPolicyBindingList

ValidatingAdmissionPolicyBindingList is a list of ValidatingAdmissionPolicyBinding.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeValidatingAdmissionPolicyBindingList(scope: Construct, id: string, props: KubeValidatingAdmissionPolicyBindingListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeValidatingAdmissionPolicyBindingListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeValidatingAdmissionPolicyBindingListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBindingList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicyBindingList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicyBindingList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicyBindingList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicyBindingList.manifest(props: KubeValidatingAdmissionPolicyBindingListProps)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBindingList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeValidatingAdmissionPolicyBindingListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBindingList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBindingList”.

---

KubeValidatingAdmissionPolicyList

ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeValidatingAdmissionPolicyList(scope: Construct, id: string, props: KubeValidatingAdmissionPolicyListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeValidatingAdmissionPolicyListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeValidatingAdmissionPolicyListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicyList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicyList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicyList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingAdmissionPolicyList.manifest(props: KubeValidatingAdmissionPolicyListProps)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeValidatingAdmissionPolicyListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyList”.

---

KubeValidatingWebhookConfiguration

ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeValidatingWebhookConfiguration(scope: Construct, id: string, props?: KubeValidatingWebhookConfigurationProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeValidatingWebhookConfigurationProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Optional

• Type: cdk8s-plus-34.k8s.KubeValidatingWebhookConfigurationProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingWebhookConfiguration.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingWebhookConfiguration.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingWebhookConfiguration.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingWebhookConfiguration.manifest(props?: KubeValidatingWebhookConfigurationProps)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Optional

• Type: cdk8s-plus-34.k8s.KubeValidatingWebhookConfigurationProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration”.

---

KubeValidatingWebhookConfigurationList

ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeValidatingWebhookConfigurationList(scope: Construct, id: string, props: KubeValidatingWebhookConfigurationListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeValidatingWebhookConfigurationListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeValidatingWebhookConfigurationListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingWebhookConfigurationList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingWebhookConfigurationList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingWebhookConfigurationList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeValidatingWebhookConfigurationList.manifest(props: KubeValidatingWebhookConfigurationListProps)

Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeValidatingWebhookConfigurationListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList”.

---

KubeVolumeAttachment

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

VolumeAttachment objects are non-namespaced.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeVolumeAttachment(scope: Construct, id: string, props: KubeVolumeAttachmentProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeVolumeAttachmentProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeVolumeAttachmentProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.storage.v1.VolumeAttachment”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeVolumeAttachment.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeVolumeAttachment.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeVolumeAttachment.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeVolumeAttachment.manifest(props: KubeVolumeAttachmentProps)

Renders a Kubernetes manifest for “io.k8s.api.storage.v1.VolumeAttachment”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeVolumeAttachmentProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.storage.v1.VolumeAttachment”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.storage.v1.VolumeAttachment”.

---

KubeVolumeAttachmentList

VolumeAttachmentList is a collection of VolumeAttachment objects.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeVolumeAttachmentList(scope: Construct, id: string, props: KubeVolumeAttachmentListProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeVolumeAttachmentListProps	initialization props.

---

scope^Required

• Type: constructs.Construct

the scope in which to define this object.

---

id^Required

• Type: string

a scope-local name for the object.

---

props^Required

• Type: cdk8s-plus-34.k8s.KubeVolumeAttachmentListProps

initialization props.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addDependency	Create a dependency between this ApiObject and other constructs.
addJsonPatch	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
toJson	Renders the object to Kubernetes JSON.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addDependency

public addDependency(dependencies: ...IConstruct[]): void

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

dependencies^Required

• Type: …constructs.IConstruct[]

the dependencies to add.

---

addJsonPatch

public addJsonPatch(ops: ...JsonPatch[]): void

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example

  kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));

ops^Required

• Type: …cdk8s.JsonPatch[]

The JSON-Patch operations to apply.

---

toJson

public toJson(): any

Renders the object to Kubernetes JSON.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApiObject	Return whether the given object is an ApiObject.
of	Returns the ApiObject named Resource which is a child of the given construct.
manifest	Renders a Kubernetes manifest for “io.k8s.api.storage.v1.VolumeAttachmentList”.

---

isConstruct

import { k8s } from 'cdk8s-plus-34'

k8s.KubeVolumeAttachmentList.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.

---

isApiObject

import { k8s } from 'cdk8s-plus-34'

k8s.KubeVolumeAttachmentList.isApiObject(o: any)

Return whether the given object is an ApiObject.

We do attribute detection since we can’t reliably use ‘instanceof’.

o^Required

• Type: any

The object to check.

---

of

import { k8s } from 'cdk8s-plus-34'

k8s.KubeVolumeAttachmentList.of(c: IConstruct)

Returns the ApiObject named Resource which is a child of the given construct.

If c is an ApiObject, it is returned directly. Throws an exception if the construct does not have a child named Default or if this child is not an ApiObject.

c^Required

• Type: constructs.IConstruct

The higher-level construct.

---

manifest

import { k8s } from 'cdk8s-plus-34'

k8s.KubeVolumeAttachmentList.manifest(props: KubeVolumeAttachmentListProps)

Renders a Kubernetes manifest for “io.k8s.api.storage.v1.VolumeAttachmentList”.

This can be used to inline resource manifests inside other objects (e.g. as templates).

props^Required

• Type: cdk8s-plus-34.k8s.KubeVolumeAttachmentListProps

initialization props.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
apiGroup	string	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	string	The object’s API version (e.g. authorization.k8s.io/v1).
chart	cdk8s.Chart	The chart in which this object is defined.
kind	string	The object kind.
metadata	cdk8s.ApiObjectMetadataDefinition	Metadata associated with this API object.
name	string	The name of the API object.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

apiGroup^Required

public readonly apiGroup: string;

• Type: string

The group portion of the API version (e.g. authorization.k8s.io).

---

apiVersion^Required

public readonly apiVersion: string;

• Type: string

The object’s API version (e.g. authorization.k8s.io/v1).

---

chart^Required

public readonly chart: Chart;

• Type: cdk8s.Chart

The chart in which this object is defined.

---

kind^Required

public readonly kind: string;

• Type: string

The object kind.

---

metadata^Required

public readonly metadata: ApiObjectMetadataDefinition;

• Type: cdk8s.ApiObjectMetadataDefinition

Metadata associated with this API object.

---

name^Required

public readonly name: string;

• Type: string

The name of the API object.

If a name is specified in metadata.name this will be the name returned. Otherwise, a name will be generated by calling Chart.of(this).generatedObjectName(this), which by default uses the construct path to generate a DNS-compatible name for the resource.

---

Constants

Name	Type	Description
GVK	cdk8s.GroupVersionKind	Returns the apiVersion and kind for “io.k8s.api.storage.v1.VolumeAttachmentList”.

---

GVK^Required

public readonly GVK: GroupVersionKind;

• Type: cdk8s.GroupVersionKind

Returns the apiVersion and kind for “io.k8s.api.storage.v1.VolumeAttachmentList”.

---

KubeVolumeAttributesClass

VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver.

The class can be specified during dynamic provisioning of PersistentVolumeClaims, and changed in the PersistentVolumeClaim spec after provisioning.

Initializers

import { k8s } from 'cdk8s-plus-34'

new k8s.KubeVolumeAttributesClass(scope: Construct, id: string, props: KubeVolumeAttributesClassProps)

Name	Type	Description
scope	constructs.Construct	the scope in which to define this object.
id	string	a scope-local name for the object.
props	cdk8s-plus-34.k8s.KubeVolumeAttributesClassProps	initialization props.

---

scope^Required

• Type: constru