# API Reference ## Constructs ### AbstractPod - *Implements:* IPodSelector, INetworkPolicyPeer, ISubject #### Initializers ```typescript import { AbstractPod } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addContainer` ```typescript public addContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```typescript public addHostAlias(hostAlias: HostAlias): void ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```typescript public addInitContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```typescript public addVolume(vol: Volume): void ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```typescript public attachContainer(cont: Container): void ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig(): PodSelectorConfig ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```typescript public toSubjectConfiguration(): SubjectConfiguration ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { AbstractPod } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean --- ##### `containers`^Required ```typescript public readonly containers: Container[]; ``` - *Type:* Container[] --- ##### `dns`^Required ```typescript public readonly dns: PodDns; ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] --- ##### `initContainers`^Required ```typescript public readonly initContainers: Container[]; ``` - *Type:* Container[] --- ##### `podMetadata`^Required ```typescript public readonly podMetadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `securityContext`^Required ```typescript public readonly securityContext: PodSecurityContext; ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean --- ##### `volumes`^Required ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```typescript 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](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore) #### Initializers ```typescript import { AwsElasticBlockStorePersistentVolume } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `asVolume` ```typescript public asVolume(): Volume ``` Convert the piece of storage into a concrete volume. ##### `bind` ```typescript 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](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding) ###### `claim`^Required - *Type:* IPersistentVolumeClaim The PVC to bind to. --- ##### `reserve` ```typescript 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](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` ```typescript import { AwsElasticBlockStorePersistentVolume } from 'cdk8s-plus-32' 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` ```typescript import { AwsElasticBlockStorePersistentVolume } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly mode: PersistentVolumeMode; ``` - *Type:* PersistentVolumeMode Volume mode of this volume. --- ##### `reclaimPolicy`^Required ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* PersistentVolumeReclaimPolicy Reclaim policy of this volume. --- ##### `accessModes`^Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* PersistentVolumeAccessMode[] Access modes requirement of this claim. --- ##### `claim`^Optional ```typescript 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 ```typescript public readonly mountOptions: string[]; ``` - *Type:* string[] Mount options of this volume. --- ##### `storage`^Optional ```typescript public readonly storage: Size; ``` - *Type:* cdk8s.Size Storage size of this volume. --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string Storage class this volume belongs to. --- ##### `fsType`^Required ```typescript public readonly fsType: string; ``` - *Type:* string File system type of this volume. --- ##### `readOnly`^Required ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean Whether or not it is mounted as a read-only volume. --- ##### `volumeId`^Required ```typescript public readonly volumeId: string; ``` - *Type:* string Volume id of this volume. --- ##### `partition`^Optional ```typescript 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 ```typescript import { AzureDiskPersistentVolume } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `asVolume` ```typescript public asVolume(): Volume ``` Convert the piece of storage into a concrete volume. ##### `bind` ```typescript 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](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding) ###### `claim`^Required - *Type:* IPersistentVolumeClaim The PVC to bind to. --- ##### `reserve` ```typescript 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](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` ```typescript import { AzureDiskPersistentVolume } from 'cdk8s-plus-32' 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` ```typescript import { AzureDiskPersistentVolume } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly mode: PersistentVolumeMode; ``` - *Type:* PersistentVolumeMode Volume mode of this volume. --- ##### `reclaimPolicy`^Required ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* PersistentVolumeReclaimPolicy Reclaim policy of this volume. --- ##### `accessModes`^Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* PersistentVolumeAccessMode[] Access modes requirement of this claim. --- ##### `claim`^Optional ```typescript 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 ```typescript public readonly mountOptions: string[]; ``` - *Type:* string[] Mount options of this volume. --- ##### `storage`^Optional ```typescript public readonly storage: Size; ``` - *Type:* cdk8s.Size Storage size of this volume. --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string Storage class this volume belongs to. --- ##### `azureKind`^Required ```typescript public readonly azureKind: AzureDiskPersistentVolumeKind; ``` - *Type:* AzureDiskPersistentVolumeKind Azure kind of this volume. --- ##### `cachingMode`^Required ```typescript public readonly cachingMode: AzureDiskPersistentVolumeCachingMode; ``` - *Type:* AzureDiskPersistentVolumeCachingMode Caching mode of this volume. --- ##### `diskName`^Required ```typescript public readonly diskName: string; ``` - *Type:* string Disk name of this volume. --- ##### `diskUri`^Required ```typescript public readonly diskUri: string; ``` - *Type:* string Disk URI of this volume. --- ##### `fsType`^Required ```typescript public readonly fsType: string; ``` - *Type:* string File system type of this volume. --- ##### `readOnly`^Required ```typescript 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](https://kubernetes.io/docs/concepts/configuration/secret/#basic-authentication-secret) #### Initializers ```typescript import { BasicAuthSecret } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addStringData` ```typescript 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` ```typescript public envValue(key: string, options?: EnvValueFromSecretOptions): EnvValue ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* string --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions --- ##### `getStringData` ```typescript 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` ```typescript import { BasicAuthSecret } from 'cdk8s-plus-32' 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` ```typescript import { BasicAuthSecret } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript 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 ```typescript import { ClusterRole } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `aggregate` ```typescript public aggregate(key: string, value: string): void ``` Aggregate rules from roles matching this label selector. ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* string --- ##### `allow` ```typescript 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](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` ```typescript public allowCreate(endpoints: ...IApiEndpoint[]): void ``` Add "create" permission for the resources. ###### `endpoints`^Required - *Type:* ...IApiEndpoint[] The resource(s) to apply to. --- ##### `allowDelete` ```typescript public allowDelete(endpoints: ...IApiEndpoint[]): void ``` Add "delete" permission for the resources. ###### `endpoints`^Required - *Type:* ...IApiEndpoint[] The resource(s) to apply to. --- ##### `allowDeleteCollection` ```typescript public allowDeleteCollection(endpoints: ...IApiEndpoint[]): void ``` Add "deletecollection" permission for the resources. ###### `endpoints`^Required - *Type:* ...IApiEndpoint[] The resource(s) to apply to. --- ##### `allowGet` ```typescript public allowGet(endpoints: ...IApiEndpoint[]): void ``` Add "get" permission for the resources. ###### `endpoints`^Required - *Type:* ...IApiEndpoint[] The resource(s) to apply to. --- ##### `allowList` ```typescript public allowList(endpoints: ...IApiEndpoint[]): void ``` Add "list" permission for the resources. ###### `endpoints`^Required - *Type:* ...IApiEndpoint[] The resource(s) to apply to. --- ##### `allowPatch` ```typescript public allowPatch(endpoints: ...IApiEndpoint[]): void ``` Add "patch" permission for the resources. ###### `endpoints`^Required - *Type:* ...IApiEndpoint[] The resource(s) to apply to. --- ##### `allowRead` ```typescript 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` ```typescript 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` ```typescript public allowUpdate(endpoints: ...IApiEndpoint[]): void ``` Add "update" permission for the resources. ###### `endpoints`^Required - *Type:* ...IApiEndpoint[] The resource(s) to apply to. --- ##### `allowWatch` ```typescript public allowWatch(endpoints: ...IApiEndpoint[]): void ``` Add "watch" permission for the resources. ###### `endpoints`^Required - *Type:* ...IApiEndpoint[] The resource(s) to apply to. --- ##### `bind` ```typescript 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` ```typescript 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` ```typescript 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` ```typescript import { ClusterRole } from 'cdk8s-plus-32' 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` ```typescript import { ClusterRole } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript 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 ```typescript import { ClusterRoleBinding } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addSubjects` ```typescript 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` ```typescript import { ClusterRoleBinding } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly role: IClusterRole; ``` - *Type:* IClusterRole --- ##### `subjects`^Required ```typescript public readonly subjects: ISubject[]; ``` - *Type:* ISubject[] --- ### ConfigMap - *Implements:* IConfigMap ConfigMap holds configuration data for pods to consume. #### Initializers ```typescript import { ConfigMap } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addBinaryData` ```typescript 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` ```typescript 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` ```typescript 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` ```typescript 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` ```typescript import { ConfigMap } from 'cdk8s-plus-32' 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` ```typescript import { ConfigMap } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript 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 ```typescript 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 ```typescript 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 ```typescript import { CronJob } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addContainer` ```typescript public addContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```typescript public addHostAlias(hostAlias: HostAlias): void ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```typescript public addInitContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```typescript public addVolume(vol: Volume): void ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```typescript public attachContainer(cont: Container): void ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig(): PodSelectorConfig ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```typescript public toSubjectConfiguration(): SubjectConfiguration ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) ##### `select` ```typescript 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` ```typescript import { CronJob } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string Represents the resource type. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean --- ##### `containers`^Required ```typescript public readonly containers: Container[]; ``` - *Type:* Container[] --- ##### `dns`^Required ```typescript public readonly dns: PodDns; ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] --- ##### `initContainers`^Required ```typescript public readonly initContainers: Container[]; ``` - *Type:* Container[] --- ##### `podMetadata`^Required ```typescript public readonly podMetadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition The metadata of pods in this workload. --- ##### `securityContext`^Required ```typescript public readonly securityContext: PodSecurityContext; ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean --- ##### `volumes`^Required ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration --- ##### `connections`^Required ```typescript public readonly connections: PodConnections; ``` - *Type:* PodConnections --- ##### `matchExpressions`^Required ```typescript 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 ```typescript 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 ```typescript public readonly scheduling: WorkloadScheduling; ``` - *Type:* WorkloadScheduling --- ##### `concurrencyPolicy`^Required ```typescript 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 ```typescript public readonly failedJobsRetained: number; ``` - *Type:* number The number of failed jobs retained by this cron job. --- ##### `schedule`^Required ```typescript public readonly schedule: Cron; ``` - *Type:* cdk8s.Cron The schedule this cron job is scheduled to run in. --- ##### `startingDeadline`^Required ```typescript 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 ```typescript public readonly successfulJobsRetained: number; ``` - *Type:* number The number of successful jobs retained by this cron job. --- ##### `suspend`^Required ```typescript public readonly suspend: boolean; ``` - *Type:* boolean Whether or not the cron job is currently suspended or not. --- ##### `timeZone`^Optional ```typescript 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 ```typescript import { DaemonSet } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addContainer` ```typescript public addContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```typescript public addHostAlias(hostAlias: HostAlias): void ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```typescript public addInitContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```typescript public addVolume(vol: Volume): void ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```typescript public attachContainer(cont: Container): void ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig(): PodSelectorConfig ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```typescript public toSubjectConfiguration(): SubjectConfiguration ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) ##### `select` ```typescript 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` ```typescript import { DaemonSet } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean --- ##### `containers`^Required ```typescript public readonly containers: Container[]; ``` - *Type:* Container[] --- ##### `dns`^Required ```typescript public readonly dns: PodDns; ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] --- ##### `initContainers`^Required ```typescript public readonly initContainers: Container[]; ``` - *Type:* Container[] --- ##### `podMetadata`^Required ```typescript public readonly podMetadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition The metadata of pods in this workload. --- ##### `securityContext`^Required ```typescript public readonly securityContext: PodSecurityContext; ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean --- ##### `volumes`^Required ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration --- ##### `connections`^Required ```typescript public readonly connections: PodConnections; ``` - *Type:* PodConnections --- ##### `matchExpressions`^Required ```typescript 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 ```typescript 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 ```typescript public readonly scheduling: WorkloadScheduling; ``` - *Type:* WorkloadScheduling --- ##### `minReadySeconds`^Required ```typescript 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 ```typescript import { Deployment } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addContainer` ```typescript public addContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```typescript public addHostAlias(hostAlias: HostAlias): void ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```typescript public addInitContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```typescript public addVolume(vol: Volume): void ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```typescript public attachContainer(cont: Container): void ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig(): PodSelectorConfig ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```typescript public toSubjectConfiguration(): SubjectConfiguration ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) ##### `select` ```typescript public select(selectors: ...LabelSelector[]): void ``` Configure selectors for this workload. ###### `selectors`^Required - *Type:* ...LabelSelector[] --- ##### `exposeViaIngress` ```typescript 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` ```typescript public exposeViaService(options?: DeploymentExposeViaServiceOptions): Service ``` Expose a deployment via a service. This is equivalent to running `kubectl expose deployment `. ###### `options`^Optional - *Type:* DeploymentExposeViaServiceOptions Options to determine details of the service and port exposed. --- ##### `markHasAutoscaler` ```typescript public markHasAutoscaler(): void ``` Called on all IScalable targets when they are associated with an autoscaler. > [IScalable.markHasAutoscaler ()](IScalable.markHasAutoscaler ()) ##### `toScalingTarget` ```typescript public toScalingTarget(): ScalingTarget ``` Return the target spec properties of this Scalable. > [IScalable.toScalingTarget ()](IScalable.toScalingTarget ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { Deployment } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean --- ##### `containers`^Required ```typescript public readonly containers: Container[]; ``` - *Type:* Container[] --- ##### `dns`^Required ```typescript public readonly dns: PodDns; ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] --- ##### `initContainers`^Required ```typescript public readonly initContainers: Container[]; ``` - *Type:* Container[] --- ##### `podMetadata`^Required ```typescript public readonly podMetadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition The metadata of pods in this workload. --- ##### `securityContext`^Required ```typescript public readonly securityContext: PodSecurityContext; ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean --- ##### `volumes`^Required ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration --- ##### `connections`^Required ```typescript public readonly connections: PodConnections; ``` - *Type:* PodConnections --- ##### `matchExpressions`^Required ```typescript 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 ```typescript 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 ```typescript public readonly scheduling: WorkloadScheduling; ``` - *Type:* WorkloadScheduling --- ##### `minReady`^Required ```typescript 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 ```typescript 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 ```typescript public readonly revisionHistoryLimit: number; ``` - *Type:* number - *Default:* 10 Number of desired replicasets history. --- ##### `strategy`^Required ```typescript public readonly strategy: DeploymentStrategy; ``` - *Type:* DeploymentStrategy --- ##### `replicas`^Optional ```typescript public readonly replicas: number; ``` - *Type:* number Number of desired pods. --- ##### `hasAutoscaler`^Required ```typescript 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](https://kubernetes.io/docs/concepts/configuration/secret/#docker-config-secrets) #### Initializers ```typescript import { DockerConfigSecret } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addStringData` ```typescript 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` ```typescript public envValue(key: string, options?: EnvValueFromSecretOptions): EnvValue ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* string --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions --- ##### `getStringData` ```typescript 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` ```typescript import { DockerConfigSecret } from 'cdk8s-plus-32' 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` ```typescript import { DockerConfigSecret } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript 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](https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk) #### Initializers ```typescript import { GCEPersistentDiskPersistentVolume } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `asVolume` ```typescript public asVolume(): Volume ``` Convert the piece of storage into a concrete volume. ##### `bind` ```typescript 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](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding) ###### `claim`^Required - *Type:* IPersistentVolumeClaim The PVC to bind to. --- ##### `reserve` ```typescript 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](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` ```typescript import { GCEPersistentDiskPersistentVolume } from 'cdk8s-plus-32' 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` ```typescript import { GCEPersistentDiskPersistentVolume } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly mode: PersistentVolumeMode; ``` - *Type:* PersistentVolumeMode Volume mode of this volume. --- ##### `reclaimPolicy`^Required ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* PersistentVolumeReclaimPolicy Reclaim policy of this volume. --- ##### `accessModes`^Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* PersistentVolumeAccessMode[] Access modes requirement of this claim. --- ##### `claim`^Optional ```typescript 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 ```typescript public readonly mountOptions: string[]; ``` - *Type:* string[] Mount options of this volume. --- ##### `storage`^Optional ```typescript public readonly storage: Size; ``` - *Type:* cdk8s.Size Storage size of this volume. --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string Storage class this volume belongs to. --- ##### `fsType`^Required ```typescript public readonly fsType: string; ``` - *Type:* string File system type of this volume. --- ##### `pdName`^Required ```typescript public readonly pdName: string; ``` - *Type:* string PD resource in GCE of this volume. --- ##### `readOnly`^Required ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean Whether or not it is mounted as a read-only volume. --- ##### `partition`^Optional ```typescript 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public toSubjectConfiguration(): SubjectConfiguration ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromName | Reference a group by name. | --- ##### `isConstruct` ```typescript import { Group } from 'cdk8s-plus-32' 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` ```typescript import { Group } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `apiGroup`^Optional ```typescript 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](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#implicit-maintenance-mode-deactivation) *Example* ```typescript 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 ```typescript import { HorizontalPodAutoscaler } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { HorizontalPodAutoscaler } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly maxReplicas: number; ``` - *Type:* number The maximum number of replicas that can be scaled up to. --- ##### `minReplicas`^Required ```typescript public readonly minReplicas: number; ``` - *Type:* number The minimum number of replicas that can be scaled down to. --- ##### `scaleDown`^Required ```typescript public readonly scaleDown: ScalingRules; ``` - *Type:* ScalingRules The scaling behavior when scaling down. --- ##### `scaleUp`^Required ```typescript public readonly scaleUp: ScalingRules; ``` - *Type:* ScalingRules The scaling behavior when scaling up. --- ##### `target`^Required ```typescript public readonly target: IScalable; ``` - *Type:* IScalable The workload to scale up or down. --- ##### `metrics`^Optional ```typescript 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 ```typescript import { Ingress } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addDefaultBackend` ```typescript 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` ```typescript 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` ```typescript 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` ```typescript 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` ```typescript public addRules(rules: ...IngressRule[]): void ``` Adds rules to this ingress. ###### `rules`^Required - *Type:* ...IngressRule[] The rules to add. --- ##### `addTls` ```typescript public addTls(tls: IngressTls[]): void ``` ###### `tls`^Required - *Type:* IngressTls[] --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { Ingress } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript import { Job } from 'cdk8s-plus-32' 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addContainer` ```typescript public addContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```typescript public addHostAlias(hostAlias: HostAlias): void ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```typescript public addInitContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```typescript public addVolume(vol: Volume): void ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```typescript public attachContainer(cont: Container): void ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig(): PodSelectorConfig ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```typescript public toSubjectConfiguration(): SubjectConfiguration ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) ##### `select` ```typescript 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` ```typescript import { Job } from 'cdk8s-plus-32' 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean --- ##### `containers`^Required ```typescript public readonly containers: Container[]; ``` - *Type:* Container[] --- ##### `dns`^Required ```typescript public readonly dns: PodDns; ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] --- ##### `initContainers`^Required ```typescript public readonly initContainers: Container[]; ``` - *Type:* Container[] --- ##### `podMetadata`^Required ```typescript public readonly podMetadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition The metadata of pods in this workload. --- ##### `securityContext`^Required ```typescript public readonly securityContext: PodSecurityContext; ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean --- ##### `volumes`^Required ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration --- ##### `connections`^Required ```typescript public readonly connections: PodConnections; ``` - *Type:* PodConnections --- ##### `matchExpressions`^Required ```typescript 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 ```typescript 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 ```typescript public readonly scheduling: WorkloadScheduling; ``` - *Type:* WorkloadScheduling --- ##### `activeDeadline`^Optional ```typescript public readonly activeDeadline: Duration; ``` - *Type:* cdk8s.Duration Duration before job is terminated. If undefined, there is no deadline. --- ##### `backoffLimit`^Optional ```typescript public readonly backoffLimit: number; ``` - *Type:* number Number of retries before marking failed. --- ##### `ttlAfterFinished`^Optional ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.certificates.v1alpha1.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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.certificates.v1alpha1.ClusterTrustBundle". --- ### KubeComponentStatus ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+ #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.apps.v1.DeploymentList". --- ### KubeDeviceClassListV1Alpha3 DeviceClassList is a collection of classes. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeDeviceClassListV1Alpha3(scope: Construct, id: string, props: KubeDeviceClassListV1Alpha3Props) ``` | **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-32.k8s.KubeDeviceClassListV1Alpha3Props | 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-32.k8s.KubeDeviceClassListV1Alpha3Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.DeviceClassList". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeDeviceClassListV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeDeviceClassListV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeDeviceClassListV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeDeviceClassListV1Alpha3.manifest(props: KubeDeviceClassListV1Alpha3Props) ``` Renders a Kubernetes manifest for "io.k8s.api.resource.v1alpha3.DeviceClassList". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeDeviceClassListV1Alpha3Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.DeviceClassList". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.DeviceClassList". --- ### KubeDeviceClassListV1Beta1 DeviceClassList is a collection of classes. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.DeviceClassList". --- ### KubeDeviceClassV1Alpha3 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 ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeDeviceClassV1Alpha3(scope: Construct, id: string, props: KubeDeviceClassV1Alpha3Props) ``` | **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-32.k8s.KubeDeviceClassV1Alpha3Props | 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-32.k8s.KubeDeviceClassV1Alpha3Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.DeviceClass". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeDeviceClassV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeDeviceClassV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeDeviceClassV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeDeviceClassV1Alpha3.manifest(props: KubeDeviceClassV1Alpha3Props) ``` Renders a Kubernetes manifest for "io.k8s.api.resource.v1alpha3.DeviceClass". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeDeviceClassV1Alpha3Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.DeviceClass". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.DeviceClass". --- ### 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.DeviceClass". --- ### 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}] }, ] #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.Endpoints". --- ### KubeEndpointSlice EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressList". --- ### KubeIpAddressListV1Beta1 IPAddressList contains a list of IPAddress. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.coordination.v1alpha2.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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.coordination.v1alpha2.LeaseCandidate". --- ### KubeLeaseList LeaseList is a list of Lease objects. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1alpha1.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](https://kubernetes.io/docs/reference/using-api/cel/#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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBinding". --- ### KubeMutatingAdmissionPolicyListV1Alpha1 MutatingAdmissionPolicyList is a list of MutatingAdmissionPolicy. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyList". --- ### KubeMutatingAdmissionPolicyV1Alpha1 MutatingAdmissionPolicy describes the definition of an admission mutation policy that mutates the object coming into admission chain. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicy". --- ### KubeMutatingWebhookConfiguration MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.Pod". --- ### KubePodDisruptionBudget PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.ReplicationControllerList". --- ### KubeResourceClaimListV1Alpha3 ResourceClaimList is a collection of claims. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeResourceClaimListV1Alpha3(scope: Construct, id: string, props: KubeResourceClaimListV1Alpha3Props) ``` | **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-32.k8s.KubeResourceClaimListV1Alpha3Props | 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-32.k8s.KubeResourceClaimListV1Alpha3Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.ResourceClaimList". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimListV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimListV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimListV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimListV1Alpha3.manifest(props: KubeResourceClaimListV1Alpha3Props) ``` Renders a Kubernetes manifest for "io.k8s.api.resource.v1alpha3.ResourceClaimList". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeResourceClaimListV1Alpha3Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.ResourceClaimList". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceClaimList". --- ### KubeResourceClaimListV1Beta1 ResourceClaimList is a collection of claims. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceClaimList". --- ### KubeResourceClaimTemplateListV1Alpha3 ResourceClaimTemplateList is a collection of claim templates. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeResourceClaimTemplateListV1Alpha3(scope: Construct, id: string, props: KubeResourceClaimTemplateListV1Alpha3Props) ``` | **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-32.k8s.KubeResourceClaimTemplateListV1Alpha3Props | 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-32.k8s.KubeResourceClaimTemplateListV1Alpha3Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.ResourceClaimTemplateList". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimTemplateListV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimTemplateListV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimTemplateListV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimTemplateListV1Alpha3.manifest(props: KubeResourceClaimTemplateListV1Alpha3Props) ``` Renders a Kubernetes manifest for "io.k8s.api.resource.v1alpha3.ResourceClaimTemplateList". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeResourceClaimTemplateListV1Alpha3Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.ResourceClaimTemplateList". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceClaimTemplateList". --- ### KubeResourceClaimTemplateListV1Beta1 ResourceClaimTemplateList is a collection of claim templates. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceClaimTemplateList". --- ### KubeResourceClaimTemplateV1Alpha3 ResourceClaimTemplate is used to produce ResourceClaim objects. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeResourceClaimTemplateV1Alpha3(scope: Construct, id: string, props: KubeResourceClaimTemplateV1Alpha3Props) ``` | **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-32.k8s.KubeResourceClaimTemplateV1Alpha3Props | 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-32.k8s.KubeResourceClaimTemplateV1Alpha3Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.ResourceClaimTemplate". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimTemplateV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimTemplateV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimTemplateV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimTemplateV1Alpha3.manifest(props: KubeResourceClaimTemplateV1Alpha3Props) ``` Renders a Kubernetes manifest for "io.k8s.api.resource.v1alpha3.ResourceClaimTemplate". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeResourceClaimTemplateV1Alpha3Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.ResourceClaimTemplate". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceClaimTemplate". --- ### KubeResourceClaimTemplateV1Beta1 ResourceClaimTemplate is used to produce ResourceClaim objects. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceClaimTemplate". --- ### KubeResourceClaimV1Alpha3 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 ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeResourceClaimV1Alpha3(scope: Construct, id: string, props: KubeResourceClaimV1Alpha3Props) ``` | **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-32.k8s.KubeResourceClaimV1Alpha3Props | 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-32.k8s.KubeResourceClaimV1Alpha3Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.ResourceClaim". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceClaimV1Alpha3.manifest(props: KubeResourceClaimV1Alpha3Props) ``` Renders a Kubernetes manifest for "io.k8s.api.resource.v1alpha3.ResourceClaim". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeResourceClaimV1Alpha3Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.ResourceClaim". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceClaim". --- ### 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceClaim". --- ### KubeResourceQuota ResourceQuota sets aggregate quota restrictions enforced per namespace. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.ResourceQuotaList". --- ### KubeResourceSliceListV1Alpha3 ResourceSliceList is a collection of ResourceSlices. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeResourceSliceListV1Alpha3(scope: Construct, id: string, props: KubeResourceSliceListV1Alpha3Props) ``` | **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-32.k8s.KubeResourceSliceListV1Alpha3Props | 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-32.k8s.KubeResourceSliceListV1Alpha3Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.ResourceSliceList". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceSliceListV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceSliceListV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceSliceListV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceSliceListV1Alpha3.manifest(props: KubeResourceSliceListV1Alpha3Props) ``` Renders a Kubernetes manifest for "io.k8s.api.resource.v1alpha3.ResourceSliceList". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeResourceSliceListV1Alpha3Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.ResourceSliceList". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceSliceList". --- ### KubeResourceSliceListV1Beta1 ResourceSliceList is a collection of ResourceSlices. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceSliceList". --- ### KubeResourceSliceV1Alpha3 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 ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeResourceSliceV1Alpha3(scope: Construct, id: string, props: KubeResourceSliceV1Alpha3Props) ``` | **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-32.k8s.KubeResourceSliceV1Alpha3Props | 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-32.k8s.KubeResourceSliceV1Alpha3Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.ResourceSlice". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceSliceV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceSliceV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceSliceV1Alpha3.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeResourceSliceV1Alpha3.manifest(props: KubeResourceSliceV1Alpha3Props) ``` Renders a Kubernetes manifest for "io.k8s.api.resource.v1alpha3.ResourceSlice". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeResourceSliceV1Alpha3Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.ResourceSlice". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceSlice". --- ### 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceSlice". --- ### KubeRole Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.authentication.v1.SelfSubjectReview". --- ### KubeSelfSubjectReviewV1Beta1 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 ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeSelfSubjectReviewV1Beta1(scope: Construct, id: string, props?: KubeSelfSubjectReviewV1Beta1Props) ``` | **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-32.k8s.KubeSelfSubjectReviewV1Beta1Props | 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-32.k8s.KubeSelfSubjectReviewV1Beta1Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.v1beta1.SelfSubjectReview". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeSelfSubjectReviewV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeSelfSubjectReviewV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeSelfSubjectReviewV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeSelfSubjectReviewV1Beta1.manifest(props?: KubeSelfSubjectReviewV1Beta1Props) ``` Renders a Kubernetes manifest for "io.k8s.api.authentication.v1beta1.SelfSubjectReview". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Optional - *Type:* cdk8s-plus-32.k8s.KubeSelfSubjectReviewV1Beta1Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.v1beta1.SelfSubjectReview". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.authentication.v1beta1.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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceAccountList". --- ### KubeServiceCidrListV1Beta1 ServiceCIDRList contains a list of ServiceCIDR objects. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBindingList". --- ### KubeValidatingAdmissionPolicyBindingListV1Beta1 ValidatingAdmissionPolicyBindingList is a list of ValidatingAdmissionPolicyBinding. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1(scope: Construct, id: string, props: KubeValidatingAdmissionPolicyBindingListV1Beta1Props) ``` | **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-32.k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1Props | 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-32.k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.ValidatingAdmissionPolicyBindingList". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1.manifest(props: KubeValidatingAdmissionPolicyBindingListV1Beta1Props) ``` Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyBindingList". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.ValidatingAdmissionPolicyBindingList". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyBindingList". --- ### KubeValidatingAdmissionPolicyBindingV1Beta1 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 ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeValidatingAdmissionPolicyBindingV1Beta1(scope: Construct, id: string, props?: KubeValidatingAdmissionPolicyBindingV1Beta1Props) ``` | **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-32.k8s.KubeValidatingAdmissionPolicyBindingV1Beta1Props | 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-32.k8s.KubeValidatingAdmissionPolicyBindingV1Beta1Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.ValidatingAdmissionPolicyBinding". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyBindingV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyBindingV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyBindingV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyBindingV1Beta1.manifest(props?: KubeValidatingAdmissionPolicyBindingV1Beta1Props) ``` Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyBinding". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Optional - *Type:* cdk8s-plus-32.k8s.KubeValidatingAdmissionPolicyBindingV1Beta1Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.ValidatingAdmissionPolicyBinding". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyBinding". --- ### KubeValidatingAdmissionPolicyList ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyList". --- ### KubeValidatingAdmissionPolicyListV1Beta1 ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeValidatingAdmissionPolicyListV1Beta1(scope: Construct, id: string, props: KubeValidatingAdmissionPolicyListV1Beta1Props) ``` | **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-32.k8s.KubeValidatingAdmissionPolicyListV1Beta1Props | 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-32.k8s.KubeValidatingAdmissionPolicyListV1Beta1Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.ValidatingAdmissionPolicyList". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyListV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyListV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyListV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyListV1Beta1.manifest(props: KubeValidatingAdmissionPolicyListV1Beta1Props) ``` Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyList". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeValidatingAdmissionPolicyListV1Beta1Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.ValidatingAdmissionPolicyList". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyList". --- ### KubeValidatingAdmissionPolicyV1Beta1 ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeValidatingAdmissionPolicyV1Beta1(scope: Construct, id: string, props?: KubeValidatingAdmissionPolicyV1Beta1Props) ``` | **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-32.k8s.KubeValidatingAdmissionPolicyV1Beta1Props | 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-32.k8s.KubeValidatingAdmissionPolicyV1Beta1Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.ValidatingAdmissionPolicy". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeValidatingAdmissionPolicyV1Beta1.manifest(props?: KubeValidatingAdmissionPolicyV1Beta1Props) ``` Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicy". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Optional - *Type:* cdk8s-plus-32.k8s.KubeValidatingAdmissionPolicyV1Beta1Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.ValidatingAdmissionPolicy". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicy". --- ### KubeValidatingWebhookConfiguration ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript 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 ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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-32.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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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` ```typescript import { k8s } from 'cdk8s-plus-32' 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-32.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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 ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1.VolumeAttachmentList". --- ### KubeVolumeAttributesClassListV1Alpha1 VolumeAttributesClassList is a collection of VolumeAttributesClass objects. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeVolumeAttributesClassListV1Alpha1(scope: Construct, id: string, props: KubeVolumeAttributesClassListV1Alpha1Props) ``` | **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-32.k8s.KubeVolumeAttributesClassListV1Alpha1Props | 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-32.k8s.KubeVolumeAttributesClassListV1Alpha1Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.v1alpha1.VolumeAttributesClassList". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassListV1Alpha1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassListV1Alpha1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassListV1Alpha1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassListV1Alpha1.manifest(props: KubeVolumeAttributesClassListV1Alpha1Props) ``` Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.VolumeAttributesClassList". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeVolumeAttributesClassListV1Alpha1Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.v1alpha1.VolumeAttributesClassList". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.VolumeAttributesClassList". --- ### KubeVolumeAttributesClassListV1Beta1 VolumeAttributesClassList is a collection of VolumeAttributesClass objects. #### Initializers ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeVolumeAttributesClassListV1Beta1(scope: Construct, id: string, props: KubeVolumeAttributesClassListV1Beta1Props) ``` | **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-32.k8s.KubeVolumeAttributesClassListV1Beta1Props | 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-32.k8s.KubeVolumeAttributesClassListV1Beta1Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.v1beta1.VolumeAttributesClassList". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassListV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassListV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassListV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassListV1Beta1.manifest(props: KubeVolumeAttributesClassListV1Beta1Props) ``` Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.VolumeAttributesClassList". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeVolumeAttributesClassListV1Beta1Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.v1beta1.VolumeAttributesClassList". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.VolumeAttributesClassList". --- ### KubeVolumeAttributesClassV1Alpha1 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 ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeVolumeAttributesClassV1Alpha1(scope: Construct, id: string, props: KubeVolumeAttributesClassV1Alpha1Props) ``` | **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-32.k8s.KubeVolumeAttributesClassV1Alpha1Props | 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-32.k8s.KubeVolumeAttributesClassV1Alpha1Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.v1alpha1.VolumeAttributesClass". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassV1Alpha1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassV1Alpha1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassV1Alpha1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassV1Alpha1.manifest(props: KubeVolumeAttributesClassV1Alpha1Props) ``` Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.VolumeAttributesClass". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeVolumeAttributesClassV1Alpha1Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.v1alpha1.VolumeAttributesClass". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.VolumeAttributesClass". --- ### KubeVolumeAttributesClassV1Beta1 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 ```typescript import { k8s } from 'cdk8s-plus-32' new k8s.KubeVolumeAttributesClassV1Beta1(scope: Construct, id: string, props: KubeVolumeAttributesClassV1Beta1Props) ``` | **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-32.k8s.KubeVolumeAttributesClassV1Beta1Props | 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-32.k8s.KubeVolumeAttributesClassV1Beta1Props 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript 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` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...cdk8s.JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript 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.v1beta1.VolumeAttributesClass". | --- ##### `isConstruct` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassV1Beta1.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` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.KubeVolumeAttributesClassV1Beta1.manifest(props: KubeVolumeAttributesClassV1Beta1Props) ``` Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.VolumeAttributesClass". This can be used to inline resource manifests inside other objects (e.g. as templates). ###### `props`^Required - *Type:* cdk8s-plus-32.k8s.KubeVolumeAttributesClassV1Beta1Props 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript 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.v1beta1.VolumeAttributesClass". | --- ##### `GVK`^Required ```typescript public readonly GVK: GroupVersionKind; ``` - *Type:* cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.VolumeAttributesClass". --- ### Namespace - *Implements:* INamespaceSelector, INetworkPolicyPeer In Kubernetes, namespaces provides a mechanism for isolating groups of resources within a single cluster. Names of resources need to be unique within a namespace, but not across namespaces. Namespace-based scoping is applicable only for namespaced objects (e.g. Deployments, Services, etc) and not for cluster-wide objects (e.g. StorageClass, Nodes, PersistentVolumes, etc). #### Initializers ```typescript import { Namespace } from 'cdk8s-plus-32' new Namespace(scope: Construct, id: string, props?: NamespaceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NamespaceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* NamespaceProps --- #### 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. | | toNamespaceSelectorConfig | Return the configuration of this selector. | | toNetworkPolicyPeerConfig | Return the configuration of this peer. | | toPodSelector | Convert the peer into a pod selector, if possible. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `toNamespaceSelectorConfig` ```typescript public toNamespaceSelectorConfig(): NamespaceSelectorConfig ``` Return the configuration of this selector. > [INamespaceSelector.toNamespaceSelectorConfig ()](INamespaceSelector.toNamespaceSelectorConfig ()) ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { Namespace } from 'cdk8s-plus-32' Namespace.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | NAME_LABEL | string | *No description.* | --- ##### `NAME_LABEL`^Required ```typescript public readonly NAME_LABEL: string; ``` - *Type:* string > [https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/#automatic-labelling](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/#automatic-labelling) --- ### Namespaces - *Implements:* INamespaceSelector, INetworkPolicyPeer Represents a group of namespaces. #### Initializers ```typescript import { Namespaces } from 'cdk8s-plus-32' new Namespaces(scope: Construct, id: string, expressions?: LabelExpression[], names?: string[], labels?: {[ key: string ]: string}) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | expressions | LabelExpression[] | *No description.* | | names | string[] | *No description.* | | labels | {[ key: string ]: string} | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `expressions`^Optional - *Type:* LabelExpression[] --- ##### `names`^Optional - *Type:* string[] --- ##### `labels`^Optional - *Type:* {[ key: string ]: string} --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | toNamespaceSelectorConfig | Return the configuration of this selector. | | toNetworkPolicyPeerConfig | Return the configuration of this peer. | | toPodSelector | Convert the peer into a pod selector, if possible. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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. --- ##### `toNamespaceSelectorConfig` ```typescript public toNamespaceSelectorConfig(): NamespaceSelectorConfig ``` Return the configuration of this selector. > [INamespaceSelector.toNamespaceSelectorConfig ()](INamespaceSelector.toNamespaceSelectorConfig ()) ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | all | Select all namespaces. | | select | Select specific namespaces. | --- ##### `isConstruct` ```typescript import { Namespaces } from 'cdk8s-plus-32' Namespaces.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. --- ##### `all` ```typescript import { Namespaces } from 'cdk8s-plus-32' Namespaces.all(scope: Construct, id: string) ``` Select all namespaces. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ##### `select` ```typescript import { Namespaces } from 'cdk8s-plus-32' Namespaces.select(scope: Construct, id: string, options: NamespacesSelectOptions) ``` Select specific namespaces. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* NamespacesSelectOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### NetworkPolicy Control traffic flow at the IP address or port level (OSI layer 3 or 4), network policies are an application-centric construct which allow you to specify how a pod is allowed to communicate with various network peers. Outgoing traffic is allowed if there are no network policies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the network policies that select the pod. - Incoming traffic is allowed to a pod if there are no network policies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the network policies that select the pod. Network policies do not conflict; they are additive. If any policy or policies apply to a given pod for a given direction, the connections allowed in that direction from that pod is the union of what the applicable policies allow. Thus, order of evaluation does not affect the policy result. For a connection from a source pod to a destination pod to be allowed, both the egress policy on the source pod and the ingress policy on the destination pod need to allow the connection. If either side does not allow the connection, it will not happen. > [https://kubernetes.io/docs/concepts/services-networking/network-policies/#networkpolicy-resource](https://kubernetes.io/docs/concepts/services-networking/network-policies/#networkpolicy-resource) #### Initializers ```typescript import { NetworkPolicy } from 'cdk8s-plus-32' new NetworkPolicy(scope: Construct, id: string, props?: NetworkPolicyProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NetworkPolicyProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* NetworkPolicyProps --- #### 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. | | addEgressRule | Allow outgoing traffic to the peer. | | addIngressRule | Allow incoming traffic from the peer. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addEgressRule` ```typescript public addEgressRule(peer: INetworkPolicyPeer, ports?: NetworkPolicyPort[]): void ``` Allow outgoing traffic to the peer. If ports are not passed, traffic will be allowed on all ports. ###### `peer`^Required - *Type:* INetworkPolicyPeer --- ###### `ports`^Optional - *Type:* NetworkPolicyPort[] --- ##### `addIngressRule` ```typescript public addIngressRule(peer: INetworkPolicyPeer, ports?: NetworkPolicyPort[]): void ``` Allow incoming traffic from the peer. If ports are not passed, traffic will be allowed on all ports. ###### `peer`^Required - *Type:* INetworkPolicyPeer --- ###### `ports`^Optional - *Type:* NetworkPolicyPort[] --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NetworkPolicy } from 'cdk8s-plus-32' NetworkPolicy.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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. --- ### NetworkPolicyIpBlock - *Implements:* INetworkPolicyPeer Describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a network policy selector. The except entry describes CIDRs that should not be included within this rule. #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | toNetworkPolicyPeerConfig | Return the configuration of this peer. | | toPodSelector | Convert the peer into a pod selector, if possible. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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. --- ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | anyIpv4 | Any IPv4 address. | | anyIpv6 | Any IPv6 address. | | ipv4 | Create an IPv4 peer from a CIDR. | | ipv6 | Create an IPv6 peer from a CIDR. | --- ##### `isConstruct` ```typescript import { NetworkPolicyIpBlock } from 'cdk8s-plus-32' NetworkPolicyIpBlock.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. --- ##### `anyIpv4` ```typescript import { NetworkPolicyIpBlock } from 'cdk8s-plus-32' NetworkPolicyIpBlock.anyIpv4(scope: Construct, id: string) ``` Any IPv4 address. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ##### `anyIpv6` ```typescript import { NetworkPolicyIpBlock } from 'cdk8s-plus-32' NetworkPolicyIpBlock.anyIpv6(scope: Construct, id: string) ``` Any IPv6 address. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ##### `ipv4` ```typescript import { NetworkPolicyIpBlock } from 'cdk8s-plus-32' NetworkPolicyIpBlock.ipv4(scope: Construct, id: string, cidrIp: string, except?: string[]) ``` Create an IPv4 peer from a CIDR. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `cidrIp`^Required - *Type:* string --- ###### `except`^Optional - *Type:* string[] --- ##### `ipv6` ```typescript import { NetworkPolicyIpBlock } from 'cdk8s-plus-32' NetworkPolicyIpBlock.ipv6(scope: Construct, id: string, cidrIp: string, except?: string[]) ``` Create an IPv6 peer from a CIDR. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `cidrIp`^Required - *Type:* string --- ###### `except`^Optional - *Type:* string[] --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cidr | string | A string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64". | | except | string[] | A slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64". Except values will be rejected if they are outside the CIDR range. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cidr`^Required ```typescript public readonly cidr: string; ``` - *Type:* string A string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64". --- ##### `except`^Optional ```typescript public readonly except: string[]; ``` - *Type:* string[] A slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64". Except values will be rejected if they are outside the CIDR range. --- ### PersistentVolume - *Implements:* IPersistentVolume, IStorage A PersistentVolume (PV) is a piece of storage in the cluster that has been provisioned by an administrator or dynamically provisioned using Storage Classes. It is a resource in the cluster just like a node is a cluster resource. PVs are volume plugins like Volumes, but have a lifecycle independent of any individual Pod that uses the PV. This API object captures the details of the implementation of the storage, be that NFS, iSCSI, or a cloud-provider-specific storage system. #### Initializers ```typescript import { PersistentVolume } from 'cdk8s-plus-32' new PersistentVolume(scope: Construct, id: string, props?: PersistentVolumeProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | PersistentVolumeProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* PersistentVolumeProps --- #### 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `asVolume` ```typescript public asVolume(): Volume ``` Convert the piece of storage into a concrete volume. ##### `bind` ```typescript 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](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding) ###### `claim`^Required - *Type:* IPersistentVolumeClaim The PVC to bind to. --- ##### `reserve` ```typescript 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](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` ```typescript import { PersistentVolume } from 'cdk8s-plus-32' PersistentVolume.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` ```typescript import { PersistentVolume } from 'cdk8s-plus-32' PersistentVolume.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. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly mode: PersistentVolumeMode; ``` - *Type:* PersistentVolumeMode Volume mode of this volume. --- ##### `reclaimPolicy`^Required ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* PersistentVolumeReclaimPolicy Reclaim policy of this volume. --- ##### `accessModes`^Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* PersistentVolumeAccessMode[] Access modes requirement of this claim. --- ##### `claim`^Optional ```typescript 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 ```typescript public readonly mountOptions: string[]; ``` - *Type:* string[] Mount options of this volume. --- ##### `storage`^Optional ```typescript public readonly storage: Size; ``` - *Type:* cdk8s.Size Storage size of this volume. --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string Storage class this volume belongs to. --- ### PersistentVolumeClaim - *Implements:* IPersistentVolumeClaim A PersistentVolumeClaim (PVC) is a request for storage by a user. It is similar to a Pod. Pods consume node resources and PVCs consume PV resources. Pods can request specific levels of resources (CPU and Memory). Claims can request specific size and access modes #### Initializers ```typescript import { PersistentVolumeClaim } from 'cdk8s-plus-32' new PersistentVolumeClaim(scope: Construct, id: string, props?: PersistentVolumeClaimProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | PersistentVolumeClaimProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* PersistentVolumeClaimProps --- #### 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. | | bind | Bind a claim to a specific volume. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `bind` ```typescript public bind(vol: IPersistentVolume): void ``` Bind a claim to a specific volume. Note that you must also bind the volume to the claim. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding) ###### `vol`^Required - *Type:* IPersistentVolume The PV to bind to. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromClaimName | Imports a pvc from the cluster as a reference. | --- ##### `isConstruct` ```typescript import { PersistentVolumeClaim } from 'cdk8s-plus-32' PersistentVolumeClaim.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. --- ##### `fromClaimName` ```typescript import { PersistentVolumeClaim } from 'cdk8s-plus-32' PersistentVolumeClaim.fromClaimName(scope: Construct, id: string, claimName: string) ``` Imports a pvc from the cluster as a reference. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `claimName`^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. | | volumeMode | PersistentVolumeMode | Volume mode requirement of this claim. | | accessModes | PersistentVolumeAccessMode[] | Access modes requirement of this claim. | | storage | cdk8s.Size | Storage requirement of this claim. | | storageClassName | string | Storage class requirment of this claim. | | volume | IPersistentVolume | PV this claim is bound to. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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. --- ##### `volumeMode`^Required ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* PersistentVolumeMode Volume mode requirement of this claim. --- ##### `accessModes`^Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* PersistentVolumeAccessMode[] Access modes requirement of this claim. --- ##### `storage`^Optional ```typescript public readonly storage: Size; ``` - *Type:* cdk8s.Size Storage requirement of this claim. --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string Storage class requirment of this claim. --- ##### `volume`^Optional ```typescript public readonly volume: IPersistentVolume; ``` - *Type:* IPersistentVolume PV this claim is bound to. Undefined means the claim is not bound to any specific volume. --- ### Pod Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. #### Initializers ```typescript import { Pod } from 'cdk8s-plus-32' new Pod(scope: Construct, id: string, props?: PodProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | PodProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* PodProps --- #### 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addContainer` ```typescript public addContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```typescript public addHostAlias(hostAlias: HostAlias): void ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```typescript public addInitContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```typescript public addVolume(vol: Volume): void ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```typescript public attachContainer(cont: Container): void ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig(): PodSelectorConfig ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```typescript public toSubjectConfiguration(): SubjectConfiguration ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { Pod } from 'cdk8s-plus-32' Pod.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.* | | connections | PodConnections | *No description.* | | scheduling | PodScheduling | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean --- ##### `containers`^Required ```typescript public readonly containers: Container[]; ``` - *Type:* Container[] --- ##### `dns`^Required ```typescript public readonly dns: PodDns; ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] --- ##### `initContainers`^Required ```typescript public readonly initContainers: Container[]; ``` - *Type:* Container[] --- ##### `podMetadata`^Required ```typescript public readonly podMetadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `securityContext`^Required ```typescript public readonly securityContext: PodSecurityContext; ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean --- ##### `volumes`^Required ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration --- ##### `connections`^Required ```typescript public readonly connections: PodConnections; ``` - *Type:* PodConnections --- ##### `scheduling`^Required ```typescript public readonly scheduling: PodScheduling; ``` - *Type:* PodScheduling --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ADDRESS_LABEL | string | This label is autoamtically added by cdk8s to any pod. | --- ##### `ADDRESS_LABEL`^Required ```typescript public readonly ADDRESS_LABEL: string; ``` - *Type:* string This label is autoamtically added by cdk8s to any pod. It provides a unique and stable identifier for the pod. --- ### Pods - *Implements:* IPodSelector Represents a group of pods. #### Initializers ```typescript import { Pods } from 'cdk8s-plus-32' new Pods(scope: Construct, id: string, expressions?: LabelExpression[], labels?: {[ key: string ]: string}, namespaces?: INamespaceSelector) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | expressions | LabelExpression[] | *No description.* | | labels | {[ key: string ]: string} | *No description.* | | namespaces | INamespaceSelector | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `expressions`^Optional - *Type:* LabelExpression[] --- ##### `labels`^Optional - *Type:* {[ key: string ]: string} --- ##### `namespaces`^Optional - *Type:* INamespaceSelector --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | toNetworkPolicyPeerConfig | *No description.* | | toPodSelector | *No description.* | | toPodSelectorConfig | Return the configuration of this selector. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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. --- ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig(): PodSelectorConfig ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | all | Select all pods. | | select | Select pods in the cluster with various selectors. | --- ##### `isConstruct` ```typescript import { Pods } from 'cdk8s-plus-32' Pods.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. --- ##### `all` ```typescript import { Pods } from 'cdk8s-plus-32' Pods.all(scope: Construct, id: string, options?: PodsAllOptions) ``` Select all pods. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* PodsAllOptions --- ##### `select` ```typescript import { Pods } from 'cdk8s-plus-32' Pods.select(scope: Construct, id: string, options: PodsSelectOptions) ``` Select pods in the cluster with various selectors. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* PodsSelectOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### Resource - *Implements:* IResource, IApiResource, IApiEndpoint Base class for all Kubernetes objects in stdk8s. Represents a single resource. #### Initializers ```typescript import { Resource } from 'cdk8s-plus-32' new Resource(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- #### 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { Resource } from 'cdk8s-plus-32' Resource.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 - *Implements:* IRole Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. #### Initializers ```typescript import { Role } from 'cdk8s-plus-32' new Role(scope: Construct, id: string, props?: RoleProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RoleProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* RoleProps --- #### 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. | | 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 RoleBinding that binds the permissions in this Role to a list of subjects, that will only apply this role's namespace. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `allow` ```typescript public allow(verbs: string[], resources: ...IApiResource[]): 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](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#determine-the-request-verb) ###### `verbs`^Required - *Type:* string[] --- ###### `resources`^Required - *Type:* ...IApiResource[] The resource(s) to apply to. --- ##### `allowCreate` ```typescript public allowCreate(resources: ...IApiResource[]): void ``` Add "create" permission for the resources. ###### `resources`^Required - *Type:* ...IApiResource[] The resource(s) to apply to. --- ##### `allowDelete` ```typescript public allowDelete(resources: ...IApiResource[]): void ``` Add "delete" permission for the resources. ###### `resources`^Required - *Type:* ...IApiResource[] The resource(s) to apply to. --- ##### `allowDeleteCollection` ```typescript public allowDeleteCollection(resources: ...IApiResource[]): void ``` Add "deletecollection" permission for the resources. ###### `resources`^Required - *Type:* ...IApiResource[] The resource(s) to apply to. --- ##### `allowGet` ```typescript public allowGet(resources: ...IApiResource[]): void ``` Add "get" permission for the resources. ###### `resources`^Required - *Type:* ...IApiResource[] The resource(s) to apply to. --- ##### `allowList` ```typescript public allowList(resources: ...IApiResource[]): void ``` Add "list" permission for the resources. ###### `resources`^Required - *Type:* ...IApiResource[] The resource(s) to apply to. --- ##### `allowPatch` ```typescript public allowPatch(resources: ...IApiResource[]): void ``` Add "patch" permission for the resources. ###### `resources`^Required - *Type:* ...IApiResource[] The resource(s) to apply to. --- ##### `allowRead` ```typescript public allowRead(resources: ...IApiResource[]): void ``` Add "get", "list", and "watch" permissions for the resources. ###### `resources`^Required - *Type:* ...IApiResource[] The resource(s) to apply to. --- ##### `allowReadWrite` ```typescript public allowReadWrite(resources: ...IApiResource[]): void ``` Add "get", "list", "watch", "create", "update", "patch", "delete", and "deletecollection" permissions for the resources. ###### `resources`^Required - *Type:* ...IApiResource[] The resource(s) to apply to. --- ##### `allowUpdate` ```typescript public allowUpdate(resources: ...IApiResource[]): void ``` Add "update" permission for the resources. ###### `resources`^Required - *Type:* ...IApiResource[] The resource(s) to apply to. --- ##### `allowWatch` ```typescript public allowWatch(resources: ...IApiResource[]): void ``` Add "watch" permission for the resources. ###### `resources`^Required - *Type:* ...IApiResource[] The resource(s) to apply to. --- ##### `bind` ```typescript public bind(subjects: ...ISubject[]): RoleBinding ``` Create a RoleBinding that binds the permissions in this Role to a list of subjects, that will only apply this role's namespace. ###### `subjects`^Required - *Type:* ...ISubject[] a list of subjects to bind to. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromRoleName | Imports a role from the cluster as a reference. | --- ##### `isConstruct` ```typescript import { Role } from 'cdk8s-plus-32' Role.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. --- ##### `fromRoleName` ```typescript import { Role } from 'cdk8s-plus-32' Role.fromRoleName(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 | RolePolicyRule[] | Rules associaated with this Role. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly rules: RolePolicyRule[]; ``` - *Type:* RolePolicyRule[] Rules associaated with this Role. Returns a copy, use `allow` to add rules. --- ### RoleBinding A RoleBinding grants permissions within a specific namespace to a user or set of users. #### Initializers ```typescript import { RoleBinding } from 'cdk8s-plus-32' new RoleBinding(scope: Construct, id: string, props: RoleBindingProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RoleBindingProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RoleBindingProps --- #### 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addSubjects` ```typescript 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` ```typescript import { RoleBinding } from 'cdk8s-plus-32' RoleBinding.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 | IRole | *No description.* | | subjects | ISubject[] | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly role: IRole; ``` - *Type:* IRole --- ##### `subjects`^Required ```typescript public readonly subjects: ISubject[]; ``` - *Type:* ISubject[] --- ### Secret - *Implements:* ISecret Kubernetes Secrets let you store and manage sensitive information, such as passwords, OAuth tokens, and ssh keys. Storing confidential information in a Secret is safer and more flexible than putting it verbatim in a Pod definition or in a container image. > [https://kubernetes.io/docs/concepts/configuration/secret](https://kubernetes.io/docs/concepts/configuration/secret) #### Initializers ```typescript import { Secret } from 'cdk8s-plus-32' new Secret(scope: Construct, id: string, props?: SecretProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SecretProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* SecretProps --- #### 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addStringData` ```typescript 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` ```typescript public envValue(key: string, options?: EnvValueFromSecretOptions): EnvValue ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* string --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions --- ##### `getStringData` ```typescript 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` ```typescript import { Secret } from 'cdk8s-plus-32' Secret.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` ```typescript import { Secret } from 'cdk8s-plus-32' Secret.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly immutable: boolean; ``` - *Type:* boolean Whether or not the secret is immutable. --- ### Service An abstract way to expose an application running on a set of Pods as a network service. With Kubernetes you don't need to modify your application to use an unfamiliar service discovery mechanism. Kubernetes gives Pods their own IP addresses and a single DNS name for a set of Pods, and can load-balance across them. For example, consider a stateless image-processing backend which is running with 3 replicas. Those replicas are fungible—frontends do not care which backend they use. While the actual Pods that compose the backend set may change, the frontend clients should not need to be aware of that, nor should they need to keep track of the set of backends themselves. The Service abstraction enables this decoupling. If you're able to use Kubernetes APIs for service discovery in your application, you can query the API server for Endpoints, that get updated whenever the set of Pods in a Service changes. For non-native applications, Kubernetes offers ways to place a network port or load balancer in between your application and the backend Pods. #### Initializers ```typescript import { Service } from 'cdk8s-plus-32' new Service(scope: Construct, id: string, props?: ServiceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ServiceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* ServiceProps --- #### 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. | | bind | Configure a port the service will bind to. | | exposeViaIngress | Expose a service via an ingress using the specified path. | | select | Require this service to select pods matching the selector. | | selectLabel | Require this service to select pods with this label. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `bind` ```typescript public bind(port: number, options?: ServiceBindOptions): void ``` Configure a port the service will bind to. This method can be called multiple times. ###### `port`^Required - *Type:* number The port definition. --- ###### `options`^Optional - *Type:* ServiceBindOptions --- ##### `exposeViaIngress` ```typescript public exposeViaIngress(path: string, options?: ExposeServiceViaIngressOptions): Ingress ``` Expose a service via an ingress using the specified path. ###### `path`^Required - *Type:* string The path to expose the service under. --- ###### `options`^Optional - *Type:* ExposeServiceViaIngressOptions Additional options. --- ##### `select` ```typescript public select(selector: IPodSelector): void ``` Require this service to select pods matching the selector. Note that invoking this method multiple times acts as an AND operator on the resulting labels. ###### `selector`^Required - *Type:* IPodSelector --- ##### `selectLabel` ```typescript public selectLabel(key: string, value: string): void ``` Require this service to select pods with this label. Note that invoking this method multiple times acts as an AND operator on the resulting labels. ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { Service } from 'cdk8s-plus-32' Service.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. | | port | number | Return the first port of the service. | | ports | ServicePort[] | Ports for this service. | | type | ServiceType | Determines how the Service is exposed. | | clusterIP | string | The IP address of the service and is usually assigned randomly by the master. | | externalName | string | The externalName to be used for EXTERNAL_NAME types. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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. --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number Return the first port of the service. --- ##### `ports`^Required ```typescript public readonly ports: ServicePort[]; ``` - *Type:* ServicePort[] Ports for this service. Use `bind()` to bind additional service ports. --- ##### `type`^Required ```typescript public readonly type: ServiceType; ``` - *Type:* ServiceType Determines how the Service is exposed. --- ##### `clusterIP`^Optional ```typescript public readonly clusterIP: string; ``` - *Type:* string The IP address of the service and is usually assigned randomly by the master. --- ##### `externalName`^Optional ```typescript public readonly externalName: string; ``` - *Type:* string The externalName to be used for EXTERNAL_NAME types. --- ### ServiceAccount - *Implements:* IServiceAccount, ISubject A service account provides an identity for processes that run in a Pod. When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default). > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account) #### Initializers ```typescript import { ServiceAccount } from 'cdk8s-plus-32' new ServiceAccount(scope: Construct, id: string, props?: ServiceAccountProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ServiceAccountProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* ServiceAccountProps --- #### 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. | | addSecret | Allow a secret to be accessed by pods using this service account. | | toSubjectConfiguration | Return the subject configuration. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addSecret` ```typescript public addSecret(secr: ISecret): void ``` Allow a secret to be accessed by pods using this service account. ###### `secr`^Required - *Type:* ISecret The secret. --- ##### `toSubjectConfiguration` ```typescript public toSubjectConfiguration(): SubjectConfiguration ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromServiceAccountName | Imports a service account from the cluster as a reference. | --- ##### `isConstruct` ```typescript import { ServiceAccount } from 'cdk8s-plus-32' ServiceAccount.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. --- ##### `fromServiceAccountName` ```typescript import { ServiceAccount } from 'cdk8s-plus-32' ServiceAccount.fromServiceAccountName(scope: Construct, id: string, name: string, options?: FromServiceAccountNameOptions) ``` Imports a service account from the cluster as a reference. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string The name of the service account resource. --- ###### `options`^Optional - *Type:* FromServiceAccountNameOptions additional options. --- #### 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. | | automountToken | boolean | Whether or not a token is automatically mounted for this service account. | | secrets | ISecret[] | List of secrets allowed to be used by pods running using this service account. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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. --- ##### `automountToken`^Required ```typescript public readonly automountToken: boolean; ``` - *Type:* boolean Whether or not a token is automatically mounted for this service account. --- ##### `secrets`^Required ```typescript public readonly secrets: ISecret[]; ``` - *Type:* ISecret[] List of secrets allowed to be used by pods running using this service account. Returns a copy. To add a secret, use `addSecret()`. --- ### ServiceAccountTokenSecret Create a secret for a service account token. > [https://kubernetes.io/docs/concepts/configuration/secret/#service-account-token-secrets](https://kubernetes.io/docs/concepts/configuration/secret/#service-account-token-secrets) #### Initializers ```typescript import { ServiceAccountTokenSecret } from 'cdk8s-plus-32' new ServiceAccountTokenSecret(scope: Construct, id: string, props: ServiceAccountTokenSecretProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ServiceAccountTokenSecretProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ServiceAccountTokenSecretProps --- #### 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addStringData` ```typescript 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` ```typescript public envValue(key: string, options?: EnvValueFromSecretOptions): EnvValue ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* string --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions --- ##### `getStringData` ```typescript 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` ```typescript import { ServiceAccountTokenSecret } from 'cdk8s-plus-32' ServiceAccountTokenSecret.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` ```typescript import { ServiceAccountTokenSecret } from 'cdk8s-plus-32' ServiceAccountTokenSecret.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly immutable: boolean; ``` - *Type:* boolean Whether or not the secret is immutable. --- ### SshAuthSecret Create a secret for ssh authentication. > [https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets](https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets) #### Initializers ```typescript import { SshAuthSecret } from 'cdk8s-plus-32' new SshAuthSecret(scope: Construct, id: string, props: SshAuthSecretProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SshAuthSecretProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SshAuthSecretProps --- #### 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addStringData` ```typescript 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` ```typescript public envValue(key: string, options?: EnvValueFromSecretOptions): EnvValue ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* string --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions --- ##### `getStringData` ```typescript 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` ```typescript import { SshAuthSecret } from 'cdk8s-plus-32' SshAuthSecret.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` ```typescript import { SshAuthSecret } from 'cdk8s-plus-32' SshAuthSecret.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly immutable: boolean; ``` - *Type:* boolean Whether or not the secret is immutable. --- ### StatefulSet - *Implements:* IScalable StatefulSet is the workload API object used to manage stateful applications. Manages the deployment and scaling of a set of Pods, and provides guarantees about the ordering and uniqueness of these Pods. Like a Deployment, a StatefulSet manages Pods that are based on an identical container spec. Unlike a Deployment, a StatefulSet maintains a sticky identity for each of their Pods. These pods are created from the same spec, but are not interchangeable: each has a persistent identifier that it maintains across any rescheduling. If you want to use storage volumes to provide persistence for your workload, you can use a StatefulSet as part of the solution. Although individual Pods in a StatefulSet are susceptible to failure, the persistent Pod identifiers make it easier to match existing volumes to the new Pods that replace any that have failed. Using StatefulSets ------------------ StatefulSets are valuable for applications that require one or more of the following. - Stable, unique network identifiers. - Stable, persistent storage. - Ordered, graceful deployment and scaling. - Ordered, automated rolling updates. #### Initializers ```typescript import { StatefulSet } from 'cdk8s-plus-32' new StatefulSet(scope: Construct, id: string, props: StatefulSetProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | StatefulSetProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* StatefulSetProps --- #### 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. | | addVolumeClaimTemplate | *No description.* | | markHasAutoscaler | Called on all IScalable targets when they are associated with an autoscaler. | | toScalingTarget | Return the target spec properties of this Scalable. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addContainer` ```typescript public addContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```typescript public addHostAlias(hostAlias: HostAlias): void ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```typescript public addInitContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```typescript public addVolume(vol: Volume): void ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```typescript public attachContainer(cont: Container): void ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig(): PodSelectorConfig ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```typescript public toSubjectConfiguration(): SubjectConfiguration ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) ##### `select` ```typescript public select(selectors: ...LabelSelector[]): void ``` Configure selectors for this workload. ###### `selectors`^Required - *Type:* ...LabelSelector[] --- ##### `addVolumeClaimTemplate` ```typescript public addVolumeClaimTemplate(template: PersistentVolumeClaimTemplateProps): void ``` ###### `template`^Required - *Type:* PersistentVolumeClaimTemplateProps --- ##### `markHasAutoscaler` ```typescript public markHasAutoscaler(): void ``` Called on all IScalable targets when they are associated with an autoscaler. > [IScalable.markHasAutoscaler ()](IScalable.markHasAutoscaler ()) ##### `toScalingTarget` ```typescript public toScalingTarget(): ScalingTarget ``` Return the target spec properties of this Scalable. > [IScalable.toScalingTarget ()](IScalable.toScalingTarget ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { StatefulSet } from 'cdk8s-plus-32' StatefulSet.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. | | podManagementPolicy | PodManagementPolicy | Management policy to use for the set. | | service | Service | *No description.* | | strategy | StatefulSetUpdateStrategy | The update startegy of this stateful set. | | replicas | number | Number of desired pods. | | hasAutoscaler | boolean | If this is a target of an autoscaler. | | volumeClaimTemplates | PersistentVolumeClaimTemplateProps[] | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean --- ##### `containers`^Required ```typescript public readonly containers: Container[]; ``` - *Type:* Container[] --- ##### `dns`^Required ```typescript public readonly dns: PodDns; ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] --- ##### `initContainers`^Required ```typescript public readonly initContainers: Container[]; ``` - *Type:* Container[] --- ##### `podMetadata`^Required ```typescript public readonly podMetadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition The metadata of pods in this workload. --- ##### `securityContext`^Required ```typescript public readonly securityContext: PodSecurityContext; ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean --- ##### `volumes`^Required ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration --- ##### `connections`^Required ```typescript public readonly connections: PodConnections; ``` - *Type:* PodConnections --- ##### `matchExpressions`^Required ```typescript 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 ```typescript 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 ```typescript public readonly scheduling: WorkloadScheduling; ``` - *Type:* WorkloadScheduling --- ##### `minReady`^Required ```typescript 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. --- ##### `podManagementPolicy`^Required ```typescript public readonly podManagementPolicy: PodManagementPolicy; ``` - *Type:* PodManagementPolicy Management policy to use for the set. --- ##### `service`^Required ```typescript public readonly service: Service; ``` - *Type:* Service --- ##### `strategy`^Required ```typescript public readonly strategy: StatefulSetUpdateStrategy; ``` - *Type:* StatefulSetUpdateStrategy The update startegy of this stateful set. --- ##### `replicas`^Optional ```typescript public readonly replicas: number; ``` - *Type:* number Number of desired pods. --- ##### `hasAutoscaler`^Required ```typescript public readonly hasAutoscaler: boolean; ``` - *Type:* boolean If this is a target of an autoscaler. --- ##### `volumeClaimTemplates`^Optional ```typescript public readonly volumeClaimTemplates: PersistentVolumeClaimTemplateProps[]; ``` - *Type:* PersistentVolumeClaimTemplateProps[] --- ### TlsSecret Create a secret for storing a TLS certificate and its associated key. > [https://kubernetes.io/docs/concepts/configuration/secret/#tls-secrets](https://kubernetes.io/docs/concepts/configuration/secret/#tls-secrets) #### Initializers ```typescript import { TlsSecret } from 'cdk8s-plus-32' new TlsSecret(scope: Construct, id: string, props: TlsSecretProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | TlsSecretProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* TlsSecretProps --- #### 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addStringData` ```typescript 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` ```typescript public envValue(key: string, options?: EnvValueFromSecretOptions): EnvValue ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* string --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions --- ##### `getStringData` ```typescript 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` ```typescript import { TlsSecret } from 'cdk8s-plus-32' TlsSecret.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` ```typescript import { TlsSecret } from 'cdk8s-plus-32' TlsSecret.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly immutable: boolean; ``` - *Type:* boolean Whether or not the secret is immutable. --- ### User - *Implements:* ISubject Represents a user. #### 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public toSubjectConfiguration(): SubjectConfiguration ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromName | Reference a user in the cluster by name. | --- ##### `isConstruct` ```typescript import { User } from 'cdk8s-plus-32' User.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` ```typescript import { User } from 'cdk8s-plus-32' User.fromName(scope: Construct, id: string, name: string) ``` Reference a user in the cluster 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `apiGroup`^Optional ```typescript public readonly apiGroup: string; ``` - *Type:* string --- ### Volume - *Implements:* IStorage Volume represents a named volume in a pod that may be accessed by any container in the pod. Docker also has a concept of volumes, though it is somewhat looser and less managed. In Docker, a volume is simply a directory on disk or in another Container. Lifetimes are not managed and until very recently there were only local-disk-backed volumes. Docker now provides volume drivers, but the functionality is very limited for now (e.g. as of Docker 1.7 only one volume driver is allowed per Container and there is no way to pass parameters to volumes). A Kubernetes volume, on the other hand, has an explicit lifetime - the same as the Pod that encloses it. Consequently, a volume outlives any Containers that run within the Pod, and data is preserved across Container restarts. Of course, when a Pod ceases to exist, the volume will cease to exist, too. Perhaps more importantly than this, Kubernetes supports many types of volumes, and a Pod can use any number of them simultaneously. At its core, a volume is just a directory, possibly with some data in it, which is accessible to the Containers in a Pod. How that directory comes to be, the medium that backs it, and the contents of it are determined by the particular volume type used. To use a volume, a Pod specifies what volumes to provide for the Pod (the .spec.volumes field) and where to mount those into Containers (the .spec.containers[*].volumeMounts field). A process in a container sees a filesystem view composed from their Docker image and volumes. The Docker image is at the root of the filesystem hierarchy, and any volumes are mounted at the specified paths within the image. Volumes can not mount onto other volumes #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | asVolume | Convert the piece of storage into a concrete volume. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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. --- ##### `asVolume` ```typescript public asVolume(): Volume ``` Convert the piece of storage into a concrete volume. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromAwsElasticBlockStore | Mounts an Amazon Web Services (AWS) EBS volume into your pod. | | fromAzureDisk | Mounts a Microsoft Azure Data Disk into a pod. | | fromConfigMap | Populate the volume from a ConfigMap. | | fromCsi | Populate the volume from a CSI driver, for example the Secrets Store CSI Driver: https://secrets-store-csi-driver.sigs.k8s.io/introduction.html. Which in turn needs an associated provider to source the secrets, such as the AWS Secrets Manager and Systems Manager Parameter Store provider: https://aws.github.io/secrets-store-csi-driver-provider-aws/. | | fromEmptyDir | An emptyDir volume is first created when a Pod is assigned to a Node, and exists as long as that Pod is running on that node. | | fromGcePersistentDisk | Mounts a Google Compute Engine (GCE) persistent disk (PD) into your Pod. | | fromHostPath | Used to mount a file or directory from the host node's filesystem into a Pod. | | fromName | Create a volume with an arbitrary name and no configuration. | | fromNfs | Used to mount an NFS share into a Pod. | | fromPersistentVolumeClaim | Used to mount a PersistentVolume into a Pod. | | fromSecret | Populate the volume from a Secret. | --- ##### `isConstruct` ```typescript import { Volume } from 'cdk8s-plus-32' Volume.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. --- ##### `fromAwsElasticBlockStore` ```typescript import { Volume } from 'cdk8s-plus-32' Volume.fromAwsElasticBlockStore(scope: Construct, id: string, volumeId: string, options?: AwsElasticBlockStoreVolumeOptions) ``` Mounts an Amazon Web Services (AWS) EBS volume into your pod. Unlike emptyDir, which is erased when a pod is removed, the contents of an EBS volume are persisted and the volume is unmounted. This means that an EBS volume can be pre-populated with data, and that data can be shared between pods. There are some restrictions when using an awsElasticBlockStore volume: - the nodes on which pods are running must be AWS EC2 instances. - those instances need to be in the same region and availability zone as the EBS volume. - EBS only supports a single EC2 instance mounting a volume. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `volumeId`^Required - *Type:* string --- ###### `options`^Optional - *Type:* AwsElasticBlockStoreVolumeOptions --- ##### `fromAzureDisk` ```typescript import { Volume } from 'cdk8s-plus-32' Volume.fromAzureDisk(scope: Construct, id: string, diskName: string, diskUri: string, options?: AzureDiskVolumeOptions) ``` Mounts a Microsoft Azure Data Disk into a pod. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `diskName`^Required - *Type:* string --- ###### `diskUri`^Required - *Type:* string --- ###### `options`^Optional - *Type:* AzureDiskVolumeOptions --- ##### `fromConfigMap` ```typescript import { Volume } from 'cdk8s-plus-32' Volume.fromConfigMap(scope: Construct, id: string, configMap: IConfigMap, options?: ConfigMapVolumeOptions) ``` Populate the volume from a ConfigMap. The configMap resource provides a way to inject configuration data into Pods. The data stored in a ConfigMap object can be referenced in a volume of type configMap and then consumed by containerized applications running in a Pod. When referencing a configMap object, you can simply provide its name in the volume to reference it. You can also customize the path to use for a specific entry in the ConfigMap. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `configMap`^Required - *Type:* IConfigMap The config map to use to populate the volume. --- ###### `options`^Optional - *Type:* ConfigMapVolumeOptions Options. --- ##### `fromCsi` ```typescript import { Volume } from 'cdk8s-plus-32' Volume.fromCsi(scope: Construct, id: string, driver: string, options?: CsiVolumeOptions) ``` Populate the volume from a CSI driver, for example the Secrets Store CSI Driver: https://secrets-store-csi-driver.sigs.k8s.io/introduction.html. Which in turn needs an associated provider to source the secrets, such as the AWS Secrets Manager and Systems Manager Parameter Store provider: https://aws.github.io/secrets-store-csi-driver-provider-aws/. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `driver`^Required - *Type:* string The name of the CSI driver to use to populate the volume. --- ###### `options`^Optional - *Type:* CsiVolumeOptions Options for the CSI volume, including driver-specific ones. --- ##### `fromEmptyDir` ```typescript import { Volume } from 'cdk8s-plus-32' Volume.fromEmptyDir(scope: Construct, id: string, name: string, options?: EmptyDirVolumeOptions) ``` An emptyDir volume is first created when a Pod is assigned to a Node, and exists as long as that Pod is running on that node. As the name says, it is initially empty. Containers in the Pod can all read and write the same files in the emptyDir volume, though that volume can be mounted at the same or different paths in each Container. When a Pod is removed from a node for any reason, the data in the emptyDir is deleted forever. > [http://kubernetes.io/docs/user-guide/volumes#emptydir](http://kubernetes.io/docs/user-guide/volumes#emptydir) ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- ###### `options`^Optional - *Type:* EmptyDirVolumeOptions Additional options. --- ##### `fromGcePersistentDisk` ```typescript import { Volume } from 'cdk8s-plus-32' Volume.fromGcePersistentDisk(scope: Construct, id: string, pdName: string, options?: GCEPersistentDiskVolumeOptions) ``` Mounts a Google Compute Engine (GCE) persistent disk (PD) into your Pod. Unlike emptyDir, which is erased when a pod is removed, the contents of a PD are preserved and the volume is merely unmounted. This means that a PD can be pre-populated with data, and that data can be shared between pods. There are some restrictions when using a gcePersistentDisk: - the nodes on which Pods are running must be GCE VMs - those VMs need to be in the same GCE project and zone as the persistent disk ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `pdName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* GCEPersistentDiskVolumeOptions --- ##### `fromHostPath` ```typescript import { Volume } from 'cdk8s-plus-32' Volume.fromHostPath(scope: Construct, id: string, name: string, options: HostPathVolumeOptions) ``` Used to mount a file or directory from the host node's filesystem into a Pod. This is not something that most Pods will need, but it offers a powerful escape hatch for some applications. > [https://kubernetes.io/docs/concepts/storage/volumes/#hostpath](https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- ###### `options`^Required - *Type:* HostPathVolumeOptions --- ##### `fromName` ```typescript import { Volume } from 'cdk8s-plus-32' Volume.fromName(scope: Construct, id: string, name: string) ``` Create a volume with an arbitrary name and no configuration. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- ##### `fromNfs` ```typescript import { Volume } from 'cdk8s-plus-32' Volume.fromNfs(scope: Construct, id: string, name: string, options: NfsVolumeOptions) ``` Used to mount an NFS share into a Pod. > [https://kubernetes.io/docs/concepts/storage/volumes/#nfs](https://kubernetes.io/docs/concepts/storage/volumes/#nfs) ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `name`^Required - *Type:* string --- ###### `options`^Required - *Type:* NfsVolumeOptions --- ##### `fromPersistentVolumeClaim` ```typescript import { Volume } from 'cdk8s-plus-32' Volume.fromPersistentVolumeClaim(scope: Construct, id: string, claim: IPersistentVolumeClaim, options?: PersistentVolumeClaimVolumeOptions) ``` Used to mount a PersistentVolume into a Pod. PersistentVolumeClaims are a way for users to "claim" durable storage (such as a GCE PersistentDisk or an iSCSI volume) without knowing the details of the particular cloud environment. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes/](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `claim`^Required - *Type:* IPersistentVolumeClaim --- ###### `options`^Optional - *Type:* PersistentVolumeClaimVolumeOptions --- ##### `fromSecret` ```typescript import { Volume } from 'cdk8s-plus-32' Volume.fromSecret(scope: Construct, id: string, secr: ISecret, options?: SecretVolumeOptions) ``` Populate the volume from a Secret. A secret volume is used to pass sensitive information, such as passwords, to Pods. You can store secrets in the Kubernetes API and mount them as files for use by pods without coupling to Kubernetes directly. secret volumes are backed by tmpfs (a RAM-backed filesystem) so they are never written to non-volatile storage. > [https://kubernetes.io/docs/concepts/storage/volumes/#secret](https://kubernetes.io/docs/concepts/storage/volumes/#secret) ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `secr`^Required - *Type:* ISecret The secret to use to populate the volume. --- ###### `options`^Optional - *Type:* SecretVolumeOptions Options. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | name | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ### Workload A workload is an application running on Kubernetes. Whether your workload is a single component or several that work together, on Kubernetes you run it inside a set of pods. In Kubernetes, a Pod represents a set of running containers on your cluster. #### Initializers ```typescript import { Workload } from 'cdk8s-plus-32' new Workload(scope: Construct, id: string, props: WorkloadProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | WorkloadProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* WorkloadProps --- #### 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript 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` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ##### `addContainer` ```typescript public addContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```typescript public addHostAlias(hostAlias: HostAlias): void ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```typescript public addInitContainer(cont: ContainerProps): Container ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```typescript public addVolume(vol: Volume): void ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```typescript public attachContainer(cont: Container): void ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig(): PodSelectorConfig ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```typescript public toSubjectConfiguration(): SubjectConfiguration ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) ##### `select` ```typescript 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` ```typescript import { Workload } from 'cdk8s-plus-32' Workload.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.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of this API object. --- ##### `permissions`^Required ```typescript public readonly permissions: ResourcePermissions; ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```typescript 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 ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean --- ##### `containers`^Required ```typescript public readonly containers: Container[]; ``` - *Type:* Container[] --- ##### `dns`^Required ```typescript public readonly dns: PodDns; ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] --- ##### `initContainers`^Required ```typescript public readonly initContainers: Container[]; ``` - *Type:* Container[] --- ##### `podMetadata`^Required ```typescript public readonly podMetadata: ApiObjectMetadataDefinition; ``` - *Type:* cdk8s.ApiObjectMetadataDefinition The metadata of pods in this workload. --- ##### `securityContext`^Required ```typescript public readonly securityContext: PodSecurityContext; ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean --- ##### `volumes`^Required ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration --- ##### `connections`^Required ```typescript public readonly connections: PodConnections; ``` - *Type:* PodConnections --- ##### `matchExpressions`^Required ```typescript 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 ```typescript 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 ```typescript public readonly scheduling: WorkloadScheduling; ``` - *Type:* WorkloadScheduling --- ## Structs ### AbstractPodProps Properties for `AbstractPod`. #### Initializer ```typescript import { AbstractPodProps } from 'cdk8s-plus-32' const abstractPodProps: AbstractPodProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | boolean | Indicates whether a service account token should be automatically mounted. | | containers | ContainerProps[] | List of containers belonging to the pod. | | dns | PodDnsProps | DNS settings for the pod. | | dockerRegistryAuth | ISecret | A secret containing docker credentials for authenticating to a registry. | | enableServiceLinks | boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | HostAlias[] | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | boolean | Host network for the pod. | | initContainers | ContainerProps[] | List of initialization containers belonging to the pod. | | isolate | boolean | Isolates the pod. | | restartPolicy | RestartPolicy | Restart policy for all containers within the pod. | | securityContext | PodSecurityContextProps | SecurityContext holds pod-level security attributes and common container settings. | | serviceAccount | IServiceAccount | A service account provides an identity for processes that run in a Pod. | | shareProcessNamespace | boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | cdk8s.Duration | Grace period until the pod is terminated. | | volumes | Volume[] | List of volumes that can be mounted by containers belonging to the pod. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether a service account token should be automatically mounted. > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server) --- ##### `containers`^Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No containers. Note that a pod spec must include at least one container. List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. You can add additionnal containers using `podSpec.addContainer()` --- ##### `dns`^Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* PodDnsProps - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > [https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/) --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean - *Default:* true Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. > [https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) --- ##### `hostAliases`^Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No init containers. List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added ,removed or updated. > [https://kubernetes.io/docs/concepts/workloads/pods/init-containers/](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) --- ##### `isolate`^Optional ```typescript public readonly isolate: boolean; ``` - *Type:* boolean - *Default:* false Isolates the pod. This will prevent any ingress or egress connections to / from this pod. You can however allow explicit connections post instantiation by using the `.connections` property. --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy) --- ##### `securityContext`^Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount - *Default:* No service account. A service account provides an identity for processes that run in a Pod. When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default). > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) --- ##### `shareProcessNamespace`^Optional ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean - *Default:* false When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. > [https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/](https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/) --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] - *Default:* No volumes. List of volumes that can be mounted by containers belonging to the pod. You can also add volumes later using `podSpec.addVolume()` > [https://kubernetes.io/docs/concepts/storage/volumes](https://kubernetes.io/docs/concepts/storage/volumes) --- ### AddDeploymentOptions Options to add a deployment to a service. #### Initializer ```typescript import { AddDeploymentOptions } from 'cdk8s-plus-32' const addDeploymentOptions: AddDeploymentOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name of this port within the service. | | nodePort | number | The port on each node on which this service is exposed when type=NodePort or LoadBalancer. | | protocol | Protocol | The IP protocol for this port. | | targetPort | number | The port number the service will redirect to. | | port | number | The port number the service will bind to. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service. --- ##### `nodePort`^Optional ```typescript public readonly nodePort: number; ``` - *Type:* number - *Default:* auto-allocate a port if the ServiceType of this Service requires one. The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. > [https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport](https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport) --- ##### `protocol`^Optional ```typescript public readonly protocol: Protocol; ``` - *Type:* Protocol - *Default:* Protocol.TCP The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. --- ##### `targetPort`^Optional ```typescript public readonly targetPort: number; ``` - *Type:* number - *Default:* The value of `port` will be used. The port number the service will redirect to. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* Copied from the first container of the deployment. The port number the service will bind to. --- ### AddDirectoryOptions Options for `configmap.addDirectory()`. #### Initializer ```typescript import { AddDirectoryOptions } from 'cdk8s-plus-32' const addDirectoryOptions: AddDirectoryOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | exclude | string[] | Glob patterns to exclude when adding files. | | keyPrefix | string | A prefix to add to all keys in the config map. | --- ##### `exclude`^Optional ```typescript public readonly exclude: string[]; ``` - *Type:* string[] - *Default:* include all files Glob patterns to exclude when adding files. --- ##### `keyPrefix`^Optional ```typescript public readonly keyPrefix: string; ``` - *Type:* string - *Default:* "" A prefix to add to all keys in the config map. --- ### Affinity Affinity is a group of affinity scheduling rules. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const affinity: k8s.Affinity = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nodeAffinity | cdk8s-plus-32.k8s.NodeAffinity | Describes node affinity scheduling rules for the pod. | | podAffinity | cdk8s-plus-32.k8s.PodAffinity | Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). | | podAntiAffinity | cdk8s-plus-32.k8s.PodAntiAffinity | Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). | --- ##### `nodeAffinity`^Optional ```typescript public readonly nodeAffinity: NodeAffinity; ``` - *Type:* cdk8s-plus-32.k8s.NodeAffinity Describes node affinity scheduling rules for the pod. --- ##### `podAffinity`^Optional ```typescript public readonly podAffinity: PodAffinity; ``` - *Type:* cdk8s-plus-32.k8s.PodAffinity Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). --- ##### `podAntiAffinity`^Optional ```typescript public readonly podAntiAffinity: PodAntiAffinity; ``` - *Type:* cdk8s-plus-32.k8s.PodAntiAffinity Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). --- ### AggregationRule AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const aggregationRule: k8s.AggregationRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterRoleSelectors | cdk8s-plus-32.k8s.LabelSelector[] | ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. | --- ##### `clusterRoleSelectors`^Optional ```typescript public readonly clusterRoleSelectors: LabelSelector[]; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector[] ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added --- ### ApiResourceOptions Options for `ApiResource`. #### Initializer ```typescript import { ApiResourceOptions } from 'cdk8s-plus-32' const apiResourceOptions: ApiResourceOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | | resourceType | string | The name of the resource type as it appears in the relevant API endpoint. | --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of the resource type as it appears in the relevant API endpoint. > [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources) --- *Example* ```typescript - "pods" or "pods/log" ``` ### ApiServiceSpec APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const apiServiceSpec: k8s.ApiServiceSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | groupPriorityMinimum | number | GroupPriorityMinimum is the priority this group should have at least. | | versionPriority | number | VersionPriority controls the ordering of this API version inside of its group. | | caBundle | string | CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. | | group | string | Group is the API group name this server hosts. | | insecureSkipTlsVerify | boolean | InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. | | service | cdk8s-plus-32.k8s.ServiceReference | Service is a reference to the service for this API server. | | version | string | Version is the API version this server hosts. | --- ##### `groupPriorityMinimum`^Required ```typescript public readonly groupPriorityMinimum: number; ``` - *Type:* number GroupPriorityMinimum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMinimum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s --- ##### `versionPriority`^Required ```typescript public readonly versionPriority: number; ``` - *Type:* number VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. --- ##### `caBundle`^Optional ```typescript public readonly caBundle: string; ``` - *Type:* string CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used. --- ##### `group`^Optional ```typescript public readonly group: string; ``` - *Type:* string Group is the API group name this server hosts. --- ##### `insecureSkipTlsVerify`^Optional ```typescript public readonly insecureSkipTlsVerify: boolean; ``` - *Type:* boolean InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. --- ##### `service`^Optional ```typescript public readonly service: ServiceReference; ``` - *Type:* cdk8s-plus-32.k8s.ServiceReference Service is a reference to the service for this API server. It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. --- ##### `version`^Optional ```typescript public readonly version: string; ``` - *Type:* string Version is the API version this server hosts. For example, "v1" --- ### AppArmorProfile AppArmorProfile defines a pod or container's AppArmor settings. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const appArmorProfile: k8s.AppArmorProfile = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | type indicates which kind of AppArmor profile will be applied. | | localhostProfile | string | localhostProfile indicates a profile loaded on the node that should be used. | --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement. --- ##### `localhostProfile`^Optional ```typescript public readonly localhostProfile: string; ``` - *Type:* string localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost". --- ### ApplyConfigurationV1Alpha1 ApplyConfiguration defines the desired configuration values of an object. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const applyConfigurationV1Alpha1: k8s.ApplyConfigurationV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | expression will be evaluated by CEL to create an apply configuration. ref: https://github.com/google/cel-spec. | --- ##### `expression`^Optional ```typescript public readonly expression: string; ``` - *Type:* string expression will be evaluated by CEL to create an apply configuration. ref: https://github.com/google/cel-spec. Apply configurations are declared in CEL using object initialization. For example, this CEL expression returns an apply configuration to set a single field: Object{ spec: Object.spec{ serviceAccountName: "example" } } Apply configurations may not modify atomic structs, maps or arrays due to the risk of accidental deletion of values not included in the apply configuration. CEL expressions have access to the object types needed to create apply configurations: - 'Object' - CEL type of the resource object. - 'Object.' - CEL type of object field (such as 'Object.spec') - 'Object.....` - CEL type of nested field (such as 'Object.spec.containers') CEL expressions have access to the contents of the API request, organized into CEL variables as well as some other useful variables: - 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value. For example, a variable named 'foo' can be accessed as 'variables.foo'. - 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz - 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the request resource. The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object. No other metadata properties are accessible. Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Required. --- ### AuditAnnotation AuditAnnotation describes how to produce an audit annotation for an API request. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const auditAnnotation: k8s.AuditAnnotation = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | key specifies the audit annotation key. | | valueExpression | string | valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length. The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key: "{ValidatingAdmissionPolicy name}/{key}". If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key, the annotation key will be identical. In this case, the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded. Required. --- ##### `valueExpression`^Required ```typescript public readonly valueExpression: string; ``` - *Type:* string valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to a string, the audit annotation is included with the string value. If the expression evaluates to null or empty string the audit annotation will be omitted. The valueExpression may be no longer than 5kb in length. If the result of the valueExpression is more than 10kb in length, it will be truncated to 10kb. If multiple ValidatingAdmissionPolicyBinding resources match an API request, then the valueExpression will be evaluated for each binding. All unique values produced by the valueExpressions will be joined together in a comma-separated list. Required. --- ### AuditAnnotationV1Beta1 AuditAnnotation describes how to produce an audit annotation for an API request. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const auditAnnotationV1Beta1: k8s.AuditAnnotationV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | key specifies the audit annotation key. | | valueExpression | string | valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length. The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key: "{ValidatingAdmissionPolicy name}/{key}". If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key, the annotation key will be identical. In this case, the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded. Required. --- ##### `valueExpression`^Required ```typescript public readonly valueExpression: string; ``` - *Type:* string valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to a string, the audit annotation is included with the string value. If the expression evaluates to null or empty string the audit annotation will be omitted. The valueExpression may be no longer than 5kb in length. If the result of the valueExpression is more than 10kb in length, it will be truncated to 10kb. If multiple ValidatingAdmissionPolicyBinding resources match an API request, then the valueExpression will be evaluated for each binding. All unique values produced by the valueExpressions will be joined together in a comma-separated list. Required. --- ### AwsElasticBlockStorePersistentVolumeProps Properties for `AwsElasticBlockStorePersistentVolume`. #### Initializer ```typescript import { AwsElasticBlockStorePersistentVolumeProps } from 'cdk8s-plus-32' const awsElasticBlockStorePersistentVolumeProps: AwsElasticBlockStorePersistentVolumeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | PersistentVolumeAccessMode[] | Contains all ways the volume can be mounted. | | claim | IPersistentVolumeClaim | Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. | | mountOptions | string[] | A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. | | reclaimPolicy | PersistentVolumeReclaimPolicy | When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource. | | storage | cdk8s.Size | What is the storage capacity of this volume. | | storageClassName | string | Name of StorageClass to which this persistent volume belongs. | | volumeMode | PersistentVolumeMode | Defines what type of volume is required by the claim. | | volumeId | string | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). | | fsType | string | Filesystem type of the volume that you want to mount. | | partition | number | The partition in the volume that you want to mount. | | readOnly | boolean | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* PersistentVolumeAccessMode[] - *Default:* No access modes. Contains all ways the volume can be mounted. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes) --- ##### `claim`^Optional ```typescript public readonly claim: IPersistentVolumeClaim; ``` - *Type:* IPersistentVolumeClaim - *Default:* Not bound to a specific claim. Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding](https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding) --- ##### `mountOptions`^Optional ```typescript public readonly mountOptions: string[]; ``` - *Type:* string[] - *Default:* No options. A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options) --- ##### `reclaimPolicy`^Optional ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* PersistentVolumeReclaimPolicy - *Default:* PersistentVolumeReclaimPolicy.RETAIN When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource. The reclaim policy tells the cluster what to do with the volume after it has been released of its claim. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming](https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming) --- ##### `storage`^Optional ```typescript public readonly storage: Size; ``` - *Type:* cdk8s.Size - *Default:* No specified. What is the storage capacity of this volume. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources](https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources) --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`^Optional ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ##### `volumeId`^Required ```typescript public readonly volumeId: string; ``` - *Type:* string Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore > [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore) --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string - *Default:* 'ext4' Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. > [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore) --- ##### `partition`^Optional ```typescript public readonly partition: number; ``` - *Type:* number - *Default:* No partition. The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". > [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore) --- ### AwsElasticBlockStoreVolumeOptions Options of `Volume.fromAwsElasticBlockStore`. #### Initializer ```typescript import { AwsElasticBlockStoreVolumeOptions } from 'cdk8s-plus-32' const awsElasticBlockStoreVolumeOptions: AwsElasticBlockStoreVolumeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fsType | string | Filesystem type of the volume that you want to mount. | | name | string | The volume name. | | partition | number | The partition in the volume that you want to mount. | | readOnly | boolean | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". | --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string - *Default:* 'ext4' Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. > [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore) --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* auto-generated The volume name. --- ##### `partition`^Optional ```typescript public readonly partition: number; ``` - *Type:* number - *Default:* No partition. The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". > [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore) --- ### AwsElasticBlockStoreVolumeSource Represents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const awsElasticBlockStoreVolumeSource: k8s.AwsElasticBlockStoreVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | volumeId | string | volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). | | fsType | string | fsType is the filesystem type of the volume that you want to mount. | | partition | number | partition is the partition in the volume that you want to mount. | | readOnly | boolean | readOnly value true will force the readOnly setting in VolumeMounts. | --- ##### `volumeId`^Required ```typescript public readonly volumeId: string; ``` - *Type:* string volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore --- ##### `partition`^Optional ```typescript public readonly partition: number; ``` - *Type:* number partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore --- ### AzureDiskPersistentVolumeProps Properties for `AzureDiskPersistentVolume`. #### Initializer ```typescript import { AzureDiskPersistentVolumeProps } from 'cdk8s-plus-32' const azureDiskPersistentVolumeProps: AzureDiskPersistentVolumeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | PersistentVolumeAccessMode[] | Contains all ways the volume can be mounted. | | claim | IPersistentVolumeClaim | Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. | | mountOptions | string[] | A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. | | reclaimPolicy | PersistentVolumeReclaimPolicy | When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource. | | storage | cdk8s.Size | What is the storage capacity of this volume. | | storageClassName | string | Name of StorageClass to which this persistent volume belongs. | | volumeMode | PersistentVolumeMode | Defines what type of volume is required by the claim. | | diskName | string | The Name of the data disk in the blob storage. | | diskUri | string | The URI the data disk in the blob storage. | | cachingMode | AzureDiskPersistentVolumeCachingMode | Host Caching mode. | | fsType | string | Filesystem type to mount. | | kind | AzureDiskPersistentVolumeKind | Kind of disk. | | readOnly | boolean | Force the ReadOnly setting in VolumeMounts. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* PersistentVolumeAccessMode[] - *Default:* No access modes. Contains all ways the volume can be mounted. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes) --- ##### `claim`^Optional ```typescript public readonly claim: IPersistentVolumeClaim; ``` - *Type:* IPersistentVolumeClaim - *Default:* Not bound to a specific claim. Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding](https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding) --- ##### `mountOptions`^Optional ```typescript public readonly mountOptions: string[]; ``` - *Type:* string[] - *Default:* No options. A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options) --- ##### `reclaimPolicy`^Optional ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* PersistentVolumeReclaimPolicy - *Default:* PersistentVolumeReclaimPolicy.RETAIN When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource. The reclaim policy tells the cluster what to do with the volume after it has been released of its claim. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming](https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming) --- ##### `storage`^Optional ```typescript public readonly storage: Size; ``` - *Type:* cdk8s.Size - *Default:* No specified. What is the storage capacity of this volume. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources](https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources) --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`^Optional ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ##### `diskName`^Required ```typescript public readonly diskName: string; ``` - *Type:* string The Name of the data disk in the blob storage. --- ##### `diskUri`^Required ```typescript public readonly diskUri: string; ``` - *Type:* string The URI the data disk in the blob storage. --- ##### `cachingMode`^Optional ```typescript public readonly cachingMode: AzureDiskPersistentVolumeCachingMode; ``` - *Type:* AzureDiskPersistentVolumeCachingMode - *Default:* AzureDiskPersistentVolumeCachingMode.NONE. Host Caching mode. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string - *Default:* 'ext4' Filesystem type to mount. Must be a filesystem type supported by the host operating system. --- ##### `kind`^Optional ```typescript public readonly kind: AzureDiskPersistentVolumeKind; ``` - *Type:* AzureDiskPersistentVolumeKind - *Default:* AzureDiskPersistentVolumeKind.SHARED Kind of disk. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false Force the ReadOnly setting in VolumeMounts. --- ### AzureDiskVolumeOptions Options of `Volume.fromAzureDisk`. #### Initializer ```typescript import { AzureDiskVolumeOptions } from 'cdk8s-plus-32' const azureDiskVolumeOptions: AzureDiskVolumeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cachingMode | AzureDiskPersistentVolumeCachingMode | Host Caching mode. | | fsType | string | Filesystem type to mount. | | kind | AzureDiskPersistentVolumeKind | Kind of disk. | | name | string | The volume name. | | readOnly | boolean | Force the ReadOnly setting in VolumeMounts. | --- ##### `cachingMode`^Optional ```typescript public readonly cachingMode: AzureDiskPersistentVolumeCachingMode; ``` - *Type:* AzureDiskPersistentVolumeCachingMode - *Default:* AzureDiskPersistentVolumeCachingMode.NONE. Host Caching mode. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string - *Default:* 'ext4' Filesystem type to mount. Must be a filesystem type supported by the host operating system. --- ##### `kind`^Optional ```typescript public readonly kind: AzureDiskPersistentVolumeKind; ``` - *Type:* AzureDiskPersistentVolumeKind - *Default:* AzureDiskPersistentVolumeKind.SHARED Kind of disk. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* auto-generated The volume name. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false Force the ReadOnly setting in VolumeMounts. --- ### AzureDiskVolumeSource AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const azureDiskVolumeSource: k8s.AzureDiskVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | diskName | string | diskName is the Name of the data disk in the blob storage. | | diskUri | string | diskURI is the URI of data disk in the blob storage. | | cachingMode | string | cachingMode is the Host Caching mode: None, Read Only, Read Write. | | fsType | string | fsType is Filesystem type to mount. | | kind | string | kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). | | readOnly | boolean | readOnly Defaults to false (read/write). | --- ##### `diskName`^Required ```typescript public readonly diskName: string; ``` - *Type:* string diskName is the Name of the data disk in the blob storage. --- ##### `diskUri`^Required ```typescript public readonly diskUri: string; ``` - *Type:* string diskURI is the URI of data disk in the blob storage. --- ##### `cachingMode`^Optional ```typescript public readonly cachingMode: string; ``` - *Type:* string cachingMode is the Host Caching mode: None, Read Only, Read Write. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. --- ##### `kind`^Optional ```typescript public readonly kind: string; ``` - *Type:* string kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ### AzureFilePersistentVolumeSource AzureFile represents an Azure File Service mount on the host and bind mount to the pod. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const azureFilePersistentVolumeSource: k8s.AzureFilePersistentVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | secretName | string | secretName is the name of secret that contains Azure Storage Account Name and Key. | | shareName | string | shareName is the azure Share Name. | | readOnly | boolean | readOnly defaults to false (read/write). | | secretNamespace | string | secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod. | --- ##### `secretName`^Required ```typescript public readonly secretName: string; ``` - *Type:* string secretName is the name of secret that contains Azure Storage Account Name and Key. --- ##### `shareName`^Required ```typescript public readonly shareName: string; ``` - *Type:* string shareName is the azure Share Name. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ##### `secretNamespace`^Optional ```typescript public readonly secretNamespace: string; ``` - *Type:* string secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod. --- ### AzureFileVolumeSource AzureFile represents an Azure File Service mount on the host and bind mount to the pod. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const azureFileVolumeSource: k8s.AzureFileVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | secretName | string | secretName is the name of secret that contains Azure Storage Account Name and Key. | | shareName | string | shareName is the azure share Name. | | readOnly | boolean | readOnly defaults to false (read/write). | --- ##### `secretName`^Required ```typescript public readonly secretName: string; ``` - *Type:* string secretName is the name of secret that contains Azure Storage Account Name and Key. --- ##### `shareName`^Required ```typescript public readonly shareName: string; ``` - *Type:* string shareName is the azure share Name. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ### BasicAuthSecretProps Options for `BasicAuthSecret`. #### Initializer ```typescript import { BasicAuthSecretProps } from 'cdk8s-plus-32' const basicAuthSecretProps: BasicAuthSecretProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | password | string | The password or token for authentication. | | username | string | The user name for authentication. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional ```typescript public readonly immutable: boolean; ``` - *Type:* boolean - *Default:* false If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. --- ##### `password`^Required ```typescript public readonly password: string; ``` - *Type:* string The password or token for authentication. --- ##### `username`^Required ```typescript public readonly username: string; ``` - *Type:* string The user name for authentication. --- ### BasicDeviceV1Alpha3 BasicDevice defines one device instance. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const basicDeviceV1Alpha3: k8s.BasicDeviceV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | {[ key: string ]: cdk8s-plus-32.k8s.DeviceAttributeV1Alpha3} | Attributes defines the set of attributes for this device. | | capacity | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | Capacity defines the set of capacities for this device. | --- ##### `attributes`^Optional ```typescript public readonly attributes: {[ key: string ]: DeviceAttributeV1Alpha3}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.DeviceAttributeV1Alpha3} Attributes defines the set of attributes for this device. The name of each attribute must be unique in that set. The maximum number of attributes and capacities combined is 32. --- ##### `capacity`^Optional ```typescript public readonly capacity: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} Capacity defines the set of capacities for this device. The name of each capacity must be unique in that set. The maximum number of attributes and capacities combined is 32. --- ### BasicDeviceV1Beta1 BasicDevice defines one device instance. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const basicDeviceV1Beta1: k8s.BasicDeviceV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | {[ key: string ]: cdk8s-plus-32.k8s.DeviceAttributeV1Beta1} | Attributes defines the set of attributes for this device. | | capacity | {[ key: string ]: cdk8s-plus-32.k8s.DeviceCapacityV1Beta1} | Capacity defines the set of capacities for this device. | --- ##### `attributes`^Optional ```typescript public readonly attributes: {[ key: string ]: DeviceAttributeV1Beta1}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.DeviceAttributeV1Beta1} Attributes defines the set of attributes for this device. The name of each attribute must be unique in that set. The maximum number of attributes and capacities combined is 32. --- ##### `capacity`^Optional ```typescript public readonly capacity: {[ key: string ]: DeviceCapacityV1Beta1}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.DeviceCapacityV1Beta1} Capacity defines the set of capacities for this device. The name of each capacity must be unique in that set. The maximum number of attributes and capacities combined is 32. --- ### BoundObjectReference BoundObjectReference is a reference to an object that a token is bound to. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const boundObjectReference: k8s.BoundObjectReference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | API version of the referent. | | kind | string | Kind of the referent. | | name | string | Name of the referent. | | uid | string | UID of the referent. | --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string API version of the referent. --- ##### `kind`^Optional ```typescript public readonly kind: string; ``` - *Type:* string Kind of the referent. Valid kinds are 'Pod' and 'Secret'. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the referent. --- ##### `uid`^Optional ```typescript public readonly uid: string; ``` - *Type:* string UID of the referent. --- ### Capabilities Adds and removes POSIX capabilities from running containers. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const capabilities: k8s.Capabilities = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | add | string[] | Added capabilities. | | drop | string[] | Removed capabilities. | --- ##### `add`^Optional ```typescript public readonly add: string[]; ``` - *Type:* string[] Added capabilities. --- ##### `drop`^Optional ```typescript public readonly drop: string[]; ``` - *Type:* string[] Removed capabilities. --- ### CelDeviceSelectorV1Alpha3 CELDeviceSelector contains a CEL expression for selecting a device. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const celDeviceSelectorV1Alpha3: k8s.CelDeviceSelectorV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | Expression is a CEL expression which evaluates a single device. | --- ##### `expression`^Required ```typescript public readonly expression: string; ``` - *Type:* string Expression is a CEL expression which evaluates a single device. It must evaluate to true when the device under consideration satisfies the desired criteria, and false when it does not. Any other result is an error and causes allocation of devices to abort. The expression's input is an object named "device", which carries the following properties: - driver (string): the name of the driver which defines this device. - attributes (map[string]object): the device's attributes, grouped by prefix (e.g. device.attributes["dra.example.com"] evaluates to an object with all of the attributes which were prefixed by "dra.example.com". - capacity (map[string]object): the device's capacities, grouped by prefix. Example: Consider a device with driver="dra.example.com", which exposes two attributes named "model" and "ext.example.com/family" and which exposes one capacity named "modules". This input to this expression would have the following fields: device.driver device.attributes["dra.example.com"].model device.attributes["ext.example.com"].family device.capacity["dra.example.com"].modules The device.driver field can be used to check for a specific driver, either as a high-level precondition (i.e. you only want to consider devices from this driver) or as part of a multi-clause expression that is meant to consider devices from different drivers. The value type of each attribute is defined by the device definition, and users who write these expressions must consult the documentation for their specific drivers. The value type of each capacity is Quantity. If an unknown prefix is used as a lookup in either device.attributes or device.capacity, an empty map will be returned. Any reference to an unknown field will cause an evaluation error and allocation to abort. A robust expression should check for the existence of attributes before referencing them. For ease of use, the cel.bind() function is enabled, and can be used to simplify expressions that access multiple attributes with the same domain. For example: cel.bind(dra, device.attributes["dra.example.com"], dra.someBool && dra.anotherBool) The length of the expression must be smaller or equal to 10 Ki. The cost of evaluating it is also limited based on the estimated number of logical steps. --- ### CelDeviceSelectorV1Beta1 CELDeviceSelector contains a CEL expression for selecting a device. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const celDeviceSelectorV1Beta1: k8s.CelDeviceSelectorV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | Expression is a CEL expression which evaluates a single device. | --- ##### `expression`^Required ```typescript public readonly expression: string; ``` - *Type:* string Expression is a CEL expression which evaluates a single device. It must evaluate to true when the device under consideration satisfies the desired criteria, and false when it does not. Any other result is an error and causes allocation of devices to abort. The expression's input is an object named "device", which carries the following properties: - driver (string): the name of the driver which defines this device. - attributes (map[string]object): the device's attributes, grouped by prefix (e.g. device.attributes["dra.example.com"] evaluates to an object with all of the attributes which were prefixed by "dra.example.com". - capacity (map[string]object): the device's capacities, grouped by prefix. Example: Consider a device with driver="dra.example.com", which exposes two attributes named "model" and "ext.example.com/family" and which exposes one capacity named "modules". This input to this expression would have the following fields: device.driver device.attributes["dra.example.com"].model device.attributes["ext.example.com"].family device.capacity["dra.example.com"].modules The device.driver field can be used to check for a specific driver, either as a high-level precondition (i.e. you only want to consider devices from this driver) or as part of a multi-clause expression that is meant to consider devices from different drivers. The value type of each attribute is defined by the device definition, and users who write these expressions must consult the documentation for their specific drivers. The value type of each capacity is Quantity. If an unknown prefix is used as a lookup in either device.attributes or device.capacity, an empty map will be returned. Any reference to an unknown field will cause an evaluation error and allocation to abort. A robust expression should check for the existence of attributes before referencing them. For ease of use, the cel.bind() function is enabled, and can be used to simplify expressions that access multiple attributes with the same domain. For example: cel.bind(dra, device.attributes["dra.example.com"], dra.someBool && dra.anotherBool) The length of the expression must be smaller or equal to 10 Ki. The cost of evaluating it is also limited based on the estimated number of logical steps. --- ### CephFsPersistentVolumeSource Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const cephFsPersistentVolumeSource: k8s.CephFsPersistentVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | monitors | string[] | monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. | | path | string | path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /. | | readOnly | boolean | readOnly is Optional: Defaults to false (read/write). | | secretFile | string | secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. | | secretRef | cdk8s-plus-32.k8s.SecretReference | secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. | | user | string | user is Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. | --- ##### `monitors`^Required ```typescript public readonly monitors: string[]; ``` - *Type:* string[] monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. --- ##### `path`^Optional ```typescript public readonly path: string; ``` - *Type:* string path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it --- ##### `secretFile`^Optional ```typescript public readonly secretFile: string; ``` - *Type:* string secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. --- ##### `secretRef`^Optional ```typescript public readonly secretRef: SecretReference; ``` - *Type:* cdk8s-plus-32.k8s.SecretReference secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it --- ##### `user`^Optional ```typescript public readonly user: string; ``` - *Type:* string user is Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. --- ### CephFsVolumeSource Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const cephFsVolumeSource: k8s.CephFsVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | monitors | string[] | monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. | | path | string | path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /. | | readOnly | boolean | readOnly is Optional: Defaults to false (read/write). | | secretFile | string | secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. | | secretRef | cdk8s-plus-32.k8s.LocalObjectReference | secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. | | user | string | user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. | --- ##### `monitors`^Required ```typescript public readonly monitors: string[]; ``` - *Type:* string[] monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. --- ##### `path`^Optional ```typescript public readonly path: string; ``` - *Type:* string path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it --- ##### `secretFile`^Optional ```typescript public readonly secretFile: string; ``` - *Type:* string secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. --- ##### `secretRef`^Optional ```typescript public readonly secretRef: LocalObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.LocalObjectReference secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it --- ##### `user`^Optional ```typescript public readonly user: string; ``` - *Type:* string user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. --- ### CertificateSigningRequestSpec CertificateSigningRequestSpec contains the certificate request. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const certificateSigningRequestSpec: k8s.CertificateSigningRequestSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | request | string | request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. | | signerName | string | signerName indicates the requested signer, and is a qualified name. | | expirationSeconds | number | expirationSeconds is the requested duration of validity of the issued certificate. | | extra | {[ key: string ]: string[]} | extra contains extra attributes of the user that created the CertificateSigningRequest. | | groups | string[] | groups contains group membership of the user that created the CertificateSigningRequest. | | uid | string | uid contains the uid of the user that created the CertificateSigningRequest. | | usages | string[] | usages specifies a set of key usages requested in the issued certificate. | | username | string | username contains the name of the user that created the CertificateSigningRequest. | --- ##### `request`^Required ```typescript public readonly request: string; ``` - *Type:* string request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. When serialized as JSON or YAML, the data is additionally base64-encoded. --- ##### `signerName`^Required ```typescript public readonly signerName: string; ``` - *Type:* string signerName indicates the requested signer, and is a qualified name. List/watch requests for CertificateSigningRequests can filter on this field using a "spec.signerName=NAME" fieldSelector. Well-known Kubernetes signers are: 1. "kubernetes.io/kube-apiserver-client": issues client certificates that can be used to authenticate to kube-apiserver. Requests for this signer are never auto-approved by kube-controller-manager, can be issued by the "csrsigning" controller in kube-controller-manager. 2. "kubernetes.io/kube-apiserver-client-kubelet": issues client certificates that kubelets use to authenticate to kube-apiserver. Requests for this signer can be auto-approved by the "csrapproving" controller in kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. 3. "kubernetes.io/kubelet-serving" issues serving certificates that kubelets use to serve TLS endpoints, which kube-apiserver can connect to securely. Requests for this signer are never auto-approved by kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. More details are available at https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers Custom signerNames can also be specified. The signer defines: 1. Trust distribution: how trust (CA bundles) are distributed. 2. Permitted subjects: and behavior when a disallowed subject is requested. 3. Required, permitted, or forbidden x509 extensions in the request (including whether subjectAltNames are allowed, which types, restrictions on allowed values) and behavior when a disallowed extension is requested. 4. Required, permitted, or forbidden key usages / extended key usages. 5. Expiration/certificate lifetime: whether it is fixed by the signer, configurable by the admin. 6. Whether or not requests for CA certificates are allowed. --- ##### `expirationSeconds`^Optional ```typescript public readonly expirationSeconds: number; ``` - *Type:* number expirationSeconds is the requested duration of validity of the issued certificate. The certificate signer may issue a certificate with a different validity duration so a client must check the delta between the notBefore and and notAfter fields in the issued certificate to determine the actual duration. The v1.22+ in-tree implementations of the well-known Kubernetes signers will honor this field as long as the requested duration is not greater than the maximum duration they will honor per the --cluster-signing-duration CLI flag to the Kubernetes controller manager. Certificate signers may not honor this field for various reasons: 1. Old signer that is unaware of the field (such as the in-tree implementations prior to v1.22) 2. Signer whose configured maximum is shorter than the requested duration 3. Signer whose configured minimum is longer than the requested duration The minimum valid value for expirationSeconds is 600, i.e. 10 minutes. --- ##### `extra`^Optional ```typescript public readonly extra: {[ key: string ]: string[]}; ``` - *Type:* {[ key: string ]: string[]} extra contains extra attributes of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. --- ##### `groups`^Optional ```typescript public readonly groups: string[]; ``` - *Type:* string[] groups contains group membership of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. --- ##### `uid`^Optional ```typescript public readonly uid: string; ``` - *Type:* string uid contains the uid of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. --- ##### `usages`^Optional ```typescript public readonly usages: string[]; ``` - *Type:* string[] usages specifies a set of key usages requested in the issued certificate. Requests for TLS client certificates typically request: "digital signature", "key encipherment", "client auth". Requests for TLS serving certificates typically request: "key encipherment", "digital signature", "server auth". Valid values are: "signing", "digital signature", "content commitment", "key encipherment", "key agreement", "data encipherment", "cert sign", "crl sign", "encipher only", "decipher only", "any", "server auth", "client auth", "code signing", "email protection", "s/mime", "ipsec end system", "ipsec tunnel", "ipsec user", "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc" --- ##### `username`^Optional ```typescript public readonly username: string; ``` - *Type:* string username contains the name of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. --- ### CinderPersistentVolumeSource Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const cinderPersistentVolumeSource: k8s.CinderPersistentVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | volumeId | string | volumeID used to identify the volume in cinder. | | fsType | string | fsType Filesystem type to mount. | | readOnly | boolean | readOnly is Optional: Defaults to false (read/write). | | secretRef | cdk8s-plus-32.k8s.SecretReference | secretRef is Optional: points to a secret object containing parameters used to connect to OpenStack. | --- ##### `volumeId`^Required ```typescript public readonly volumeId: string; ``` - *Type:* string volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md --- ##### `secretRef`^Optional ```typescript public readonly secretRef: SecretReference; ``` - *Type:* cdk8s-plus-32.k8s.SecretReference secretRef is Optional: points to a secret object containing parameters used to connect to OpenStack. --- ### CinderVolumeSource Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const cinderVolumeSource: k8s.CinderVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | volumeId | string | volumeID used to identify the volume in cinder. | | fsType | string | fsType is the filesystem type to mount. | | readOnly | boolean | readOnly defaults to false (read/write). | | secretRef | cdk8s-plus-32.k8s.LocalObjectReference | secretRef is optional: points to a secret object containing parameters used to connect to OpenStack. | --- ##### `volumeId`^Required ```typescript public readonly volumeId: string; ``` - *Type:* string volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md --- ##### `secretRef`^Optional ```typescript public readonly secretRef: LocalObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.LocalObjectReference secretRef is optional: points to a secret object containing parameters used to connect to OpenStack. --- ### ClientIpConfig ClientIPConfig represents the configurations of Client IP based session affinity. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const clientIpConfig: k8s.ClientIpConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | timeoutSeconds | number | timeoutSeconds specifies the seconds of ClientIP type session sticky time. | --- ##### `timeoutSeconds`^Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). --- ### ClusterRoleBindingProps Properties for `ClusterRoleBinding`. #### Initializer ```typescript import { ClusterRoleBindingProps } from 'cdk8s-plus-32' const clusterRoleBindingProps: ClusterRoleBindingProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | role | IClusterRole | The role to bind to. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `role`^Required ```typescript public readonly role: IClusterRole; ``` - *Type:* IClusterRole The role to bind to. --- ### ClusterRolePolicyRule Policy rule of a `ClusterRole. #### Initializer ```typescript import { ClusterRolePolicyRule } from 'cdk8s-plus-32' const clusterRolePolicyRule: ClusterRolePolicyRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endpoints | IApiEndpoint[] | Endpoints this rule applies to. | | verbs | string[] | Verbs to allow. | --- ##### `endpoints`^Required ```typescript public readonly endpoints: IApiEndpoint[]; ``` - *Type:* IApiEndpoint[] Endpoints this rule applies to. Can be either api resources or non api resources. --- ##### `verbs`^Required ```typescript public readonly verbs: string[]; ``` - *Type:* string[] Verbs to allow. (e.g ['get', 'watch']) --- ### ClusterRoleProps Properties for `ClusterRole`. #### Initializer ```typescript import { ClusterRoleProps } from 'cdk8s-plus-32' const clusterRoleProps: ClusterRoleProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | aggregationLabels | {[ key: string ]: string} | Specify labels that should be used to locate ClusterRoles, whose rules will be automatically filled into this ClusterRole's rules. | | rules | ClusterRolePolicyRule[] | A list of rules the role should allow. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `aggregationLabels`^Optional ```typescript public readonly aggregationLabels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Specify labels that should be used to locate ClusterRoles, whose rules will be automatically filled into this ClusterRole's rules. --- ##### `rules`^Optional ```typescript public readonly rules: ClusterRolePolicyRule[]; ``` - *Type:* ClusterRolePolicyRule[] - *Default:* [] A list of rules the role should allow. --- ### ClusterTrustBundleProjection ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const clusterTrustBundleProjection: k8s.ClusterTrustBundleProjection = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | string | Relative path from the volume root to write the bundle. | | labelSelector | cdk8s-plus-32.k8s.LabelSelector | Select all ClusterTrustBundles that match this label selector. | | name | string | Select a single ClusterTrustBundle by object name. | | optional | boolean | If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. | | signerName | string | Select all ClusterTrustBundles that match this signer name. | --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string Relative path from the volume root to write the bundle. --- ##### `labelSelector`^Optional ```typescript public readonly labelSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything". --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector. --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles. --- ##### `signerName`^Optional ```typescript public readonly signerName: string; ``` - *Type:* string Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated. --- ### ClusterTrustBundleSpecV1Alpha1 ClusterTrustBundleSpec contains the signer and trust anchors. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const clusterTrustBundleSpecV1Alpha1: k8s.ClusterTrustBundleSpecV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | trustBundle | string | trustBundle contains the individual X.509 trust anchors for this bundle, as PEM bundle of PEM-wrapped, DER-formatted X.509 certificates. | | signerName | string | signerName indicates the associated signer, if any. | --- ##### `trustBundle`^Required ```typescript public readonly trustBundle: string; ``` - *Type:* string trustBundle contains the individual X.509 trust anchors for this bundle, as PEM bundle of PEM-wrapped, DER-formatted X.509 certificates. The data must consist only of PEM certificate blocks that parse as valid X.509 certificates. Each certificate must include a basic constraints extension with the CA bit set. The API server will reject objects that contain duplicate certificates, or that use PEM block headers. Users of ClusterTrustBundles, including Kubelet, are free to reorder and deduplicate certificate blocks in this file according to their own logic, as well as to drop PEM block headers and inter-block data. --- ##### `signerName`^Optional ```typescript public readonly signerName: string; ``` - *Type:* string signerName indicates the associated signer, if any. In order to create or update a ClusterTrustBundle that sets signerName, you must have the following cluster-scoped permission: group=certificates.k8s.io resource=signers resourceName= verb=attest. If signerName is not empty, then the ClusterTrustBundle object must be named with the signer name as a prefix (translating slashes to colons). For example, for the signer name `example.com/foo`, valid ClusterTrustBundle object names include `example.com:foo:abc` and `example.com:foo:v1`. If signerName is empty, then the ClusterTrustBundle object's name must not have such a prefix. List/watch requests for ClusterTrustBundles can filter on this field using a `spec.signerName=NAME` field selector. --- ### CommandProbeOptions Options for `Probe.fromCommand()`. #### Initializer ```typescript import { CommandProbeOptions } from 'cdk8s-plus-32' const commandProbeOptions: CommandProbeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | failureThreshold | number | Minimum consecutive failures for the probe to be considered failed after having succeeded. | | initialDelaySeconds | cdk8s.Duration | Number of seconds after the container has started before liveness probes are initiated. | | periodSeconds | cdk8s.Duration | How often (in seconds) to perform the probe. | | successThreshold | number | Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. | | timeoutSeconds | cdk8s.Duration | Number of seconds after which the probe times out. | --- ##### `failureThreshold`^Optional ```typescript public readonly failureThreshold: number; ``` - *Type:* number - *Default:* 3 Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. --- ##### `initialDelaySeconds`^Optional ```typescript public readonly initialDelaySeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* immediate Number of seconds after the container has started before liveness probes are initiated. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes) --- ##### `periodSeconds`^Optional ```typescript public readonly periodSeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(10) Minimum value is 1. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. --- ##### `successThreshold`^Optional ```typescript public readonly successThreshold: number; ``` - *Type:* number - *Default:* 1 Must be 1 for liveness and startup. Minimum value is 1. Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. --- ##### `timeoutSeconds`^Optional ```typescript public readonly timeoutSeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(1) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes) --- ### CommonSecretProps Common properties for `Secret`. #### Initializer ```typescript import { CommonSecretProps } from 'cdk8s-plus-32' const commonSecretProps: CommonSecretProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional ```typescript public readonly immutable: boolean; ``` - *Type:* boolean - *Default:* false If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. --- ### ComponentCondition Information about the condition of a component. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const componentCondition: k8s.ComponentCondition = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | status | string | Status of the condition for a component. | | type | string | Type of condition for a component. | | error | string | Condition error code for a component. | | message | string | Message about the condition for a component. | --- ##### `status`^Required ```typescript public readonly status: string; ``` - *Type:* string Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string Type of condition for a component. Valid value: "Healthy" --- ##### `error`^Optional ```typescript public readonly error: string; ``` - *Type:* string Condition error code for a component. For example, a health check error code. --- ##### `message`^Optional ```typescript public readonly message: string; ``` - *Type:* string Message about the condition for a component. For example, information about a health check. --- ### ConfigMapEnvSource ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const configMapEnvSource: k8s.ConfigMapEnvSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name of the referent. | | optional | boolean | Specify whether the ConfigMap must be defined. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean Specify whether the ConfigMap must be defined. --- ### ConfigMapKeySelector Selects a key from a ConfigMap. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const configMapKeySelector: k8s.ConfigMapKeySelector = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | The key to select. | | name | string | Name of the referent. | | optional | boolean | Specify whether the ConfigMap or its key must be defined. | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string The key to select. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean Specify whether the ConfigMap or its key must be defined. --- ### ConfigMapNodeConfigSource ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const configMapNodeConfigSource: k8s.ConfigMapNodeConfigSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | kubeletConfigKey | string | KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. | | name | string | Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. | | namespace | string | Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. | | resourceVersion | string | ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. | | uid | string | UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. | --- ##### `kubeletConfigKey`^Required ```typescript public readonly kubeletConfigKey: string; ``` - *Type:* string KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. --- ##### `namespace`^Required ```typescript public readonly namespace: string; ``` - *Type:* string Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. --- ##### `resourceVersion`^Optional ```typescript public readonly resourceVersion: string; ``` - *Type:* string ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. --- ##### `uid`^Optional ```typescript public readonly uid: string; ``` - *Type:* string UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. --- ### ConfigMapProjection Adapts a ConfigMap into a projected volume. The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const configMapProjection: k8s.ConfigMapProjection = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KeyToPath[] | items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. | | name | string | Name of the referent. | | optional | boolean | optional specify whether the ConfigMap or its keys must be defined. | --- ##### `items`^Optional ```typescript public readonly items: KeyToPath[]; ``` - *Type:* cdk8s-plus-32.k8s.KeyToPath[] items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean optional specify whether the ConfigMap or its keys must be defined. --- ### ConfigMapProps Properties for initialization of `ConfigMap`. #### Initializer ```typescript import { ConfigMapProps } from 'cdk8s-plus-32' const configMapProps: ConfigMapProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | binaryData | {[ key: string ]: string} | BinaryData contains the binary data. | | data | {[ key: string ]: string} | Data contains the configuration data. | | immutable | boolean | If set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `binaryData`^Optional ```typescript public readonly binaryData: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. You can also add binary data using `configMap.addBinaryData()`. --- ##### `data`^Optional ```typescript public readonly data: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process. You can also add data using `configMap.addData()`. --- ##### `immutable`^Optional ```typescript public readonly immutable: boolean; ``` - *Type:* boolean - *Default:* false If set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. --- ### ConfigMapVolumeOptions Options for the ConfigMap-based volume. #### Initializer ```typescript import { ConfigMapVolumeOptions } from 'cdk8s-plus-32' const configMapVolumeOptions: ConfigMapVolumeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultMode | number | Mode bits to use on created files by default. | | items | {[ key: string ]: PathMapping} | If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. | | name | string | The volume name. | | optional | boolean | Specify whether the ConfigMap or its keys must be defined. | --- ##### `defaultMode`^Optional ```typescript public readonly defaultMode: number; ``` - *Type:* number - *Default:* 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. --- ##### `items`^Optional ```typescript public readonly items: {[ key: string ]: PathMapping}; ``` - *Type:* {[ key: string ]: PathMapping} - *Default:* no mapping If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* auto-generated The volume name. --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean - *Default:* undocumented Specify whether the ConfigMap or its keys must be defined. --- ### ConfigMapVolumeSource Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const configMapVolumeSource: k8s.ConfigMapVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultMode | number | defaultMode is optional: mode bits used to set permissions on created files by default. | | items | cdk8s-plus-32.k8s.KeyToPath[] | items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. | | name | string | Name of the referent. | | optional | boolean | optional specify whether the ConfigMap or its keys must be defined. | --- ##### `defaultMode`^Optional ```typescript public readonly defaultMode: number; ``` - *Type:* number - *Default:* 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. --- ##### `items`^Optional ```typescript public readonly items: KeyToPath[]; ``` - *Type:* cdk8s-plus-32.k8s.KeyToPath[] items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean optional specify whether the ConfigMap or its keys must be defined. --- ### Container A single application container that you want to run within a pod. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const container: k8s.Container = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name of the container specified as a DNS_LABEL. | | args | string[] | Arguments to the entrypoint. | | command | string[] | Entrypoint array. | | env | cdk8s-plus-32.k8s.EnvVar[] | List of environment variables to set in the container. | | envFrom | cdk8s-plus-32.k8s.EnvFromSource[] | List of sources to populate environment variables in the container. | | image | string | Container image name. | | imagePullPolicy | string | Image pull policy. | | lifecycle | cdk8s-plus-32.k8s.Lifecycle | Actions that the management system should take in response to container lifecycle events. | | livenessProbe | cdk8s-plus-32.k8s.Probe | Periodic probe of container liveness. | | ports | cdk8s-plus-32.k8s.ContainerPort[] | List of ports to expose from the container. | | readinessProbe | cdk8s-plus-32.k8s.Probe | Periodic probe of container service readiness. | | resizePolicy | cdk8s-plus-32.k8s.ContainerResizePolicy[] | Resources resize policy for the container. | | resources | cdk8s-plus-32.k8s.ResourceRequirements | Compute Resources required by this container. | | restartPolicy | string | RestartPolicy defines the restart behavior of individual containers in a pod. | | securityContext | cdk8s-plus-32.k8s.SecurityContext | SecurityContext defines the security options the container should be run with. | | startupProbe | cdk8s-plus-32.k8s.Probe | StartupProbe indicates that the Pod has successfully initialized. | | stdin | boolean | Whether this container should allocate a buffer for stdin in the container runtime. | | stdinOnce | boolean | Whether the container runtime should close the stdin channel after it has been opened by a single attach. | | terminationMessagePath | string | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. | | terminationMessagePolicy | string | Indicate how the termination message should be populated. | | tty | boolean | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. | | volumeDevices | cdk8s-plus-32.k8s.VolumeDevice[] | volumeDevices is the list of block devices to be used by the container. | | volumeMounts | cdk8s-plus-32.k8s.VolumeMount[] | Pod volumes to mount into the container's filesystem. | | workingDir | string | Container's working directory. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. --- ##### `args`^Optional ```typescript public readonly args: string[]; ``` - *Type:* string[] Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell --- ##### `command`^Optional ```typescript public readonly command: string[]; ``` - *Type:* string[] Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell --- ##### `env`^Optional ```typescript public readonly env: EnvVar[]; ``` - *Type:* cdk8s-plus-32.k8s.EnvVar[] List of environment variables to set in the container. Cannot be updated. --- ##### `envFrom`^Optional ```typescript public readonly envFrom: EnvFromSource[]; ``` - *Type:* cdk8s-plus-32.k8s.EnvFromSource[] List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. --- ##### `image`^Optional ```typescript public readonly image: string; ``` - *Type:* string Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. --- ##### `imagePullPolicy`^Optional ```typescript public readonly imagePullPolicy: string; ``` - *Type:* string - *Default:* Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images --- ##### `lifecycle`^Optional ```typescript public readonly lifecycle: Lifecycle; ``` - *Type:* cdk8s-plus-32.k8s.Lifecycle Actions that the management system should take in response to container lifecycle events. Cannot be updated. --- ##### `livenessProbe`^Optional ```typescript public readonly livenessProbe: Probe; ``` - *Type:* cdk8s-plus-32.k8s.Probe Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes --- ##### `ports`^Optional ```typescript public readonly ports: ContainerPort[]; ``` - *Type:* cdk8s-plus-32.k8s.ContainerPort[] List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. --- ##### `readinessProbe`^Optional ```typescript public readonly readinessProbe: Probe; ``` - *Type:* cdk8s-plus-32.k8s.Probe Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes --- ##### `resizePolicy`^Optional ```typescript public readonly resizePolicy: ContainerResizePolicy[]; ``` - *Type:* cdk8s-plus-32.k8s.ContainerResizePolicy[] Resources resize policy for the container. --- ##### `resources`^Optional ```typescript public readonly resources: ResourceRequirements; ``` - *Type:* cdk8s-plus-32.k8s.ResourceRequirements Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: string; ``` - *Type:* string RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. --- ##### `securityContext`^Optional ```typescript public readonly securityContext: SecurityContext; ``` - *Type:* cdk8s-plus-32.k8s.SecurityContext SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ --- ##### `startupProbe`^Optional ```typescript public readonly startupProbe: Probe; ``` - *Type:* cdk8s-plus-32.k8s.Probe StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes --- ##### `stdin`^Optional ```typescript public readonly stdin: boolean; ``` - *Type:* boolean - *Default:* false. Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. --- ##### `stdinOnce`^Optional ```typescript public readonly stdinOnce: boolean; ``` - *Type:* boolean - *Default:* false Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false --- ##### `terminationMessagePath`^Optional ```typescript public readonly terminationMessagePath: string; ``` - *Type:* string - *Default:* dev/termination-log. Cannot be updated. Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. --- ##### `terminationMessagePolicy`^Optional ```typescript public readonly terminationMessagePolicy: string; ``` - *Type:* string - *Default:* File. Cannot be updated. Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. --- ##### `tty`^Optional ```typescript public readonly tty: boolean; ``` - *Type:* boolean - *Default:* false. Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. --- ##### `volumeDevices`^Optional ```typescript public readonly volumeDevices: VolumeDevice[]; ``` - *Type:* cdk8s-plus-32.k8s.VolumeDevice[] volumeDevices is the list of block devices to be used by the container. --- ##### `volumeMounts`^Optional ```typescript public readonly volumeMounts: VolumeMount[]; ``` - *Type:* cdk8s-plus-32.k8s.VolumeMount[] Pod volumes to mount into the container's filesystem. Cannot be updated. --- ##### `workingDir`^Optional ```typescript public readonly workingDir: string; ``` - *Type:* string Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. --- ### ContainerLifecycle Container lifecycle properties. #### Initializer ```typescript import { ContainerLifecycle } from 'cdk8s-plus-32' const containerLifecycle: ContainerLifecycle = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | postStart | Handler | This hook is executed immediately after a container is created. | | preStop | Handler | This hook is called immediately before a container is terminated due to an API request or management event such as a liveness/startup probe failure, preemption, resource contention and others. | --- ##### `postStart`^Optional ```typescript public readonly postStart: Handler; ``` - *Type:* Handler - *Default:* No post start handler. This hook is executed immediately after a container is created. However, there is no guarantee that the hook will execute before the container ENTRYPOINT. --- ##### `preStop`^Optional ```typescript public readonly preStop: Handler; ``` - *Type:* Handler - *Default:* No pre stop handler. This hook is called immediately before a container is terminated due to an API request or management event such as a liveness/startup probe failure, preemption, resource contention and others. A call to the PreStop hook fails if the container is already in a terminated or completed state and the hook must complete before the TERM signal to stop the container can be sent. The Pod's termination grace period countdown begins before the PreStop hook is executed, so regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. No parameters are passed to the handler. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination) --- ### ContainerOpts Optional properties of a container. #### Initializer ```typescript import { ContainerOpts } from 'cdk8s-plus-32' const containerOpts: ContainerOpts = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | args | string[] | Arguments to the entrypoint. The docker image's CMD is used if `command` is not provided. | | command | string[] | Entrypoint array. | | envFrom | EnvFrom[] | List of sources to populate environment variables in the container. | | envVariables | {[ key: string ]: EnvValue} | Environment variables to set in the container. | | imagePullPolicy | ImagePullPolicy | Image pull policy for this container. | | lifecycle | ContainerLifecycle | Describes actions that the management system should take in response to container lifecycle events. | | liveness | Probe | Periodic probe of container liveness. | | name | string | Name of the container specified as a DNS_LABEL. | | port | number | *No description.* | | portNumber | number | Number of port to expose on the pod's IP address. | | ports | ContainerPort[] | List of ports to expose from this container. | | readiness | Probe | Determines when the container is ready to serve traffic. | | resources | ContainerResources | Compute resources (CPU and memory requests and limits) required by the container. | | restartPolicy | ContainerRestartPolicy | Kubelet will start init containers with restartPolicy=Always in the order with other init containers, but instead of waiting for its completion, it will wait for the container startup completion Currently, only accepted value is Always. | | securityContext | ContainerSecurityContextProps | SecurityContext defines the security options the container should be run with. | | startup | Probe | StartupProbe indicates that the Pod has successfully initialized. | | volumeMounts | VolumeMount[] | Pod volumes to mount into the container's filesystem. | | workingDir | string | Container's working directory. | --- ##### `args`^Optional ```typescript public readonly args: string[]; ``` - *Type:* string[] - *Default:* [] Arguments to the entrypoint. The docker image's CMD is used if `command` is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. > [https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell) --- ##### `command`^Optional ```typescript public readonly command: string[]; ``` - *Type:* string[] - *Default:* The docker image's ENTRYPOINT. Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell --- ##### `envFrom`^Optional ```typescript public readonly envFrom: EnvFrom[]; ``` - *Type:* EnvFrom[] - *Default:* No sources. List of sources to populate environment variables in the container. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by the `envVariables` property with a duplicate key will take precedence. --- ##### `envVariables`^Optional ```typescript public readonly envVariables: {[ key: string ]: EnvValue}; ``` - *Type:* {[ key: string ]: EnvValue} - *Default:* No environment variables. Environment variables to set in the container. --- ##### `imagePullPolicy`^Optional ```typescript public readonly imagePullPolicy: ImagePullPolicy; ``` - *Type:* ImagePullPolicy - *Default:* ImagePullPolicy.ALWAYS Image pull policy for this container. --- ##### `lifecycle`^Optional ```typescript public readonly lifecycle: ContainerLifecycle; ``` - *Type:* ContainerLifecycle Describes actions that the management system should take in response to container lifecycle events. --- ##### `liveness`^Optional ```typescript public readonly liveness: Probe; ``` - *Type:* Probe - *Default:* no liveness probe is defined Periodic probe of container liveness. Container will be restarted if the probe fails. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* 'main' Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. --- ##### ~~`port`~~^Optional - *Deprecated:* - use `portNumber`. ```typescript public readonly port: number; ``` - *Type:* number --- ##### `portNumber`^Optional ```typescript public readonly portNumber: number; ``` - *Type:* number - *Default:* Only the ports mentiond in the `ports` property are exposed. Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. This is a convinience property if all you need a single TCP numbered port. In case more advanced configuartion is required, use the `ports` property. This port is added to the list of ports mentioned in the `ports` property. --- ##### `ports`^Optional ```typescript public readonly ports: ContainerPort[]; ``` - *Type:* ContainerPort[] - *Default:* Only the port mentioned in the `portNumber` property is exposed. List of ports to expose from this container. --- ##### `readiness`^Optional ```typescript public readonly readiness: Probe; ``` - *Type:* Probe - *Default:* no readiness probe is defined Determines when the container is ready to serve traffic. --- ##### `resources`^Optional ```typescript public readonly resources: ContainerResources; ``` - *Type:* ContainerResources - *Default:* cpu: request: 1000 millis limit: 1500 millis memory: request: 512 mebibytes limit: 2048 mebibytes Compute resources (CPU and memory requests and limits) required by the container. > [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: ContainerRestartPolicy; ``` - *Type:* ContainerRestartPolicy - *Default:* no restart policy is defined and the pod restart policy is applied Kubelet will start init containers with restartPolicy=Always in the order with other init containers, but instead of waiting for its completion, it will wait for the container startup completion Currently, only accepted value is Always. > [https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/](https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/) --- ##### `securityContext`^Optional ```typescript public readonly securityContext: ContainerSecurityContextProps; ``` - *Type:* ContainerSecurityContextProps - *Default:* ensureNonRoot: true privileged: false readOnlyRootFilesystem: true allowPrivilegeEscalation: false user: 25000 group: 26000 SecurityContext defines the security options the container should be run with. If set, the fields override equivalent fields of the pod's security context. > [https://kubernetes.io/docs/tasks/configure-pod-container/security-context/](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) --- ##### `startup`^Optional ```typescript public readonly startup: Probe; ``` - *Type:* Probe - *Default:* If a port is provided, then knocks on that port to determine when the container is ready for readiness and liveness probe checks. Otherwise, no startup probe is defined. StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully --- ##### `volumeMounts`^Optional ```typescript public readonly volumeMounts: VolumeMount[]; ``` - *Type:* VolumeMount[] Pod volumes to mount into the container's filesystem. Cannot be updated. --- ##### `workingDir`^Optional ```typescript public readonly workingDir: string; ``` - *Type:* string - *Default:* The container runtime's default. Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. --- ### ContainerPort Represents a network port in a single container. #### Initializer ```typescript import { ContainerPort } from 'cdk8s-plus-32' const containerPort: ContainerPort = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | number | number | Number of port to expose on the pod's IP address. | | hostIp | string | What host IP to bind the external port to. | | hostPort | number | Number of port to expose on the host. | | name | string | If specified, this must be an IANA_SVC_NAME and unique within the pod. | | protocol | Protocol | Protocol for port. | --- ##### `number`^Required ```typescript public readonly number: number; ``` - *Type:* number Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. --- ##### `hostIp`^Optional ```typescript public readonly hostIp: string; ``` - *Type:* string - *Default:* 127.0.0.1. What host IP to bind the external port to. --- ##### `hostPort`^Optional ```typescript public readonly hostPort: number; ``` - *Type:* number - *Default:* auto generated by kubernetes and might change on restarts. Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. Most containers do not need this. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* port is not named. If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. --- ##### `protocol`^Optional ```typescript public readonly protocol: Protocol; ``` - *Type:* Protocol - *Default:* Protocol.TCP Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". --- ### ContainerPort ContainerPort represents a network port in a single container. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const containerPort: k8s.ContainerPort = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | containerPort | number | Number of port to expose on the pod's IP address. | | hostIp | string | What host IP to bind the external port to. | | hostPort | number | Number of port to expose on the host. | | name | string | If specified, this must be an IANA_SVC_NAME and unique within the pod. | | protocol | string | Protocol for port. | --- ##### `containerPort`^Required ```typescript public readonly containerPort: number; ``` - *Type:* number Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. --- ##### `hostIp`^Optional ```typescript public readonly hostIp: string; ``` - *Type:* string What host IP to bind the external port to. --- ##### `hostPort`^Optional ```typescript public readonly hostPort: number; ``` - *Type:* number Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. --- ##### `protocol`^Optional ```typescript public readonly protocol: string; ``` - *Type:* string - *Default:* TCP". Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". --- ### ContainerProps Properties for creating a container. #### Initializer ```typescript import { ContainerProps } from 'cdk8s-plus-32' const containerProps: ContainerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | args | string[] | Arguments to the entrypoint. The docker image's CMD is used if `command` is not provided. | | command | string[] | Entrypoint array. | | envFrom | EnvFrom[] | List of sources to populate environment variables in the container. | | envVariables | {[ key: string ]: EnvValue} | Environment variables to set in the container. | | imagePullPolicy | ImagePullPolicy | Image pull policy for this container. | | lifecycle | ContainerLifecycle | Describes actions that the management system should take in response to container lifecycle events. | | liveness | Probe | Periodic probe of container liveness. | | name | string | Name of the container specified as a DNS_LABEL. | | port | number | *No description.* | | portNumber | number | Number of port to expose on the pod's IP address. | | ports | ContainerPort[] | List of ports to expose from this container. | | readiness | Probe | Determines when the container is ready to serve traffic. | | resources | ContainerResources | Compute resources (CPU and memory requests and limits) required by the container. | | restartPolicy | ContainerRestartPolicy | Kubelet will start init containers with restartPolicy=Always in the order with other init containers, but instead of waiting for its completion, it will wait for the container startup completion Currently, only accepted value is Always. | | securityContext | ContainerSecurityContextProps | SecurityContext defines the security options the container should be run with. | | startup | Probe | StartupProbe indicates that the Pod has successfully initialized. | | volumeMounts | VolumeMount[] | Pod volumes to mount into the container's filesystem. | | workingDir | string | Container's working directory. | | image | string | Docker image name. | --- ##### `args`^Optional ```typescript public readonly args: string[]; ``` - *Type:* string[] - *Default:* [] Arguments to the entrypoint. The docker image's CMD is used if `command` is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. > [https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell) --- ##### `command`^Optional ```typescript public readonly command: string[]; ``` - *Type:* string[] - *Default:* The docker image's ENTRYPOINT. Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell --- ##### `envFrom`^Optional ```typescript public readonly envFrom: EnvFrom[]; ``` - *Type:* EnvFrom[] - *Default:* No sources. List of sources to populate environment variables in the container. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by the `envVariables` property with a duplicate key will take precedence. --- ##### `envVariables`^Optional ```typescript public readonly envVariables: {[ key: string ]: EnvValue}; ``` - *Type:* {[ key: string ]: EnvValue} - *Default:* No environment variables. Environment variables to set in the container. --- ##### `imagePullPolicy`^Optional ```typescript public readonly imagePullPolicy: ImagePullPolicy; ``` - *Type:* ImagePullPolicy - *Default:* ImagePullPolicy.ALWAYS Image pull policy for this container. --- ##### `lifecycle`^Optional ```typescript public readonly lifecycle: ContainerLifecycle; ``` - *Type:* ContainerLifecycle Describes actions that the management system should take in response to container lifecycle events. --- ##### `liveness`^Optional ```typescript public readonly liveness: Probe; ``` - *Type:* Probe - *Default:* no liveness probe is defined Periodic probe of container liveness. Container will be restarted if the probe fails. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* 'main' Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. --- ##### ~~`port`~~^Optional - *Deprecated:* - use `portNumber`. ```typescript public readonly port: number; ``` - *Type:* number --- ##### `portNumber`^Optional ```typescript public readonly portNumber: number; ``` - *Type:* number - *Default:* Only the ports mentiond in the `ports` property are exposed. Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. This is a convinience property if all you need a single TCP numbered port. In case more advanced configuartion is required, use the `ports` property. This port is added to the list of ports mentioned in the `ports` property. --- ##### `ports`^Optional ```typescript public readonly ports: ContainerPort[]; ``` - *Type:* ContainerPort[] - *Default:* Only the port mentioned in the `portNumber` property is exposed. List of ports to expose from this container. --- ##### `readiness`^Optional ```typescript public readonly readiness: Probe; ``` - *Type:* Probe - *Default:* no readiness probe is defined Determines when the container is ready to serve traffic. --- ##### `resources`^Optional ```typescript public readonly resources: ContainerResources; ``` - *Type:* ContainerResources - *Default:* cpu: request: 1000 millis limit: 1500 millis memory: request: 512 mebibytes limit: 2048 mebibytes Compute resources (CPU and memory requests and limits) required by the container. > [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: ContainerRestartPolicy; ``` - *Type:* ContainerRestartPolicy - *Default:* no restart policy is defined and the pod restart policy is applied Kubelet will start init containers with restartPolicy=Always in the order with other init containers, but instead of waiting for its completion, it will wait for the container startup completion Currently, only accepted value is Always. > [https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/](https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/) --- ##### `securityContext`^Optional ```typescript public readonly securityContext: ContainerSecurityContextProps; ``` - *Type:* ContainerSecurityContextProps - *Default:* ensureNonRoot: true privileged: false readOnlyRootFilesystem: true allowPrivilegeEscalation: false user: 25000 group: 26000 SecurityContext defines the security options the container should be run with. If set, the fields override equivalent fields of the pod's security context. > [https://kubernetes.io/docs/tasks/configure-pod-container/security-context/](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) --- ##### `startup`^Optional ```typescript public readonly startup: Probe; ``` - *Type:* Probe - *Default:* If a port is provided, then knocks on that port to determine when the container is ready for readiness and liveness probe checks. Otherwise, no startup probe is defined. StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully --- ##### `volumeMounts`^Optional ```typescript public readonly volumeMounts: VolumeMount[]; ``` - *Type:* VolumeMount[] Pod volumes to mount into the container's filesystem. Cannot be updated. --- ##### `workingDir`^Optional ```typescript public readonly workingDir: string; ``` - *Type:* string - *Default:* The container runtime's default. Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. --- ##### `image`^Required ```typescript public readonly image: string; ``` - *Type:* string Docker image name. --- ### ContainerResizePolicy ContainerResizePolicy represents resource resize policy for the container. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const containerResizePolicy: k8s.ContainerResizePolicy = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | resourceName | string | Name of the resource to which this resource resize policy applies. | | restartPolicy | string | Restart policy to apply when specified resource is resized. | --- ##### `resourceName`^Required ```typescript public readonly resourceName: string; ``` - *Type:* string Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. --- ##### `restartPolicy`^Required ```typescript public readonly restartPolicy: string; ``` - *Type:* string Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. --- ### ContainerResourceMetricSourceV2 ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const containerResourceMetricSourceV2: k8s.ContainerResourceMetricSourceV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | container | string | container is the name of the container in the pods of the scaling target. | | name | string | name is the name of the resource in question. | | target | cdk8s-plus-32.k8s.MetricTargetV2 | target specifies the target value for the given metric. | --- ##### `container`^Required ```typescript public readonly container: string; ``` - *Type:* string container is the name of the container in the pods of the scaling target. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name is the name of the resource in question. --- ##### `target`^Required ```typescript public readonly target: MetricTargetV2; ``` - *Type:* cdk8s-plus-32.k8s.MetricTargetV2 target specifies the target value for the given metric. --- ### ContainerResources CPU and memory compute resources. #### Initializer ```typescript import { ContainerResources } from 'cdk8s-plus-32' const containerResources: ContainerResources = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cpu | CpuResources | *No description.* | | ephemeralStorage | EphemeralStorageResources | *No description.* | | memory | MemoryResources | *No description.* | --- ##### `cpu`^Optional ```typescript public readonly cpu: CpuResources; ``` - *Type:* CpuResources --- ##### `ephemeralStorage`^Optional ```typescript public readonly ephemeralStorage: EphemeralStorageResources; ``` - *Type:* EphemeralStorageResources --- ##### `memory`^Optional ```typescript public readonly memory: MemoryResources; ``` - *Type:* MemoryResources --- ### ContainerSecurityContextProps Properties for `ContainerSecurityContext`. #### Initializer ```typescript import { ContainerSecurityContextProps } from 'cdk8s-plus-32' const containerSecurityContextProps: ContainerSecurityContextProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allowPrivilegeEscalation | boolean | Whether a process can gain more privileges than its parent process. | | capabilities | ContainerSecutiryContextCapabilities | POSIX capabilities for running containers. | | ensureNonRoot | boolean | Indicates that the container must run as a non-root user. | | group | number | The GID to run the entrypoint of the container process. | | privileged | boolean | Run container in privileged mode. | | readOnlyRootFilesystem | boolean | Whether this container has a read-only root filesystem. | | seccompProfile | SeccompProfile | Container's seccomp profile settings. | | user | number | The UID to run the entrypoint of the container process. | --- ##### `allowPrivilegeEscalation`^Optional ```typescript public readonly allowPrivilegeEscalation: boolean; ``` - *Type:* boolean - *Default:* false Whether a process can gain more privileges than its parent process. --- ##### `capabilities`^Optional ```typescript public readonly capabilities: ContainerSecutiryContextCapabilities; ``` - *Type:* ContainerSecutiryContextCapabilities - *Default:* none POSIX capabilities for running containers. --- ##### `ensureNonRoot`^Optional ```typescript public readonly ensureNonRoot: boolean; ``` - *Type:* boolean - *Default:* true Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. --- ##### `group`^Optional ```typescript public readonly group: number; ``` - *Type:* number - *Default:* 26000. An arbitrary number bigger than 9999 is selected here. This is so that the container is blocked to access host files even if somehow it manages to get access to host file system. The GID to run the entrypoint of the container process. --- ##### `privileged`^Optional ```typescript public readonly privileged: boolean; ``` - *Type:* boolean - *Default:* false Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. --- ##### `readOnlyRootFilesystem`^Optional ```typescript public readonly readOnlyRootFilesystem: boolean; ``` - *Type:* boolean - *Default:* true Whether this container has a read-only root filesystem. --- ##### `seccompProfile`^Optional ```typescript public readonly seccompProfile: SeccompProfile; ``` - *Type:* SeccompProfile - *Default:* none Container's seccomp profile settings. Only one profile source may be set --- ##### `user`^Optional ```typescript public readonly user: number; ``` - *Type:* number - *Default:* 25000. An arbitrary number bigger than 9999 is selected here. This is so that the container is blocked to access host files even if somehow it manages to get access to host file system. The UID to run the entrypoint of the container process. --- ### ContainerSecutiryContextCapabilities #### Initializer ```typescript import { ContainerSecutiryContextCapabilities } from 'cdk8s-plus-32' const containerSecutiryContextCapabilities: ContainerSecutiryContextCapabilities = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | add | Capability[] | Added capabilities. | | drop | Capability[] | Removed capabilities. | --- ##### `add`^Optional ```typescript public readonly add: Capability[]; ``` - *Type:* Capability[] Added capabilities. --- ##### `drop`^Optional ```typescript public readonly drop: Capability[]; ``` - *Type:* Capability[] Removed capabilities. --- ### CpuResources CPU request and limit. #### Initializer ```typescript import { CpuResources } from 'cdk8s-plus-32' const cpuResources: CpuResources = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | limit | Cpu | *No description.* | | request | Cpu | *No description.* | --- ##### `limit`^Optional ```typescript public readonly limit: Cpu; ``` - *Type:* Cpu --- ##### `request`^Optional ```typescript public readonly request: Cpu; ``` - *Type:* Cpu --- ### CronJobProps Properties for `CronJob`. #### Initializer ```typescript import { CronJobProps } from 'cdk8s-plus-32' const cronJobProps: CronJobProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | boolean | Indicates whether a service account token should be automatically mounted. | | containers | ContainerProps[] | List of containers belonging to the pod. | | dns | PodDnsProps | DNS settings for the pod. | | dockerRegistryAuth | ISecret | A secret containing docker credentials for authenticating to a registry. | | enableServiceLinks | boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | HostAlias[] | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | boolean | Host network for the pod. | | initContainers | ContainerProps[] | List of initialization containers belonging to the pod. | | isolate | boolean | Isolates the pod. | | restartPolicy | RestartPolicy | Restart policy for all containers within the pod. | | securityContext | PodSecurityContextProps | SecurityContext holds pod-level security attributes and common container settings. | | serviceAccount | IServiceAccount | A service account provides an identity for processes that run in a Pod. | | shareProcessNamespace | boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | cdk8s.Duration | Grace period until the pod is terminated. | | volumes | Volume[] | List of volumes that can be mounted by containers belonging to the pod. | | podMetadata | cdk8s.ApiObjectMetadata | The pod metadata of this workload. | | select | boolean | Automatically allocates a pod label selector for this workload and add it to the pod metadata. | | spread | boolean | Automatically spread pods across hostname and zones. | | activeDeadline | cdk8s.Duration | Specifies the duration the job may be active before the system tries to terminate it. | | backoffLimit | number | Specifies the number of retries before marking this job failed. | | ttlAfterFinished | cdk8s.Duration | Limits the lifetime of a Job that has finished execution (either Complete or Failed). | | schedule | cdk8s.Cron | Specifies the time in which the job would run again. | | concurrencyPolicy | ConcurrencyPolicy | Specifies the concurrency policy for the job. | | failedJobsRetained | number | Specifies the number of failed jobs history retained. | | startingDeadline | cdk8s.Duration | Kubernetes attempts to start cron jobs at its schedule time, but this is not guaranteed. | | successfulJobsRetained | number | Specifies the number of successful jobs history retained. | | suspend | boolean | Specifies if the cron job should be suspended. | | timeZone | string | Specifies the timezone for the job. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether a service account token should be automatically mounted. > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server) --- ##### `containers`^Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No containers. Note that a pod spec must include at least one container. List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. You can add additionnal containers using `podSpec.addContainer()` --- ##### `dns`^Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* PodDnsProps - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > [https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/) --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean - *Default:* true Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. > [https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) --- ##### `hostAliases`^Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No init containers. List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added ,removed or updated. > [https://kubernetes.io/docs/concepts/workloads/pods/init-containers/](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) --- ##### `isolate`^Optional ```typescript public readonly isolate: boolean; ``` - *Type:* boolean - *Default:* false Isolates the pod. This will prevent any ingress or egress connections to / from this pod. You can however allow explicit connections post instantiation by using the `.connections` property. --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy) --- ##### `securityContext`^Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount - *Default:* No service account. A service account provides an identity for processes that run in a Pod. When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default). > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) --- ##### `shareProcessNamespace`^Optional ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean - *Default:* false When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. > [https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/](https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/) --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] - *Default:* No volumes. List of volumes that can be mounted by containers belonging to the pod. You can also add volumes later using `podSpec.addVolume()` > [https://kubernetes.io/docs/concepts/storage/volumes](https://kubernetes.io/docs/concepts/storage/volumes) --- ##### `podMetadata`^Optional ```typescript public readonly podMetadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata The pod metadata of this workload. --- ##### `select`^Optional ```typescript public readonly select: boolean; ``` - *Type:* boolean - *Default:* true Automatically allocates a pod label selector for this workload and add it to the pod metadata. This ensures this workload manages pods created by its pod template. --- ##### `spread`^Optional ```typescript public readonly spread: boolean; ``` - *Type:* boolean - *Default:* false Automatically spread pods across hostname and zones. > [https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints) --- ##### `activeDeadline`^Optional ```typescript public readonly activeDeadline: Duration; ``` - *Type:* cdk8s.Duration - *Default:* If unset, then there is no deadline. Specifies the duration the job may be active before the system tries to terminate it. --- ##### `backoffLimit`^Optional ```typescript public readonly backoffLimit: number; ``` - *Type:* number - *Default:* If not set, system defaults to 6. Specifies the number of retries before marking this job failed. --- ##### `ttlAfterFinished`^Optional ```typescript public readonly ttlAfterFinished: Duration; ``` - *Type:* cdk8s.Duration - *Default:* If this field is unset, the Job won't be automatically deleted. Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the `TTLAfterFinished` feature. --- ##### `schedule`^Required ```typescript public readonly schedule: Cron; ``` - *Type:* cdk8s.Cron Specifies the time in which the job would run again. This is defined as a cron expression in the CronJob resource. --- ##### `concurrencyPolicy`^Optional ```typescript public readonly concurrencyPolicy: ConcurrencyPolicy; ``` - *Type:* ConcurrencyPolicy - *Default:* ConcurrencyPolicy.Forbid Specifies the concurrency policy for the job. --- ##### `failedJobsRetained`^Optional ```typescript public readonly failedJobsRetained: number; ``` - *Type:* number - *Default:* 1 Specifies the number of failed jobs history retained. This would retain the Job and the associated Pod resource and can be useful for debugging. --- ##### `startingDeadline`^Optional ```typescript public readonly startingDeadline: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(10) Kubernetes attempts to start cron jobs at its schedule time, but this is not guaranteed. This deadline specifies how much time can pass after a schedule point, for which kubernetes can still start the job. For example, if this is set to 100 seconds, kubernetes is allowed to start the job at a maximum 100 seconds after the scheduled time. Note that the Kubernetes CronJobController checks for things every 10 seconds, for this reason, a deadline below 10 seconds is not allowed, as it may cause your job to never be scheduled. In addition, kubernetes will stop scheduling jobs if more than 100 schedules were missed (for any reason). This property also controls what time interval should kubernetes consider when counting for missed schedules. For example, suppose a CronJob is set to schedule a new Job every one minute beginning at 08:30:00, and its `startingDeadline` field is not set. If the CronJob controller happens to be down from 08:29:00 to 10:21:00, the job will not start as the number of missed jobs which missed their schedule is greater than 100. However, if `startingDeadline` is set to 200 seconds, kubernetes will only count 3 missed schedules, and thus start a new execution at 10:22:00. --- ##### `successfulJobsRetained`^Optional ```typescript public readonly successfulJobsRetained: number; ``` - *Type:* number - *Default:* 3 Specifies the number of successful jobs history retained. This would retain the Job and the associated Pod resource and can be useful for debugging. --- ##### `suspend`^Optional ```typescript public readonly suspend: boolean; ``` - *Type:* boolean - *Default:* false Specifies if the cron job should be suspended. Only applies to future executions, current ones are remained untouched. --- ##### `timeZone`^Optional ```typescript public readonly timeZone: string; ``` - *Type:* string - *Default:* Timezone of kube-controller-manager process. Specifies the timezone for the job. This helps aligining the schedule to follow the specified timezone. > [{@link https://en.wikipedia.org/wiki/List_of_tz_database_time_zones} for list of valid timezone values.]({@link https://en.wikipedia.org/wiki/List_of_tz_database_time_zones} for list of valid timezone values.) --- ### CronJobSpec CronJobSpec describes how the job execution will look like and when it will actually run. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const cronJobSpec: k8s.CronJobSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | jobTemplate | cdk8s-plus-32.k8s.JobTemplateSpec | Specifies the job that will be created when executing a CronJob. | | schedule | string | The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. | | concurrencyPolicy | string | Specifies how to treat concurrent executions of a Job. Valid values are:. | | failedJobsHistoryLimit | number | The number of failed finished jobs to retain. | | startingDeadlineSeconds | number | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. | | successfulJobsHistoryLimit | number | The number of successful finished jobs to retain. | | suspend | boolean | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. | | timeZone | string | The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones. | --- ##### `jobTemplate`^Required ```typescript public readonly jobTemplate: JobTemplateSpec; ``` - *Type:* cdk8s-plus-32.k8s.JobTemplateSpec Specifies the job that will be created when executing a CronJob. --- ##### `schedule`^Required ```typescript public readonly schedule: string; ``` - *Type:* string The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. --- ##### `concurrencyPolicy`^Optional ```typescript public readonly concurrencyPolicy: string; ``` - *Type:* string Specifies how to treat concurrent executions of a Job. Valid values are:. "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one --- ##### `failedJobsHistoryLimit`^Optional ```typescript public readonly failedJobsHistoryLimit: number; ``` - *Type:* number - *Default:* 1. The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1. --- ##### `startingDeadlineSeconds`^Optional ```typescript public readonly startingDeadlineSeconds: number; ``` - *Type:* number Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. --- ##### `successfulJobsHistoryLimit`^Optional ```typescript public readonly successfulJobsHistoryLimit: number; ``` - *Type:* number - *Default:* 3. The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3. --- ##### `suspend`^Optional ```typescript public readonly suspend: boolean; ``` - *Type:* boolean - *Default:* false. This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. --- ##### `timeZone`^Optional ```typescript public readonly timeZone: string; ``` - *Type:* string The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones. --- ### CrossVersionObjectReference CrossVersionObjectReference contains enough information to let you identify the referred resource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const crossVersionObjectReference: k8s.CrossVersionObjectReference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | kind | string | kind is the kind of the referent; | | name | string | name is the name of the referent; | | apiVersion | string | apiVersion is the API version of the referent. | --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string apiVersion is the API version of the referent. --- ### CrossVersionObjectReferenceV2 CrossVersionObjectReference contains enough information to let you identify the referred resource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const crossVersionObjectReferenceV2: k8s.CrossVersionObjectReferenceV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | kind | string | kind is the kind of the referent; | | name | string | name is the name of the referent; | | apiVersion | string | apiVersion is the API version of the referent. | --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string apiVersion is the API version of the referent. --- ### CsiDriverSpec CSIDriverSpec is the specification of a CSIDriver. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const csiDriverSpec: k8s.CsiDriverSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attachRequired | boolean | attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. | | fsGroupPolicy | string | fsGroupPolicy defines if the underlying volume supports changing ownership and permission of the volume before being mounted. | | podInfoOnMount | boolean | podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations, if set to true. If set to false, pod information will not be passed on mount. Default is false. | | requiresRepublish | boolean | requiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. | | seLinuxMount | boolean | seLinuxMount specifies if the CSI driver supports "-o context" mount option. | | storageCapacity | boolean | storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information, if set to true. | | tokenRequests | cdk8s-plus-32.k8s.TokenRequest[] | tokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. | | volumeLifecycleModes | string[] | volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. | --- ##### `attachRequired`^Optional ```typescript public readonly attachRequired: boolean; ``` - *Type:* boolean attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. This field is immutable. --- ##### `fsGroupPolicy`^Optional ```typescript public readonly fsGroupPolicy: string; ``` - *Type:* string - *Default:* ReadWriteOnceWithFSType, which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume. With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume's access mode contains ReadWriteOnce. fsGroupPolicy defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field was immutable in Kubernetes < 1.29 and now is mutable. Defaults to ReadWriteOnceWithFSType, which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume. With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume's access mode contains ReadWriteOnce. --- ##### `podInfoOnMount`^Optional ```typescript public readonly podInfoOnMount: boolean; ``` - *Type:* boolean - *Default:* false. podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations, if set to true. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeContext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise "false" "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. This field was immutable in Kubernetes < 1.29 and now is mutable. --- ##### `requiresRepublish`^Optional ```typescript public readonly requiresRepublish: boolean; ``` - *Type:* boolean requiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false. Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container. --- ##### `seLinuxMount`^Optional ```typescript public readonly seLinuxMount: boolean; ``` - *Type:* boolean - *Default:* false". seLinuxMount specifies if the CSI driver supports "-o context" mount option. When "true", the CSI driver must ensure that all volumes provided by this CSI driver can be mounted separately with different `-o context` options. This is typical for storage backends that provide volumes as filesystems on block devices or as independent shared volumes. Kubernetes will call NodeStage / NodePublish with "-o context=xyz" mount option when mounting a ReadWriteOncePod volume used in Pod that has explicitly set SELinux context. In the future, it may be expanded to other volume AccessModes. In any case, Kubernetes will ensure that the volume is mounted only with a single SELinux context. When "false", Kubernetes won't pass any special SELinux mount options to the driver. This is typical for volumes that represent subdirectories of a bigger shared filesystem. Default is "false". --- ##### `storageCapacity`^Optional ```typescript public readonly storageCapacity: boolean; ``` - *Type:* boolean storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information, if set to true. The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. This field was immutable in Kubernetes <= 1.22 and now is mutable. --- ##### `tokenRequests`^Optional ```typescript public readonly tokenRequests: TokenRequest[]; ``` - *Type:* cdk8s-plus-32.k8s.TokenRequest[] tokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { "": { "token": , "expirationTimestamp": , }, ... } Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. --- ##### `volumeLifecycleModes`^Optional ```typescript public readonly volumeLifecycleModes: string[]; ``` - *Type:* string[] volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is beta. This field is immutable. --- ### CsiNodeDriver CSINodeDriver holds information about the specification of one CSI driver installed on a node. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const csiNodeDriver: k8s.CsiNodeDriver = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | name represents the name of the CSI driver that this object refers to. | | nodeId | string | nodeID of the node from the driver point of view. | | allocatable | cdk8s-plus-32.k8s.VolumeNodeResources | allocatable represents the volume resources of a node that are available for scheduling. | | topologyKeys | string[] | topologyKeys is the list of keys supported by the driver. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name represents the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver. --- ##### `nodeId`^Required ```typescript public readonly nodeId: string; ``` - *Type:* string nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required. --- ##### `allocatable`^Optional ```typescript public readonly allocatable: VolumeNodeResources; ``` - *Type:* cdk8s-plus-32.k8s.VolumeNodeResources allocatable represents the volume resources of a node that are available for scheduling. This field is beta. --- ##### `topologyKeys`^Optional ```typescript public readonly topologyKeys: string[]; ``` - *Type:* string[] topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology. --- ### CsiNodeSpec CSINodeSpec holds information about the specification of all CSI drivers installed on a node. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const csiNodeSpec: k8s.CsiNodeSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | drivers | cdk8s-plus-32.k8s.CsiNodeDriver[] | drivers is a list of information of all CSI Drivers existing on a node. | --- ##### `drivers`^Required ```typescript public readonly drivers: CsiNodeDriver[]; ``` - *Type:* cdk8s-plus-32.k8s.CsiNodeDriver[] drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty. --- ### CsiPersistentVolumeSource Represents storage that is managed by an external CSI volume driver. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const csiPersistentVolumeSource: k8s.CsiPersistentVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | driver | string | driver is the name of the driver to use for this volume. | | volumeHandle | string | volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. | | controllerExpandSecretRef | cdk8s-plus-32.k8s.SecretReference | controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. | | controllerPublishSecretRef | cdk8s-plus-32.k8s.SecretReference | controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. | | fsType | string | fsType to mount. | | nodeExpandSecretRef | cdk8s-plus-32.k8s.SecretReference | nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call. | | nodePublishSecretRef | cdk8s-plus-32.k8s.SecretReference | nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. | | nodeStageSecretRef | cdk8s-plus-32.k8s.SecretReference | nodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. | | readOnly | boolean | readOnly value to pass to ControllerPublishVolumeRequest. | | volumeAttributes | {[ key: string ]: string} | volumeAttributes of the volume to publish. | --- ##### `driver`^Required ```typescript public readonly driver: string; ``` - *Type:* string driver is the name of the driver to use for this volume. Required. --- ##### `volumeHandle`^Required ```typescript public readonly volumeHandle: string; ``` - *Type:* string volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required. --- ##### `controllerExpandSecretRef`^Optional ```typescript public readonly controllerExpandSecretRef: SecretReference; ``` - *Type:* cdk8s-plus-32.k8s.SecretReference controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. --- ##### `controllerPublishSecretRef`^Optional ```typescript public readonly controllerPublishSecretRef: SecretReference; ``` - *Type:* cdk8s-plus-32.k8s.SecretReference controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". --- ##### `nodeExpandSecretRef`^Optional ```typescript public readonly nodeExpandSecretRef: SecretReference; ``` - *Type:* cdk8s-plus-32.k8s.SecretReference nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call. This field is optional, may be omitted if no secret is required. If the secret object contains more than one secret, all secrets are passed. --- ##### `nodePublishSecretRef`^Optional ```typescript public readonly nodePublishSecretRef: SecretReference; ``` - *Type:* cdk8s-plus-32.k8s.SecretReference nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. --- ##### `nodeStageSecretRef`^Optional ```typescript public readonly nodeStageSecretRef: SecretReference; ``` - *Type:* cdk8s-plus-32.k8s.SecretReference nodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false (read/write). readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). --- ##### `volumeAttributes`^Optional ```typescript public readonly volumeAttributes: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} volumeAttributes of the volume to publish. --- ### CsiVolumeOptions Options for the CSI driver based volume. #### Initializer ```typescript import { CsiVolumeOptions } from 'cdk8s-plus-32' const csiVolumeOptions: CsiVolumeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | {[ key: string ]: string} | Any driver-specific attributes to pass to the CSI volume builder. | | fsType | string | The filesystem type to mount. | | name | string | The volume name. | | readOnly | boolean | Whether the mounted volume should be read-only or not. | --- ##### `attributes`^Optional ```typescript public readonly attributes: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* undefined Any driver-specific attributes to pass to the CSI volume builder. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string - *Default:* driver-dependent The filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver, which will determine the default filesystem to apply. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* auto-generated The volume name. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false Whether the mounted volume should be read-only or not. --- ### CsiVolumeSource Represents a source location of a volume to mount, managed by an external CSI driver. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const csiVolumeSource: k8s.CsiVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | driver | string | driver is the name of the CSI driver that handles this volume. | | fsType | string | fsType to mount. | | nodePublishSecretRef | cdk8s-plus-32.k8s.LocalObjectReference | nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. | | readOnly | boolean | readOnly specifies a read-only configuration for the volume. | | volumeAttributes | {[ key: string ]: string} | volumeAttributes stores driver-specific properties that are passed to the CSI driver. | --- ##### `driver`^Required ```typescript public readonly driver: string; ``` - *Type:* string driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. --- ##### `nodePublishSecretRef`^Optional ```typescript public readonly nodePublishSecretRef: LocalObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.LocalObjectReference nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false (read/write). readOnly specifies a read-only configuration for the volume. Defaults to false (read/write). --- ##### `volumeAttributes`^Optional ```typescript public readonly volumeAttributes: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. --- ### CustomResourceColumnDefinition CustomResourceColumnDefinition specifies a column for server side printing. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const customResourceColumnDefinition: k8s.CustomResourceColumnDefinition = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | jsonPath | string | jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. | | name | string | name is a human readable name for the column. | | type | string | type is an OpenAPI type definition for this column. | | description | string | description is a human readable description of this column. | | format | string | format is an optional OpenAPI type definition for this column. | | priority | number | priority is an integer defining the relative importance of this column compared to others. | --- ##### `jsonPath`^Required ```typescript public readonly jsonPath: string; ``` - *Type:* string jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name is a human readable name for the column. --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string description is a human readable description of this column. --- ##### `format`^Optional ```typescript public readonly format: string; ``` - *Type:* string format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. --- ##### `priority`^Optional ```typescript public readonly priority: number; ``` - *Type:* number priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0. --- ### CustomResourceConversion CustomResourceConversion describes how to convert different versions of a CR. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const customResourceConversion: k8s.CustomResourceConversion = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | strategy | string | strategy specifies how custom resources are converted between versions. | | webhook | cdk8s-plus-32.k8s.WebhookConversion | webhook describes how to call the conversion webhook. | --- ##### `strategy`^Required ```typescript public readonly strategy: string; ``` - *Type:* string strategy specifies how custom resources are converted between versions. Allowed values are: - `"None"`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `"Webhook"`: API Server will call to an external webhook to do the conversion. Additional information is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set. --- ##### `webhook`^Optional ```typescript public readonly webhook: WebhookConversion; ``` - *Type:* cdk8s-plus-32.k8s.WebhookConversion webhook describes how to call the conversion webhook. Required when `strategy` is set to `"Webhook"`. --- ### CustomResourceDefinitionNames CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const customResourceDefinitionNames: k8s.CustomResourceDefinitionNames = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | kind | string | kind is the serialized kind of the resource. | | plural | string | plural is the plural name of the resource to serve. | | categories | string[] | categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`. | | listKind | string | listKind is the serialized kind of the list for this resource. | | shortNames | string[] | shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get `. | | singular | string | singular is the singular name of the resource. | --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls. --- ##### `plural`^Required ```typescript public readonly plural: string; ``` - *Type:* string plural is the plural name of the resource to serve. The custom resources are served under `/apis///.../`. Must match the name of the CustomResourceDefinition (in the form `.`). Must be all lowercase. --- ##### `categories`^Optional ```typescript public readonly categories: string[]; ``` - *Type:* string[] categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`. --- ##### `listKind`^Optional ```typescript public readonly listKind: string; ``` - *Type:* string - *Default:* kind`List". listKind is the serialized kind of the list for this resource. Defaults to "`kind`List". --- ##### `shortNames`^Optional ```typescript public readonly shortNames: string[]; ``` - *Type:* string[] shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get `. It must be all lowercase. --- ##### `singular`^Optional ```typescript public readonly singular: string; ``` - *Type:* string - *Default:* lowercased `kind`. singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`. --- ### CustomResourceDefinitionSpec CustomResourceDefinitionSpec describes how a user wants their resource to appear. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const customResourceDefinitionSpec: k8s.CustomResourceDefinitionSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | group | string | group is the API group of the defined custom resource. | | names | cdk8s-plus-32.k8s.CustomResourceDefinitionNames | names specify the resource and kind names for the custom resource. | | scope | string | scope indicates whether the defined custom resource is cluster- or namespace-scoped. | | versions | cdk8s-plus-32.k8s.CustomResourceDefinitionVersion[] | versions is the list of all API versions of the defined custom resource. | | conversion | cdk8s-plus-32.k8s.CustomResourceConversion | conversion defines conversion settings for the CRD. | | preserveUnknownFields | boolean | preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. | --- ##### `group`^Required ```typescript public readonly group: string; ``` - *Type:* string group is the API group of the defined custom resource. The custom resources are served under `/apis//...`. Must match the name of the CustomResourceDefinition (in the form `.`). --- ##### `names`^Required ```typescript public readonly names: CustomResourceDefinitionNames; ``` - *Type:* cdk8s-plus-32.k8s.CustomResourceDefinitionNames names specify the resource and kind names for the custom resource. --- ##### `scope`^Required ```typescript public readonly scope: string; ``` - *Type:* string scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`. --- ##### `versions`^Required ```typescript public readonly versions: CustomResourceDefinitionVersion[]; ``` - *Type:* cdk8s-plus-32.k8s.CustomResourceDefinitionVersion[] versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. --- ##### `conversion`^Optional ```typescript public readonly conversion: CustomResourceConversion; ``` - *Type:* cdk8s-plus-32.k8s.CustomResourceConversion conversion defines conversion settings for the CRD. --- ##### `preserveUnknownFields`^Optional ```typescript public readonly preserveUnknownFields: boolean; ``` - *Type:* boolean preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning for details. --- ### CustomResourceDefinitionVersion CustomResourceDefinitionVersion describes a version for CRD. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const customResourceDefinitionVersion: k8s.CustomResourceDefinitionVersion = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis///...` if `served` is true. | | served | boolean | served is a flag enabling/disabling this version from being served via REST APIs. | | storage | boolean | storage indicates this version should be used when persisting custom resources to storage. | | additionalPrinterColumns | cdk8s-plus-32.k8s.CustomResourceColumnDefinition[] | additionalPrinterColumns specifies additional columns returned in Table output. | | deprecated | boolean | deprecated indicates this version of the custom resource API is deprecated. | | deprecationWarning | string | deprecationWarning overrides the default warning returned to API clients. | | schema | cdk8s-plus-32.k8s.CustomResourceValidation | schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource. | | selectableFields | cdk8s-plus-32.k8s.SelectableField[] | selectableFields specifies paths to fields that may be used as field selectors. | | subresources | cdk8s-plus-32.k8s.CustomResourceSubresources | subresources specify what subresources this version of the defined custom resource have. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis///...` if `served` is true. --- ##### `served`^Required ```typescript public readonly served: boolean; ``` - *Type:* boolean served is a flag enabling/disabling this version from being served via REST APIs. --- ##### `storage`^Required ```typescript public readonly storage: boolean; ``` - *Type:* boolean storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true. --- ##### `additionalPrinterColumns`^Optional ```typescript public readonly additionalPrinterColumns: CustomResourceColumnDefinition[]; ``` - *Type:* cdk8s-plus-32.k8s.CustomResourceColumnDefinition[] additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no columns are specified, a single column displaying the age of the custom resource is used. --- ##### `deprecated`^Optional ```typescript public readonly deprecated: boolean; ``` - *Type:* boolean - *Default:* false. deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false. --- ##### `deprecationWarning`^Optional ```typescript public readonly deprecationWarning: string; ``` - *Type:* string deprecationWarning overrides the default warning returned to API clients. May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. --- ##### `schema`^Optional ```typescript public readonly schema: CustomResourceValidation; ``` - *Type:* cdk8s-plus-32.k8s.CustomResourceValidation schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource. --- ##### `selectableFields`^Optional ```typescript public readonly selectableFields: SelectableField[]; ``` - *Type:* cdk8s-plus-32.k8s.SelectableField[] selectableFields specifies paths to fields that may be used as field selectors. A maximum of 8 selectable fields are allowed. See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors --- ##### `subresources`^Optional ```typescript public readonly subresources: CustomResourceSubresources; ``` - *Type:* cdk8s-plus-32.k8s.CustomResourceSubresources subresources specify what subresources this version of the defined custom resource have. --- ### CustomResourceSubresources CustomResourceSubresources defines the status and scale subresources for CustomResources. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const customResourceSubresources: k8s.CustomResourceSubresources = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | scale | cdk8s-plus-32.k8s.CustomResourceSubresourceScale | scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object. | | status | any | status indicates the custom resource should serve a `/status` subresource. | --- ##### `scale`^Optional ```typescript public readonly scale: CustomResourceSubresourceScale; ``` - *Type:* cdk8s-plus-32.k8s.CustomResourceSubresourceScale scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object. --- ##### `status`^Optional ```typescript public readonly status: any; ``` - *Type:* any status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object. --- ### CustomResourceSubresourceScale CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const customResourceSubresourceScale: k8s.CustomResourceSubresourceScale = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | specReplicasPath | string | specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET. | | statusReplicasPath | string | statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. | | labelSelectorPath | string | labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string. | --- ##### `specReplicasPath`^Required ```typescript public readonly specReplicasPath: string; ``` - *Type:* string specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET. --- ##### `statusReplicasPath`^Required ```typescript public readonly statusReplicasPath: string; ``` - *Type:* string statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. --- ##### `labelSelectorPath`^Optional ```typescript public readonly labelSelectorPath: string; ``` - *Type:* string labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string. --- ### CustomResourceValidation CustomResourceValidation is a list of validation methods for CustomResources. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const customResourceValidation: k8s.CustomResourceValidation = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiv3Schema | cdk8s-plus-32.k8s.JsonSchemaProps | openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. | --- ##### `openApiv3Schema`^Optional ```typescript public readonly openApiv3Schema: JsonSchemaProps; ``` - *Type:* cdk8s-plus-32.k8s.JsonSchemaProps openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. --- ### DaemonSetProps Properties for `DaemonSet`. #### Initializer ```typescript import { DaemonSetProps } from 'cdk8s-plus-32' const daemonSetProps: DaemonSetProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | boolean | Indicates whether a service account token should be automatically mounted. | | containers | ContainerProps[] | List of containers belonging to the pod. | | dns | PodDnsProps | DNS settings for the pod. | | dockerRegistryAuth | ISecret | A secret containing docker credentials for authenticating to a registry. | | enableServiceLinks | boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | HostAlias[] | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | boolean | Host network for the pod. | | initContainers | ContainerProps[] | List of initialization containers belonging to the pod. | | isolate | boolean | Isolates the pod. | | restartPolicy | RestartPolicy | Restart policy for all containers within the pod. | | securityContext | PodSecurityContextProps | SecurityContext holds pod-level security attributes and common container settings. | | serviceAccount | IServiceAccount | A service account provides an identity for processes that run in a Pod. | | shareProcessNamespace | boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | cdk8s.Duration | Grace period until the pod is terminated. | | volumes | Volume[] | List of volumes that can be mounted by containers belonging to the pod. | | podMetadata | cdk8s.ApiObjectMetadata | The pod metadata of this workload. | | select | boolean | Automatically allocates a pod label selector for this workload and add it to the pod metadata. | | spread | boolean | Automatically spread pods across hostname and zones. | | minReadySeconds | number | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether a service account token should be automatically mounted. > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server) --- ##### `containers`^Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No containers. Note that a pod spec must include at least one container. List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. You can add additionnal containers using `podSpec.addContainer()` --- ##### `dns`^Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* PodDnsProps - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > [https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/) --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean - *Default:* true Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. > [https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) --- ##### `hostAliases`^Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No init containers. List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added ,removed or updated. > [https://kubernetes.io/docs/concepts/workloads/pods/init-containers/](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) --- ##### `isolate`^Optional ```typescript public readonly isolate: boolean; ``` - *Type:* boolean - *Default:* false Isolates the pod. This will prevent any ingress or egress connections to / from this pod. You can however allow explicit connections post instantiation by using the `.connections` property. --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy) --- ##### `securityContext`^Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount - *Default:* No service account. A service account provides an identity for processes that run in a Pod. When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default). > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) --- ##### `shareProcessNamespace`^Optional ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean - *Default:* false When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. > [https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/](https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/) --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] - *Default:* No volumes. List of volumes that can be mounted by containers belonging to the pod. You can also add volumes later using `podSpec.addVolume()` > [https://kubernetes.io/docs/concepts/storage/volumes](https://kubernetes.io/docs/concepts/storage/volumes) --- ##### `podMetadata`^Optional ```typescript public readonly podMetadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata The pod metadata of this workload. --- ##### `select`^Optional ```typescript public readonly select: boolean; ``` - *Type:* boolean - *Default:* true Automatically allocates a pod label selector for this workload and add it to the pod metadata. This ensures this workload manages pods created by its pod template. --- ##### `spread`^Optional ```typescript public readonly spread: boolean; ``` - *Type:* boolean - *Default:* false Automatically spread pods across hostname and zones. > [https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints) --- ##### `minReadySeconds`^Optional ```typescript public readonly minReadySeconds: number; ``` - *Type:* number - *Default:* 0 Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. --- ### DaemonSetSpec DaemonSetSpec is the specification of a daemon set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const daemonSetSpec: k8s.DaemonSetSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | selector | cdk8s-plus-32.k8s.LabelSelector | A label query over pods that are managed by the daemon set. | | template | cdk8s-plus-32.k8s.PodTemplateSpec | An object that describes the pod that will be created. | | minReadySeconds | number | The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. | | revisionHistoryLimit | number | The number of old history to retain to allow rollback. | | updateStrategy | cdk8s-plus-32.k8s.DaemonSetUpdateStrategy | An update strategy to replace existing DaemonSet pods with new pods. | --- ##### `selector`^Required ```typescript public readonly selector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors --- ##### `template`^Required ```typescript public readonly template: PodTemplateSpec; ``` - *Type:* cdk8s-plus-32.k8s.PodTemplateSpec An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). The only allowed template.spec.restartPolicy value is "Always". More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template --- ##### `minReadySeconds`^Optional ```typescript public readonly minReadySeconds: number; ``` - *Type:* number - *Default:* 0 (pod will be considered available as soon as it is ready). The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready). --- ##### `revisionHistoryLimit`^Optional ```typescript public readonly revisionHistoryLimit: number; ``` - *Type:* number - *Default:* 10. The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. --- ##### `updateStrategy`^Optional ```typescript public readonly updateStrategy: DaemonSetUpdateStrategy; ``` - *Type:* cdk8s-plus-32.k8s.DaemonSetUpdateStrategy An update strategy to replace existing DaemonSet pods with new pods. --- ### DaemonSetUpdateStrategy DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const daemonSetUpdateStrategy: k8s.DaemonSetUpdateStrategy = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | rollingUpdate | cdk8s-plus-32.k8s.RollingUpdateDaemonSet | Rolling update config params. | | type | string | Type of daemon set update. | --- ##### `rollingUpdate`^Optional ```typescript public readonly rollingUpdate: RollingUpdateDaemonSet; ``` - *Type:* cdk8s-plus-32.k8s.RollingUpdateDaemonSet Rolling update config params. Present only if type = "RollingUpdate". --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string - *Default:* RollingUpdate. Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. --- ### DeleteOptions DeleteOptions may be provided when deleting an API object. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deleteOptions: k8s.DeleteOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | APIVersion defines the versioned schema of this representation of an object. | | dryRun | string[] | When present, indicates that modifications should not be persisted. | | gracePeriodSeconds | number | The duration in seconds before the object should be deleted. | | ignoreStoreReadErrorWithClusterBreakingPotential | boolean | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. | | kind | cdk8s-plus-32.k8s.IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind | Kind is a string value representing the REST resource this object represents. | | orphanDependents | boolean | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | | preconditions | cdk8s-plus-32.k8s.Preconditions | Must be fulfilled before a deletion is carried out. | | propagationPolicy | string | Whether and how garbage collection will be performed. | --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources --- ##### `dryRun`^Optional ```typescript public readonly dryRun: string[]; ``` - *Type:* string[] When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed --- ##### `gracePeriodSeconds`^Optional ```typescript public readonly gracePeriodSeconds: number; ``` - *Type:* number - *Default:* a per object value if not specified. zero means delete immediately. The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. --- ##### `ignoreStoreReadErrorWithClusterBreakingPotential`^Optional ```typescript public readonly ignoreStoreReadErrorWithClusterBreakingPotential: boolean; ``` - *Type:* boolean if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it --- ##### `kind`^Optional ```typescript public readonly kind: IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind; ``` - *Type:* cdk8s-plus-32.k8s.IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ##### `orphanDependents`^Optional ```typescript public readonly orphanDependents: boolean; ``` - *Type:* boolean Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. --- ##### `preconditions`^Optional ```typescript public readonly preconditions: Preconditions; ``` - *Type:* cdk8s-plus-32.k8s.Preconditions Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. --- ##### `propagationPolicy`^Optional ```typescript public readonly propagationPolicy: string; ``` - *Type:* string Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. --- ### DeploymentExposeViaServiceOptions Options for `Deployment.exposeViaService`. #### Initializer ```typescript import { DeploymentExposeViaServiceOptions } from 'cdk8s-plus-32' const deploymentExposeViaServiceOptions: DeploymentExposeViaServiceOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name of the service to expose. | | ports | ServicePort[] | The ports that the service should bind to. | | serviceType | ServiceType | The type of the exposed service. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* auto generated. The name of the service to expose. If you'd like to expose the deployment multiple times, you must explicitly set a name starting from the second expose call. --- ##### `ports`^Optional ```typescript public readonly ports: ServicePort[]; ``` - *Type:* ServicePort[] - *Default:* extracted from the deployment. The ports that the service should bind to. --- ##### `serviceType`^Optional ```typescript public readonly serviceType: ServiceType; ``` - *Type:* ServiceType - *Default:* ClusterIP. The type of the exposed service. --- ### DeploymentProps Properties for `Deployment`. #### Initializer ```typescript import { DeploymentProps } from 'cdk8s-plus-32' const deploymentProps: DeploymentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | boolean | Indicates whether a service account token should be automatically mounted. | | containers | ContainerProps[] | List of containers belonging to the pod. | | dns | PodDnsProps | DNS settings for the pod. | | dockerRegistryAuth | ISecret | A secret containing docker credentials for authenticating to a registry. | | enableServiceLinks | boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | HostAlias[] | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | boolean | Host network for the pod. | | initContainers | ContainerProps[] | List of initialization containers belonging to the pod. | | isolate | boolean | Isolates the pod. | | restartPolicy | RestartPolicy | Restart policy for all containers within the pod. | | securityContext | PodSecurityContextProps | SecurityContext holds pod-level security attributes and common container settings. | | serviceAccount | IServiceAccount | A service account provides an identity for processes that run in a Pod. | | shareProcessNamespace | boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | cdk8s.Duration | Grace period until the pod is terminated. | | volumes | Volume[] | List of volumes that can be mounted by containers belonging to the pod. | | podMetadata | cdk8s.ApiObjectMetadata | The pod metadata of this workload. | | select | boolean | Automatically allocates a pod label selector for this workload and add it to the pod metadata. | | spread | boolean | Automatically spread pods across hostname and zones. | | 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. | | replicas | number | Number of desired pods. | | revisionHistoryLimit | number | Specify how many old ReplicaSets for this Deployment you want to retain. | | strategy | DeploymentStrategy | Specifies the strategy used to replace old Pods by new ones. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether a service account token should be automatically mounted. > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server) --- ##### `containers`^Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No containers. Note that a pod spec must include at least one container. List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. You can add additionnal containers using `podSpec.addContainer()` --- ##### `dns`^Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* PodDnsProps - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > [https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/) --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean - *Default:* true Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. > [https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) --- ##### `hostAliases`^Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No init containers. List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added ,removed or updated. > [https://kubernetes.io/docs/concepts/workloads/pods/init-containers/](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) --- ##### `isolate`^Optional ```typescript public readonly isolate: boolean; ``` - *Type:* boolean - *Default:* false Isolates the pod. This will prevent any ingress or egress connections to / from this pod. You can however allow explicit connections post instantiation by using the `.connections` property. --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy) --- ##### `securityContext`^Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount - *Default:* No service account. A service account provides an identity for processes that run in a Pod. When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default). > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) --- ##### `shareProcessNamespace`^Optional ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean - *Default:* false When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. > [https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/](https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/) --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] - *Default:* No volumes. List of volumes that can be mounted by containers belonging to the pod. You can also add volumes later using `podSpec.addVolume()` > [https://kubernetes.io/docs/concepts/storage/volumes](https://kubernetes.io/docs/concepts/storage/volumes) --- ##### `podMetadata`^Optional ```typescript public readonly podMetadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata The pod metadata of this workload. --- ##### `select`^Optional ```typescript public readonly select: boolean; ``` - *Type:* boolean - *Default:* true Automatically allocates a pod label selector for this workload and add it to the pod metadata. This ensures this workload manages pods created by its pod template. --- ##### `spread`^Optional ```typescript public readonly spread: boolean; ``` - *Type:* boolean - *Default:* false Automatically spread pods across hostname and zones. > [https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints) --- ##### `minReady`^Optional ```typescript public readonly minReady: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(0) Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Zero means the pod will be considered available as soon as it is ready. > [https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#min-ready-seconds](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#min-ready-seconds) --- ##### `progressDeadline`^Optional ```typescript public readonly progressDeadline: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(600) The maximum duration for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. > [https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#progress-deadline-seconds](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#progress-deadline-seconds) --- ##### `replicas`^Optional ```typescript public readonly replicas: number; ``` - *Type:* number - *Default:* 2 Number of desired pods. --- ##### `revisionHistoryLimit`^Optional ```typescript public readonly revisionHistoryLimit: number; ``` - *Type:* number - *Default:* 10 Specify how many old ReplicaSets for this Deployment you want to retain. The rest will be garbage-collected in the background. By default, it is 10. --- ##### `strategy`^Optional ```typescript public readonly strategy: DeploymentStrategy; ``` - *Type:* DeploymentStrategy - *Default:* RollingUpdate with maxSurge and maxUnavailable set to 25%. Specifies the strategy used to replace old Pods by new ones. --- ### DeploymentSpec DeploymentSpec is the specification of the desired behavior of the Deployment. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deploymentSpec: k8s.DeploymentSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | selector | cdk8s-plus-32.k8s.LabelSelector | Label selector for pods. | | template | cdk8s-plus-32.k8s.PodTemplateSpec | Template describes the pods that will be created. | | minReadySeconds | number | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. | | paused | boolean | Indicates that the deployment is paused. | | progressDeadlineSeconds | number | The maximum time in seconds for a deployment to make progress before it is considered to be failed. | | replicas | number | Number of desired pods. | | revisionHistoryLimit | number | The number of old ReplicaSets to retain to allow rollback. | | strategy | cdk8s-plus-32.k8s.DeploymentStrategy | The deployment strategy to use to replace existing pods with new ones. | --- ##### `selector`^Required ```typescript public readonly selector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. --- ##### `template`^Required ```typescript public readonly template: PodTemplateSpec; ``` - *Type:* cdk8s-plus-32.k8s.PodTemplateSpec Template describes the pods that will be created. The only allowed template.spec.restartPolicy value is "Always". --- ##### `minReadySeconds`^Optional ```typescript public readonly minReadySeconds: number; ``` - *Type:* number - *Default:* 0 (pod will be considered available as soon as it is ready) Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) --- ##### `paused`^Optional ```typescript public readonly paused: boolean; ``` - *Type:* boolean Indicates that the deployment is paused. --- ##### `progressDeadlineSeconds`^Optional ```typescript public readonly progressDeadlineSeconds: number; ``` - *Type:* number - *Default:* 600s. The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s. --- ##### `replicas`^Optional ```typescript public readonly replicas: number; ``` - *Type:* number - *Default:* 1. Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. --- ##### `revisionHistoryLimit`^Optional ```typescript public readonly revisionHistoryLimit: number; ``` - *Type:* number - *Default:* 10. The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. --- ##### `strategy`^Optional ```typescript public readonly strategy: DeploymentStrategy; ``` - *Type:* cdk8s-plus-32.k8s.DeploymentStrategy The deployment strategy to use to replace existing pods with new ones. --- ### DeploymentStrategy DeploymentStrategy describes how to replace existing pods with new ones. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deploymentStrategy: k8s.DeploymentStrategy = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | rollingUpdate | cdk8s-plus-32.k8s.RollingUpdateDeployment | Rolling update config params. | | type | string | Type of deployment. | --- ##### `rollingUpdate`^Optional ```typescript public readonly rollingUpdate: RollingUpdateDeployment; ``` - *Type:* cdk8s-plus-32.k8s.RollingUpdateDeployment Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string - *Default:* RollingUpdate. Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. --- ### DeploymentStrategyRollingUpdateOptions Options for `DeploymentStrategy.rollingUpdate`. #### Initializer ```typescript import { DeploymentStrategyRollingUpdateOptions } from 'cdk8s-plus-32' const deploymentStrategyRollingUpdateOptions: DeploymentStrategyRollingUpdateOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maxSurge | PercentOrAbsolute | The maximum number of pods that can be scheduled above the desired number of pods. | | maxUnavailable | PercentOrAbsolute | The maximum number of pods that can be unavailable during the update. | --- ##### `maxSurge`^Optional ```typescript public readonly maxSurge: PercentOrAbsolute; ``` - *Type:* PercentOrAbsolute - *Default:* '25%' The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0 if `maxUnavailable` is 0. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. --- ##### `maxUnavailable`^Optional ```typescript public readonly maxUnavailable: PercentOrAbsolute; ``` - *Type:* PercentOrAbsolute - *Default:* '25%' The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if `maxSurge` is 0. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. --- ### DeviceAttributeV1Alpha3 DeviceAttribute must have exactly one field set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceAttributeV1Alpha3: k8s.DeviceAttributeV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bool | boolean | BoolValue is a true/false value. | | int | number | IntValue is a number. | | string | string | StringValue is a string. | | version | string | VersionValue is a semantic version according to semver.org spec 2.0.0. Must not be longer than 64 characters. | --- ##### `bool`^Optional ```typescript public readonly bool: boolean; ``` - *Type:* boolean BoolValue is a true/false value. --- ##### `int`^Optional ```typescript public readonly int: number; ``` - *Type:* number IntValue is a number. --- ##### `string`^Optional ```typescript public readonly string: string; ``` - *Type:* string StringValue is a string. Must not be longer than 64 characters. --- ##### `version`^Optional ```typescript public readonly version: string; ``` - *Type:* string VersionValue is a semantic version according to semver.org spec 2.0.0. Must not be longer than 64 characters. --- ### DeviceAttributeV1Beta1 DeviceAttribute must have exactly one field set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceAttributeV1Beta1: k8s.DeviceAttributeV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bool | boolean | BoolValue is a true/false value. | | int | number | IntValue is a number. | | string | string | StringValue is a string. | | version | string | VersionValue is a semantic version according to semver.org spec 2.0.0. Must not be longer than 64 characters. | --- ##### `bool`^Optional ```typescript public readonly bool: boolean; ``` - *Type:* boolean BoolValue is a true/false value. --- ##### `int`^Optional ```typescript public readonly int: number; ``` - *Type:* number IntValue is a number. --- ##### `string`^Optional ```typescript public readonly string: string; ``` - *Type:* string StringValue is a string. Must not be longer than 64 characters. --- ##### `version`^Optional ```typescript public readonly version: string; ``` - *Type:* string VersionValue is a semantic version according to semver.org spec 2.0.0. Must not be longer than 64 characters. --- ### DeviceCapacityV1Beta1 DeviceCapacity describes a quantity associated with a device. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceCapacityV1Beta1: k8s.DeviceCapacityV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | value | cdk8s-plus-32.k8s.Quantity | Value defines how much of a certain device capacity is available. | --- ##### `value`^Required ```typescript public readonly value: Quantity; ``` - *Type:* cdk8s-plus-32.k8s.Quantity Value defines how much of a certain device capacity is available. --- ### DeviceClaimConfigurationV1Alpha3 DeviceClaimConfiguration is used for configuration parameters in DeviceClaim. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceClaimConfigurationV1Alpha3: k8s.DeviceClaimConfigurationV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | opaque | cdk8s-plus-32.k8s.OpaqueDeviceConfigurationV1Alpha3 | Opaque provides driver-specific configuration parameters. | | requests | string[] | Requests lists the names of requests where the configuration applies. | --- ##### `opaque`^Optional ```typescript public readonly opaque: OpaqueDeviceConfigurationV1Alpha3; ``` - *Type:* cdk8s-plus-32.k8s.OpaqueDeviceConfigurationV1Alpha3 Opaque provides driver-specific configuration parameters. --- ##### `requests`^Optional ```typescript public readonly requests: string[]; ``` - *Type:* string[] Requests lists the names of requests where the configuration applies. If empty, it applies to all requests. --- ### DeviceClaimConfigurationV1Beta1 DeviceClaimConfiguration is used for configuration parameters in DeviceClaim. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceClaimConfigurationV1Beta1: k8s.DeviceClaimConfigurationV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | opaque | cdk8s-plus-32.k8s.OpaqueDeviceConfigurationV1Beta1 | Opaque provides driver-specific configuration parameters. | | requests | string[] | Requests lists the names of requests where the configuration applies. | --- ##### `opaque`^Optional ```typescript public readonly opaque: OpaqueDeviceConfigurationV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.OpaqueDeviceConfigurationV1Beta1 Opaque provides driver-specific configuration parameters. --- ##### `requests`^Optional ```typescript public readonly requests: string[]; ``` - *Type:* string[] Requests lists the names of requests where the configuration applies. If empty, it applies to all requests. --- ### DeviceClaimV1Alpha3 DeviceClaim defines how to request devices with a ResourceClaim. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceClaimV1Alpha3: k8s.DeviceClaimV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | config | cdk8s-plus-32.k8s.DeviceClaimConfigurationV1Alpha3[] | This field holds configuration for multiple potential drivers which could satisfy requests in this claim. | | constraints | cdk8s-plus-32.k8s.DeviceConstraintV1Alpha3[] | These constraints must be satisfied by the set of devices that get allocated for the claim. | | requests | cdk8s-plus-32.k8s.DeviceRequestV1Alpha3[] | Requests represent individual requests for distinct devices which must all be satisfied. | --- ##### `config`^Optional ```typescript public readonly config: DeviceClaimConfigurationV1Alpha3[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceClaimConfigurationV1Alpha3[] This field holds configuration for multiple potential drivers which could satisfy requests in this claim. It is ignored while allocating the claim. --- ##### `constraints`^Optional ```typescript public readonly constraints: DeviceConstraintV1Alpha3[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceConstraintV1Alpha3[] These constraints must be satisfied by the set of devices that get allocated for the claim. --- ##### `requests`^Optional ```typescript public readonly requests: DeviceRequestV1Alpha3[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceRequestV1Alpha3[] Requests represent individual requests for distinct devices which must all be satisfied. If empty, nothing needs to be allocated. --- ### DeviceClaimV1Beta1 DeviceClaim defines how to request devices with a ResourceClaim. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceClaimV1Beta1: k8s.DeviceClaimV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | config | cdk8s-plus-32.k8s.DeviceClaimConfigurationV1Beta1[] | This field holds configuration for multiple potential drivers which could satisfy requests in this claim. | | constraints | cdk8s-plus-32.k8s.DeviceConstraintV1Beta1[] | These constraints must be satisfied by the set of devices that get allocated for the claim. | | requests | cdk8s-plus-32.k8s.DeviceRequestV1Beta1[] | Requests represent individual requests for distinct devices which must all be satisfied. | --- ##### `config`^Optional ```typescript public readonly config: DeviceClaimConfigurationV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceClaimConfigurationV1Beta1[] This field holds configuration for multiple potential drivers which could satisfy requests in this claim. It is ignored while allocating the claim. --- ##### `constraints`^Optional ```typescript public readonly constraints: DeviceConstraintV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceConstraintV1Beta1[] These constraints must be satisfied by the set of devices that get allocated for the claim. --- ##### `requests`^Optional ```typescript public readonly requests: DeviceRequestV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceRequestV1Beta1[] Requests represent individual requests for distinct devices which must all be satisfied. If empty, nothing needs to be allocated. --- ### DeviceClassConfigurationV1Alpha3 DeviceClassConfiguration is used in DeviceClass. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceClassConfigurationV1Alpha3: k8s.DeviceClassConfigurationV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | opaque | cdk8s-plus-32.k8s.OpaqueDeviceConfigurationV1Alpha3 | Opaque provides driver-specific configuration parameters. | --- ##### `opaque`^Optional ```typescript public readonly opaque: OpaqueDeviceConfigurationV1Alpha3; ``` - *Type:* cdk8s-plus-32.k8s.OpaqueDeviceConfigurationV1Alpha3 Opaque provides driver-specific configuration parameters. --- ### DeviceClassConfigurationV1Beta1 DeviceClassConfiguration is used in DeviceClass. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceClassConfigurationV1Beta1: k8s.DeviceClassConfigurationV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | opaque | cdk8s-plus-32.k8s.OpaqueDeviceConfigurationV1Beta1 | Opaque provides driver-specific configuration parameters. | --- ##### `opaque`^Optional ```typescript public readonly opaque: OpaqueDeviceConfigurationV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.OpaqueDeviceConfigurationV1Beta1 Opaque provides driver-specific configuration parameters. --- ### DeviceClassSpecV1Alpha3 DeviceClassSpec is used in a [DeviceClass] to define what can be allocated and how to configure it. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceClassSpecV1Alpha3: k8s.DeviceClassSpecV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | config | cdk8s-plus-32.k8s.DeviceClassConfigurationV1Alpha3[] | Config defines configuration parameters that apply to each device that is claimed via this class. | | selectors | cdk8s-plus-32.k8s.DeviceSelectorV1Alpha3[] | Each selector must be satisfied by a device which is claimed via this class. | --- ##### `config`^Optional ```typescript public readonly config: DeviceClassConfigurationV1Alpha3[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceClassConfigurationV1Alpha3[] Config defines configuration parameters that apply to each device that is claimed via this class. Some classses may potentially be satisfied by multiple drivers, so each instance of a vendor configuration applies to exactly one driver. They are passed to the driver, but are not considered while allocating the claim. --- ##### `selectors`^Optional ```typescript public readonly selectors: DeviceSelectorV1Alpha3[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceSelectorV1Alpha3[] Each selector must be satisfied by a device which is claimed via this class. --- ### DeviceClassSpecV1Beta1 DeviceClassSpec is used in a [DeviceClass] to define what can be allocated and how to configure it. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceClassSpecV1Beta1: k8s.DeviceClassSpecV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | config | cdk8s-plus-32.k8s.DeviceClassConfigurationV1Beta1[] | Config defines configuration parameters that apply to each device that is claimed via this class. | | selectors | cdk8s-plus-32.k8s.DeviceSelectorV1Beta1[] | Each selector must be satisfied by a device which is claimed via this class. | --- ##### `config`^Optional ```typescript public readonly config: DeviceClassConfigurationV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceClassConfigurationV1Beta1[] Config defines configuration parameters that apply to each device that is claimed via this class. Some classses may potentially be satisfied by multiple drivers, so each instance of a vendor configuration applies to exactly one driver. They are passed to the driver, but are not considered while allocating the claim. --- ##### `selectors`^Optional ```typescript public readonly selectors: DeviceSelectorV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceSelectorV1Beta1[] Each selector must be satisfied by a device which is claimed via this class. --- ### DeviceConstraintV1Alpha3 DeviceConstraint must have exactly one field set besides Requests. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceConstraintV1Alpha3: k8s.DeviceConstraintV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | matchAttribute | string | MatchAttribute requires that all devices in question have this attribute and that its type and value are the same across those devices. | | requests | string[] | Requests is a list of the one or more requests in this claim which must co-satisfy this constraint. | --- ##### `matchAttribute`^Optional ```typescript public readonly matchAttribute: string; ``` - *Type:* string MatchAttribute requires that all devices in question have this attribute and that its type and value are the same across those devices. For example, if you specified "dra.example.com/numa" (a hypothetical example!), then only devices in the same NUMA node will be chosen. A device which does not have that attribute will not be chosen. All devices should use a value of the same type for this attribute because that is part of its specification, but if one device doesn't, then it also will not be chosen. Must include the domain qualifier. --- ##### `requests`^Optional ```typescript public readonly requests: string[]; ``` - *Type:* string[] Requests is a list of the one or more requests in this claim which must co-satisfy this constraint. If a request is fulfilled by multiple devices, then all of the devices must satisfy the constraint. If this is not specified, this constraint applies to all requests in this claim. --- ### DeviceConstraintV1Beta1 DeviceConstraint must have exactly one field set besides Requests. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceConstraintV1Beta1: k8s.DeviceConstraintV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | matchAttribute | string | MatchAttribute requires that all devices in question have this attribute and that its type and value are the same across those devices. | | requests | string[] | Requests is a list of the one or more requests in this claim which must co-satisfy this constraint. | --- ##### `matchAttribute`^Optional ```typescript public readonly matchAttribute: string; ``` - *Type:* string MatchAttribute requires that all devices in question have this attribute and that its type and value are the same across those devices. For example, if you specified "dra.example.com/numa" (a hypothetical example!), then only devices in the same NUMA node will be chosen. A device which does not have that attribute will not be chosen. All devices should use a value of the same type for this attribute because that is part of its specification, but if one device doesn't, then it also will not be chosen. Must include the domain qualifier. --- ##### `requests`^Optional ```typescript public readonly requests: string[]; ``` - *Type:* string[] Requests is a list of the one or more requests in this claim which must co-satisfy this constraint. If a request is fulfilled by multiple devices, then all of the devices must satisfy the constraint. If this is not specified, this constraint applies to all requests in this claim. --- ### DeviceRequestV1Alpha3 DeviceRequest is a request for devices required for a claim. This is typically a request for a single resource like a device, but can also ask for several identical devices. A DeviceClassName is currently required. Clients must check that it is indeed set. It's absence indicates that something changed in a way that is not supported by the client yet, in which case it must refuse to handle the request. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceRequestV1Alpha3: k8s.DeviceRequestV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | deviceClassName | string | DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request. | | name | string | Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim. | | adminAccess | boolean | AdminAccess indicates that this is a claim for administrative access to the device(s). | | allocationMode | string | AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:. | | count | number | Count is used only when the count mode is "ExactCount". | | selectors | cdk8s-plus-32.k8s.DeviceSelectorV1Alpha3[] | Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. | --- ##### `deviceClassName`^Required ```typescript public readonly deviceClassName: string; ``` - *Type:* string DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request. A class is required. Which classes are available depends on the cluster. Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim. Must be a DNS label. --- ##### `adminAccess`^Optional ```typescript public readonly adminAccess: boolean; ``` - *Type:* boolean AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device. They ignore all ordinary claims to the device with respect to access modes and any resource allocations. This is an alpha field and requires enabling the DRAAdminAccess feature gate. Admin access is disabled if this field is unset or set to false, otherwise it is enabled. --- ##### `allocationMode`^Optional ```typescript public readonly allocationMode: string; ``` - *Type:* string AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:. ExactCount: This request is for a specific number of devices. This is the default. The exact number is provided in the count field. - All: This request is for all of the matching devices in a pool. Allocation will fail if some devices are already allocated, unless adminAccess is requested. If AlloctionMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other requests must specify this field. More modes may get added in the future. Clients must refuse to handle requests with unknown modes. --- ##### `count`^Optional ```typescript public readonly count: number; ``` - *Type:* number Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one. --- ##### `selectors`^Optional ```typescript public readonly selectors: DeviceSelectorV1Alpha3[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceSelectorV1Alpha3[] Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered. --- ### DeviceRequestV1Beta1 DeviceRequest is a request for devices required for a claim. This is typically a request for a single resource like a device, but can also ask for several identical devices. A DeviceClassName is currently required. Clients must check that it is indeed set. It's absence indicates that something changed in a way that is not supported by the client yet, in which case it must refuse to handle the request. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceRequestV1Beta1: k8s.DeviceRequestV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | deviceClassName | string | DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request. | | name | string | Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim. | | adminAccess | boolean | AdminAccess indicates that this is a claim for administrative access to the device(s). | | allocationMode | string | AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:. | | count | number | Count is used only when the count mode is "ExactCount". | | selectors | cdk8s-plus-32.k8s.DeviceSelectorV1Beta1[] | Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. | --- ##### `deviceClassName`^Required ```typescript public readonly deviceClassName: string; ``` - *Type:* string DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request. A class is required. Which classes are available depends on the cluster. Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim. Must be a DNS label. --- ##### `adminAccess`^Optional ```typescript public readonly adminAccess: boolean; ``` - *Type:* boolean AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device. They ignore all ordinary claims to the device with respect to access modes and any resource allocations. This is an alpha field and requires enabling the DRAAdminAccess feature gate. Admin access is disabled if this field is unset or set to false, otherwise it is enabled. --- ##### `allocationMode`^Optional ```typescript public readonly allocationMode: string; ``` - *Type:* string AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:. ExactCount: This request is for a specific number of devices. This is the default. The exact number is provided in the count field. - All: This request is for all of the matching devices in a pool. Allocation will fail if some devices are already allocated, unless adminAccess is requested. If AlloctionMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other requests must specify this field. More modes may get added in the future. Clients must refuse to handle requests with unknown modes. --- ##### `count`^Optional ```typescript public readonly count: number; ``` - *Type:* number Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one. --- ##### `selectors`^Optional ```typescript public readonly selectors: DeviceSelectorV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceSelectorV1Beta1[] Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered. --- ### DeviceSelectorV1Alpha3 DeviceSelector must have exactly one field set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceSelectorV1Alpha3: k8s.DeviceSelectorV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cel | cdk8s-plus-32.k8s.CelDeviceSelectorV1Alpha3 | CEL contains a CEL expression for selecting a device. | --- ##### `cel`^Optional ```typescript public readonly cel: CelDeviceSelectorV1Alpha3; ``` - *Type:* cdk8s-plus-32.k8s.CelDeviceSelectorV1Alpha3 CEL contains a CEL expression for selecting a device. --- ### DeviceSelectorV1Beta1 DeviceSelector must have exactly one field set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceSelectorV1Beta1: k8s.DeviceSelectorV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cel | cdk8s-plus-32.k8s.CelDeviceSelectorV1Beta1 | CEL contains a CEL expression for selecting a device. | --- ##### `cel`^Optional ```typescript public readonly cel: CelDeviceSelectorV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.CelDeviceSelectorV1Beta1 CEL contains a CEL expression for selecting a device. --- ### DeviceV1Alpha3 Device represents one individual hardware instance that can be selected based on its attributes. Besides the name, exactly one field must be set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceV1Alpha3: k8s.DeviceV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name is unique identifier among all devices managed by the driver in the pool. | | basic | cdk8s-plus-32.k8s.BasicDeviceV1Alpha3 | Basic defines one device instance. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is unique identifier among all devices managed by the driver in the pool. It must be a DNS label. --- ##### `basic`^Optional ```typescript public readonly basic: BasicDeviceV1Alpha3; ``` - *Type:* cdk8s-plus-32.k8s.BasicDeviceV1Alpha3 Basic defines one device instance. --- ### DeviceV1Beta1 Device represents one individual hardware instance that can be selected based on its attributes. Besides the name, exactly one field must be set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const deviceV1Beta1: k8s.DeviceV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name is unique identifier among all devices managed by the driver in the pool. | | basic | cdk8s-plus-32.k8s.BasicDeviceV1Beta1 | Basic defines one device instance. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is unique identifier among all devices managed by the driver in the pool. It must be a DNS label. --- ##### `basic`^Optional ```typescript public readonly basic: BasicDeviceV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.BasicDeviceV1Beta1 Basic defines one device instance. --- ### DnsOption Custom DNS option. #### Initializer ```typescript import { DnsOption } from 'cdk8s-plus-32' const dnsOption: DnsOption = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Option name. | | value | string | Option value. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Option name. --- ##### `value`^Optional ```typescript public readonly value: string; ``` - *Type:* string - *Default:* No value. Option value. --- ### DockerConfigSecretProps Options for `DockerConfigSecret`. #### Initializer ```typescript import { DockerConfigSecretProps } from 'cdk8s-plus-32' const dockerConfigSecretProps: DockerConfigSecretProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | data | {[ key: string ]: any} | JSON content to provide for the `~/.docker/config.json` file. This will be stringified and inserted as stringData. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional ```typescript public readonly immutable: boolean; ``` - *Type:* boolean - *Default:* false If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. --- ##### `data`^Required ```typescript public readonly data: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} JSON content to provide for the `~/.docker/config.json` file. This will be stringified and inserted as stringData. > [https://docs.docker.com/engine/reference/commandline/cli/#sample-configuration-file](https://docs.docker.com/engine/reference/commandline/cli/#sample-configuration-file) --- ### DownwardApiProjection Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const downwardApiProjection: k8s.DownwardApiProjection = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.DownwardApiVolumeFile[] | Items is a list of DownwardAPIVolume file. | --- ##### `items`^Optional ```typescript public readonly items: DownwardApiVolumeFile[]; ``` - *Type:* cdk8s-plus-32.k8s.DownwardApiVolumeFile[] Items is a list of DownwardAPIVolume file. --- ### DownwardApiVolumeFile DownwardAPIVolumeFile represents information to create the file containing the pod field. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const downwardApiVolumeFile: k8s.DownwardApiVolumeFile = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | string | Required: Path is the relative path name of the file to be created. | | fieldRef | cdk8s-plus-32.k8s.ObjectFieldSelector | Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. | | mode | number | Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. | | resourceFieldRef | cdk8s-plus-32.k8s.ResourceFieldSelector | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. | --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' --- ##### `fieldRef`^Optional ```typescript public readonly fieldRef: ObjectFieldSelector; ``` - *Type:* cdk8s-plus-32.k8s.ObjectFieldSelector Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. --- ##### `mode`^Optional ```typescript public readonly mode: number; ``` - *Type:* number Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. --- ##### `resourceFieldRef`^Optional ```typescript public readonly resourceFieldRef: ResourceFieldSelector; ``` - *Type:* cdk8s-plus-32.k8s.ResourceFieldSelector Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. --- ### DownwardApiVolumeSource DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const downwardApiVolumeSource: k8s.DownwardApiVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultMode | number | Optional: mode bits to use on created files by default. | | items | cdk8s-plus-32.k8s.DownwardApiVolumeFile[] | Items is a list of downward API volume file. | --- ##### `defaultMode`^Optional ```typescript public readonly defaultMode: number; ``` - *Type:* number - *Default:* 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. --- ##### `items`^Optional ```typescript public readonly items: DownwardApiVolumeFile[]; ``` - *Type:* cdk8s-plus-32.k8s.DownwardApiVolumeFile[] Items is a list of downward API volume file. --- ### EmptyDirVolumeOptions Options for volumes populated with an empty directory. #### Initializer ```typescript import { EmptyDirVolumeOptions } from 'cdk8s-plus-32' const emptyDirVolumeOptions: EmptyDirVolumeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | medium | EmptyDirMedium | By default, emptyDir volumes are stored on whatever medium is backing the node - that might be disk or SSD or network storage, depending on your environment. | | sizeLimit | cdk8s.Size | Total amount of local storage required for this EmptyDir volume. | --- ##### `medium`^Optional ```typescript public readonly medium: EmptyDirMedium; ``` - *Type:* EmptyDirMedium - *Default:* EmptyDirMedium.DEFAULT By default, emptyDir volumes are stored on whatever medium is backing the node - that might be disk or SSD or network storage, depending on your environment. However, you can set the emptyDir.medium field to `EmptyDirMedium.MEMORY` to tell Kubernetes to mount a tmpfs (RAM-backed filesystem) for you instead. While tmpfs is very fast, be aware that unlike disks, tmpfs is cleared on node reboot and any files you write will count against your Container's memory limit. --- ##### `sizeLimit`^Optional ```typescript public readonly sizeLimit: Size; ``` - *Type:* cdk8s.Size - *Default:* limit is undefined Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. --- ### EmptyDirVolumeSource Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const emptyDirVolumeSource: k8s.EmptyDirVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | medium | string | medium represents what type of storage medium should back this directory. | | sizeLimit | cdk8s-plus-32.k8s.Quantity | sizeLimit is the total amount of local storage required for this EmptyDir volume. | --- ##### `medium`^Optional ```typescript public readonly medium: string; ``` - *Type:* string medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir --- ##### `sizeLimit`^Optional ```typescript public readonly sizeLimit: Quantity; ``` - *Type:* cdk8s-plus-32.k8s.Quantity sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir --- ### Endpoint Endpoint represents a single logical "backend" implementing a service. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const endpoint: k8s.Endpoint = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | addresses | string[] | addresses of this endpoint. | | conditions | cdk8s-plus-32.k8s.EndpointConditions | conditions contains information about the current status of the endpoint. | | deprecatedTopology | {[ key: string ]: string} | deprecatedTopology contains topology information part of the v1beta1 API. | | hints | cdk8s-plus-32.k8s.EndpointHints | hints contains information associated with how an endpoint should be consumed. | | hostname | string | hostname of this endpoint. | | nodeName | string | nodeName represents the name of the Node hosting this endpoint. | | targetRef | cdk8s-plus-32.k8s.ObjectReference | targetRef is a reference to a Kubernetes object that represents this endpoint. | | zone | string | zone is the name of the Zone this endpoint exists in. | --- ##### `addresses`^Required ```typescript public readonly addresses: string[]; ``` - *Type:* string[] addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100. These are all assumed to be fungible and clients may choose to only use the first element. Refer to: https://issue.k8s.io/106267 --- ##### `conditions`^Optional ```typescript public readonly conditions: EndpointConditions; ``` - *Type:* cdk8s-plus-32.k8s.EndpointConditions conditions contains information about the current status of the endpoint. --- ##### `deprecatedTopology`^Optional ```typescript public readonly deprecatedTopology: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead. --- ##### `hints`^Optional ```typescript public readonly hints: EndpointHints; ``` - *Type:* cdk8s-plus-32.k8s.EndpointHints hints contains information associated with how an endpoint should be consumed. --- ##### `hostname`^Optional ```typescript public readonly hostname: string; ``` - *Type:* string hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation. --- ##### `nodeName`^Optional ```typescript public readonly nodeName: string; ``` - *Type:* string nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. --- ##### `targetRef`^Optional ```typescript public readonly targetRef: ObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.ObjectReference targetRef is a reference to a Kubernetes object that represents this endpoint. --- ##### `zone`^Optional ```typescript public readonly zone: string; ``` - *Type:* string zone is the name of the Zone this endpoint exists in. --- ### EndpointAddress EndpointAddress is a tuple that describes single IP address. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const endpointAddress: k8s.EndpointAddress = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ip | string | The IP of this endpoint. | | hostname | string | The Hostname of this endpoint. | | nodeName | string | Optional: Node hosting this endpoint. | | targetRef | cdk8s-plus-32.k8s.ObjectReference | Reference to object providing the endpoint. | --- ##### `ip`^Required ```typescript public readonly ip: string; ``` - *Type:* string The IP of this endpoint. May not be loopback (127.0.0.0/8 or ::1), link-local (169.254.0.0/16 or fe80::/10), or link-local multicast (224.0.0.0/24 or ff02::/16). --- ##### `hostname`^Optional ```typescript public readonly hostname: string; ``` - *Type:* string The Hostname of this endpoint. --- ##### `nodeName`^Optional ```typescript public readonly nodeName: string; ``` - *Type:* string Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. --- ##### `targetRef`^Optional ```typescript public readonly targetRef: ObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.ObjectReference Reference to object providing the endpoint. --- ### EndpointConditions EndpointConditions represents the current condition of an endpoint. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const endpointConditions: k8s.EndpointConditions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ready | boolean | ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. | | serving | boolean | serving is identical to ready except that it is set regardless of the terminating state of endpoints. | | terminating | boolean | terminating indicates that this endpoint is terminating. | --- ##### `ready`^Optional ```typescript public readonly ready: boolean; ``` - *Type:* boolean ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints, except when the normal readiness behavior is being explicitly overridden, for example when the associated Service has set the publishNotReadyAddresses flag. --- ##### `serving`^Optional ```typescript public readonly serving: boolean; ``` - *Type:* boolean serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. --- ##### `terminating`^Optional ```typescript public readonly terminating: boolean; ``` - *Type:* boolean terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. --- ### EndpointHints EndpointHints provides hints describing how an endpoint should be consumed. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const endpointHints: k8s.EndpointHints = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | forZones | cdk8s-plus-32.k8s.ForZone[] | forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing. | --- ##### `forZones`^Optional ```typescript public readonly forZones: ForZone[]; ``` - *Type:* cdk8s-plus-32.k8s.ForZone[] forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing. --- ### EndpointPort EndpointPort is a tuple that describes a single port. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const endpointPort: k8s.EndpointPort = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | port | number | The port number of the endpoint. | | appProtocol | string | The application protocol for this port. | | name | string | The name of this port. | | protocol | string | The IP protocol for this port. | --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number The port number of the endpoint. --- ##### `appProtocol`^Optional ```typescript public readonly appProtocol: string; ``` - *Type:* string The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either: * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). * Kubernetes-defined prefixed names: * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined. --- ##### `protocol`^Optional ```typescript public readonly protocol: string; ``` - *Type:* string - *Default:* TCP. The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. --- ### EndpointSubset EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] } The resulting set of endpoints can be viewed as: a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ] #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const endpointSubset: k8s.EndpointSubset = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | addresses | cdk8s-plus-32.k8s.EndpointAddress[] | IP addresses which offer the related ports that are marked as ready. | | notReadyAddresses | cdk8s-plus-32.k8s.EndpointAddress[] | IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. | | ports | cdk8s-plus-32.k8s.EndpointPort[] | Port numbers available on the related IP addresses. | --- ##### `addresses`^Optional ```typescript public readonly addresses: EndpointAddress[]; ``` - *Type:* cdk8s-plus-32.k8s.EndpointAddress[] IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. --- ##### `notReadyAddresses`^Optional ```typescript public readonly notReadyAddresses: EndpointAddress[]; ``` - *Type:* cdk8s-plus-32.k8s.EndpointAddress[] IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. --- ##### `ports`^Optional ```typescript public readonly ports: EndpointPort[]; ``` - *Type:* cdk8s-plus-32.k8s.EndpointPort[] Port numbers available on the related IP addresses. --- ### EnvFromSource EnvFromSource represents the source of a set of ConfigMaps. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const envFromSource: k8s.EnvFromSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configMapRef | cdk8s-plus-32.k8s.ConfigMapEnvSource | The ConfigMap to select from. | | prefix | string | An optional identifier to prepend to each key in the ConfigMap. | | secretRef | cdk8s-plus-32.k8s.SecretEnvSource | The Secret to select from. | --- ##### `configMapRef`^Optional ```typescript public readonly configMapRef: ConfigMapEnvSource; ``` - *Type:* cdk8s-plus-32.k8s.ConfigMapEnvSource The ConfigMap to select from. --- ##### `prefix`^Optional ```typescript public readonly prefix: string; ``` - *Type:* string An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. --- ##### `secretRef`^Optional ```typescript public readonly secretRef: SecretEnvSource; ``` - *Type:* cdk8s-plus-32.k8s.SecretEnvSource The Secret to select from. --- ### EnvValueFromConfigMapOptions Options to specify an envionment variable value from a ConfigMap key. #### Initializer ```typescript import { EnvValueFromConfigMapOptions } from 'cdk8s-plus-32' const envValueFromConfigMapOptions: EnvValueFromConfigMapOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | optional | boolean | Specify whether the ConfigMap or its key must be defined. | --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean - *Default:* false Specify whether the ConfigMap or its key must be defined. --- ### EnvValueFromFieldRefOptions Options to specify an environment variable value from a field reference. #### Initializer ```typescript import { EnvValueFromFieldRefOptions } from 'cdk8s-plus-32' const envValueFromFieldRefOptions: EnvValueFromFieldRefOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | Version of the schema the FieldPath is written in terms of. | | key | string | The key to select the pod label or annotation. | --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string Version of the schema the FieldPath is written in terms of. --- ##### `key`^Optional ```typescript public readonly key: string; ``` - *Type:* string The key to select the pod label or annotation. --- ### EnvValueFromProcessOptions Options to specify an environment variable value from the process environment. #### Initializer ```typescript import { EnvValueFromProcessOptions } from 'cdk8s-plus-32' const envValueFromProcessOptions: EnvValueFromProcessOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | required | boolean | Specify whether the key must exist in the environment. | --- ##### `required`^Optional ```typescript public readonly required: boolean; ``` - *Type:* boolean - *Default:* false Specify whether the key must exist in the environment. If this is set to true, and the key does not exist, an error will thrown. --- ### EnvValueFromResourceOptions Options to specify an environment variable value from a resource. #### Initializer ```typescript import { EnvValueFromResourceOptions } from 'cdk8s-plus-32' const envValueFromResourceOptions: EnvValueFromResourceOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | container | Container | The container to select the value from. | | divisor | string | The output format of the exposed resource. | --- ##### `container`^Optional ```typescript public readonly container: Container; ``` - *Type:* Container The container to select the value from. --- ##### `divisor`^Optional ```typescript public readonly divisor: string; ``` - *Type:* string The output format of the exposed resource. --- ### EnvValueFromSecretOptions Options to specify an environment variable value from a Secret. #### Initializer ```typescript import { EnvValueFromSecretOptions } from 'cdk8s-plus-32' const envValueFromSecretOptions: EnvValueFromSecretOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | optional | boolean | Specify whether the Secret or its key must be defined. | --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean - *Default:* false Specify whether the Secret or its key must be defined. --- ### EnvVar EnvVar represents an environment variable present in a Container. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const envVar: k8s.EnvVar = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name of the environment variable. | | value | string | Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. | | valueFrom | cdk8s-plus-32.k8s.EnvVarSource | Source for the environment variable's value. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of the environment variable. Must be a C_IDENTIFIER. --- ##### `value`^Optional ```typescript public readonly value: string; ``` - *Type:* string - *Default:* . Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". --- ##### `valueFrom`^Optional ```typescript public readonly valueFrom: EnvVarSource; ``` - *Type:* cdk8s-plus-32.k8s.EnvVarSource Source for the environment variable's value. Cannot be used if value is not empty. --- ### EnvVarSource EnvVarSource represents a source for the value of an EnvVar. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const envVarSource: k8s.EnvVarSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configMapKeyRef | cdk8s-plus-32.k8s.ConfigMapKeySelector | Selects a key of a ConfigMap. | | fieldRef | cdk8s-plus-32.k8s.ObjectFieldSelector | Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. | | resourceFieldRef | cdk8s-plus-32.k8s.ResourceFieldSelector | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. | | secretKeyRef | cdk8s-plus-32.k8s.SecretKeySelector | Selects a key of a secret in the pod's namespace. | --- ##### `configMapKeyRef`^Optional ```typescript public readonly configMapKeyRef: ConfigMapKeySelector; ``` - *Type:* cdk8s-plus-32.k8s.ConfigMapKeySelector Selects a key of a ConfigMap. --- ##### `fieldRef`^Optional ```typescript public readonly fieldRef: ObjectFieldSelector; ``` - *Type:* cdk8s-plus-32.k8s.ObjectFieldSelector Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. --- ##### `resourceFieldRef`^Optional ```typescript public readonly resourceFieldRef: ResourceFieldSelector; ``` - *Type:* cdk8s-plus-32.k8s.ResourceFieldSelector Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. --- ##### `secretKeyRef`^Optional ```typescript public readonly secretKeyRef: SecretKeySelector; ``` - *Type:* cdk8s-plus-32.k8s.SecretKeySelector Selects a key of a secret in the pod's namespace. --- ### EphemeralContainer An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation. To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ephemeralContainer: k8s.EphemeralContainer = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name of the ephemeral container specified as a DNS_LABEL. | | args | string[] | Arguments to the entrypoint. | | command | string[] | Entrypoint array. | | env | cdk8s-plus-32.k8s.EnvVar[] | List of environment variables to set in the container. | | envFrom | cdk8s-plus-32.k8s.EnvFromSource[] | List of sources to populate environment variables in the container. | | image | string | Container image name. | | imagePullPolicy | string | Image pull policy. | | lifecycle | cdk8s-plus-32.k8s.Lifecycle | Lifecycle is not allowed for ephemeral containers. | | livenessProbe | cdk8s-plus-32.k8s.Probe | Probes are not allowed for ephemeral containers. | | ports | cdk8s-plus-32.k8s.ContainerPort[] | Ports are not allowed for ephemeral containers. | | readinessProbe | cdk8s-plus-32.k8s.Probe | Probes are not allowed for ephemeral containers. | | resizePolicy | cdk8s-plus-32.k8s.ContainerResizePolicy[] | Resources resize policy for the container. | | resources | cdk8s-plus-32.k8s.ResourceRequirements | Resources are not allowed for ephemeral containers. | | restartPolicy | string | Restart policy for the container to manage the restart behavior of each container within a pod. | | securityContext | cdk8s-plus-32.k8s.SecurityContext | Optional: SecurityContext defines the security options the ephemeral container should be run with. | | startupProbe | cdk8s-plus-32.k8s.Probe | Probes are not allowed for ephemeral containers. | | stdin | boolean | Whether this container should allocate a buffer for stdin in the container runtime. | | stdinOnce | boolean | Whether the container runtime should close the stdin channel after it has been opened by a single attach. | | targetContainerName | string | If set, the name of the container from PodSpec that this ephemeral container targets. | | terminationMessagePath | string | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. | | terminationMessagePolicy | string | Indicate how the termination message should be populated. | | tty | boolean | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. | | volumeDevices | cdk8s-plus-32.k8s.VolumeDevice[] | volumeDevices is the list of block devices to be used by the container. | | volumeMounts | cdk8s-plus-32.k8s.VolumeMount[] | Pod volumes to mount into the container's filesystem. | | workingDir | string | Container's working directory. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. --- ##### `args`^Optional ```typescript public readonly args: string[]; ``` - *Type:* string[] Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell --- ##### `command`^Optional ```typescript public readonly command: string[]; ``` - *Type:* string[] Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell --- ##### `env`^Optional ```typescript public readonly env: EnvVar[]; ``` - *Type:* cdk8s-plus-32.k8s.EnvVar[] List of environment variables to set in the container. Cannot be updated. --- ##### `envFrom`^Optional ```typescript public readonly envFrom: EnvFromSource[]; ``` - *Type:* cdk8s-plus-32.k8s.EnvFromSource[] List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. --- ##### `image`^Optional ```typescript public readonly image: string; ``` - *Type:* string Container image name. More info: https://kubernetes.io/docs/concepts/containers/images --- ##### `imagePullPolicy`^Optional ```typescript public readonly imagePullPolicy: string; ``` - *Type:* string - *Default:* Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images --- ##### `lifecycle`^Optional ```typescript public readonly lifecycle: Lifecycle; ``` - *Type:* cdk8s-plus-32.k8s.Lifecycle Lifecycle is not allowed for ephemeral containers. --- ##### `livenessProbe`^Optional ```typescript public readonly livenessProbe: Probe; ``` - *Type:* cdk8s-plus-32.k8s.Probe Probes are not allowed for ephemeral containers. --- ##### `ports`^Optional ```typescript public readonly ports: ContainerPort[]; ``` - *Type:* cdk8s-plus-32.k8s.ContainerPort[] Ports are not allowed for ephemeral containers. --- ##### `readinessProbe`^Optional ```typescript public readonly readinessProbe: Probe; ``` - *Type:* cdk8s-plus-32.k8s.Probe Probes are not allowed for ephemeral containers. --- ##### `resizePolicy`^Optional ```typescript public readonly resizePolicy: ContainerResizePolicy[]; ``` - *Type:* cdk8s-plus-32.k8s.ContainerResizePolicy[] Resources resize policy for the container. --- ##### `resources`^Optional ```typescript public readonly resources: ResourceRequirements; ``` - *Type:* cdk8s-plus-32.k8s.ResourceRequirements Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: string; ``` - *Type:* string Restart policy for the container to manage the restart behavior of each container within a pod. This may only be set for init containers. You cannot set this field on ephemeral containers. --- ##### `securityContext`^Optional ```typescript public readonly securityContext: SecurityContext; ``` - *Type:* cdk8s-plus-32.k8s.SecurityContext Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. --- ##### `startupProbe`^Optional ```typescript public readonly startupProbe: Probe; ``` - *Type:* cdk8s-plus-32.k8s.Probe Probes are not allowed for ephemeral containers. --- ##### `stdin`^Optional ```typescript public readonly stdin: boolean; ``` - *Type:* boolean - *Default:* false. Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. --- ##### `stdinOnce`^Optional ```typescript public readonly stdinOnce: boolean; ``` - *Type:* boolean - *Default:* false Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false --- ##### `targetContainerName`^Optional ```typescript public readonly targetContainerName: string; ``` - *Type:* string If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec. The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined. --- ##### `terminationMessagePath`^Optional ```typescript public readonly terminationMessagePath: string; ``` - *Type:* string - *Default:* dev/termination-log. Cannot be updated. Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. --- ##### `terminationMessagePolicy`^Optional ```typescript public readonly terminationMessagePolicy: string; ``` - *Type:* string - *Default:* File. Cannot be updated. Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. --- ##### `tty`^Optional ```typescript public readonly tty: boolean; ``` - *Type:* boolean - *Default:* false. Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. --- ##### `volumeDevices`^Optional ```typescript public readonly volumeDevices: VolumeDevice[]; ``` - *Type:* cdk8s-plus-32.k8s.VolumeDevice[] volumeDevices is the list of block devices to be used by the container. --- ##### `volumeMounts`^Optional ```typescript public readonly volumeMounts: VolumeMount[]; ``` - *Type:* cdk8s-plus-32.k8s.VolumeMount[] Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated. --- ##### `workingDir`^Optional ```typescript public readonly workingDir: string; ``` - *Type:* string Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. --- ### EphemeralStorageResources Emphemeral storage request and limit. #### Initializer ```typescript import { EphemeralStorageResources } from 'cdk8s-plus-32' const ephemeralStorageResources: EphemeralStorageResources = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | limit | cdk8s.Size | *No description.* | | request | cdk8s.Size | *No description.* | --- ##### `limit`^Optional ```typescript public readonly limit: Size; ``` - *Type:* cdk8s.Size --- ##### `request`^Optional ```typescript public readonly request: Size; ``` - *Type:* cdk8s.Size --- ### EphemeralVolumeSource Represents an ephemeral volume that is handled by a normal storage driver. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ephemeralVolumeSource: k8s.EphemeralVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | volumeClaimTemplate | cdk8s-plus-32.k8s.PersistentVolumeClaimTemplate | Will be used to create a stand-alone PVC to provision the volume. | --- ##### `volumeClaimTemplate`^Optional ```typescript public readonly volumeClaimTemplate: PersistentVolumeClaimTemplate; ``` - *Type:* cdk8s-plus-32.k8s.PersistentVolumeClaimTemplate Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil. --- ### EventSeries EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in "k8s.io/client-go/tools/events/event_broadcaster.go" shows how this struct is updated on heartbeats and can guide customized reporter implementations. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const eventSeries: k8s.EventSeries = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | count | number | count is the number of occurrences in this series up to the last heartbeat time. | | lastObservedTime | Date | lastObservedTime is the time when last Event from the series was seen before last heartbeat. | --- ##### `count`^Required ```typescript public readonly count: number; ``` - *Type:* number count is the number of occurrences in this series up to the last heartbeat time. --- ##### `lastObservedTime`^Required ```typescript public readonly lastObservedTime: Date; ``` - *Type:* Date lastObservedTime is the time when last Event from the series was seen before last heartbeat. --- ### EventSource EventSource contains information for an event. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const eventSource: k8s.EventSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | component | string | Component from which the event is generated. | | host | string | Node name on which the event is generated. | --- ##### `component`^Optional ```typescript public readonly component: string; ``` - *Type:* string Component from which the event is generated. --- ##### `host`^Optional ```typescript public readonly host: string; ``` - *Type:* string Node name on which the event is generated. --- ### ExecAction ExecAction describes a "run in container" action. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const execAction: k8s.ExecAction = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | command | string[] | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. | --- ##### `command`^Optional ```typescript public readonly command: string[]; ``` - *Type:* string[] Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. --- ### ExemptPriorityLevelConfiguration ExemptPriorityLevelConfiguration describes the configurable aspects of the handling of exempt requests. In the mandatory exempt configuration object the values in the fields here can be modified by authorized users, unlike the rest of the `spec`. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const exemptPriorityLevelConfiguration: k8s.ExemptPriorityLevelConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | lendablePercent | number | `lendablePercent` prescribes the fraction of the level's NominalCL that can be borrowed by other priority levels. | | nominalConcurrencyShares | number | `nominalConcurrencyShares` (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. | --- ##### `lendablePercent`^Optional ```typescript public readonly lendablePercent: number; ``` - *Type:* number `lendablePercent` prescribes the fraction of the level's NominalCL that can be borrowed by other priority levels. This value of this field must be between 0 and 100, inclusive, and it defaults to 0. The number of seats that other levels can borrow from this level, known as this level's LendableConcurrencyLimit (LendableCL), is defined as follows. LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 ) --- ##### `nominalConcurrencyShares`^Optional ```typescript public readonly nominalConcurrencyShares: number; ``` - *Type:* number `nominalConcurrencyShares` (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. This is the number of execution seats nominally reserved for this priority level. This DOES NOT limit the dispatching from this priority level but affects the other priority levels through the borrowing mechanism. The server's concurrency limit (ServerCL) is divided among all the priority levels in proportion to their NCS values: NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[priority level k] NCS(k) Bigger numbers mean a larger nominal concurrency limit, at the expense of every other priority level. This field has a default value of zero. --- ### ExposeDeploymentViaIngressOptions Options for exposing a deployment via an ingress. #### Initializer ```typescript import { ExposeDeploymentViaIngressOptions } from 'cdk8s-plus-32' const exposeDeploymentViaIngressOptions: ExposeDeploymentViaIngressOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name of the service to expose. | | ports | ServicePort[] | The ports that the service should bind to. | | serviceType | ServiceType | The type of the exposed service. | | ingress | Ingress | The ingress to add rules to. | | pathType | HttpIngressPathType | The type of the path. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* auto generated. The name of the service to expose. If you'd like to expose the deployment multiple times, you must explicitly set a name starting from the second expose call. --- ##### `ports`^Optional ```typescript public readonly ports: ServicePort[]; ``` - *Type:* ServicePort[] - *Default:* extracted from the deployment. The ports that the service should bind to. --- ##### `serviceType`^Optional ```typescript public readonly serviceType: ServiceType; ``` - *Type:* ServiceType - *Default:* ClusterIP. The type of the exposed service. --- ##### `ingress`^Optional ```typescript public readonly ingress: Ingress; ``` - *Type:* Ingress - *Default:* An ingress will be automatically created. The ingress to add rules to. --- ##### `pathType`^Optional ```typescript public readonly pathType: HttpIngressPathType; ``` - *Type:* HttpIngressPathType - *Default:* HttpIngressPathType.PREFIX The type of the path. --- ### ExposeServiceViaIngressOptions Options for exposing a service using an ingress. #### Initializer ```typescript import { ExposeServiceViaIngressOptions } from 'cdk8s-plus-32' const exposeServiceViaIngressOptions: ExposeServiceViaIngressOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ingress | Ingress | The ingress to add rules to. | | pathType | HttpIngressPathType | The type of the path. | --- ##### `ingress`^Optional ```typescript public readonly ingress: Ingress; ``` - *Type:* Ingress - *Default:* An ingress will be automatically created. The ingress to add rules to. --- ##### `pathType`^Optional ```typescript public readonly pathType: HttpIngressPathType; ``` - *Type:* HttpIngressPathType - *Default:* HttpIngressPathType.PREFIX The type of the path. --- ### ExternalDocumentation ExternalDocumentation allows referencing an external resource for extended documentation. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const externalDocumentation: k8s.ExternalDocumentation = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | *No description.* | | url | string | *No description.* | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string --- ### ExternalMetricSourceV2 ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const externalMetricSourceV2: k8s.ExternalMetricSourceV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metric | cdk8s-plus-32.k8s.MetricIdentifierV2 | metric identifies the target metric by name and selector. | | target | cdk8s-plus-32.k8s.MetricTargetV2 | target specifies the target value for the given metric. | --- ##### `metric`^Required ```typescript public readonly metric: MetricIdentifierV2; ``` - *Type:* cdk8s-plus-32.k8s.MetricIdentifierV2 metric identifies the target metric by name and selector. --- ##### `target`^Required ```typescript public readonly target: MetricTargetV2; ``` - *Type:* cdk8s-plus-32.k8s.MetricTargetV2 target specifies the target value for the given metric. --- ### FcVolumeSource Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const fcVolumeSource: k8s.FcVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fsType | string | fsType is the filesystem type to mount. | | lun | number | lun is Optional: FC target lun number. | | readOnly | boolean | readOnly is Optional: Defaults to false (read/write). | | targetWwNs | string[] | targetWWNs is Optional: FC target worldwide names (WWNs). | | wwids | string[] | wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. | --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. --- ##### `lun`^Optional ```typescript public readonly lun: number; ``` - *Type:* number lun is Optional: FC target lun number. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ##### `targetWwNs`^Optional ```typescript public readonly targetWwNs: string[]; ``` - *Type:* string[] targetWWNs is Optional: FC target worldwide names (WWNs). --- ##### `wwids`^Optional ```typescript public readonly wwids: string[]; ``` - *Type:* string[] wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. --- ### FieldSelectorAttributes FieldSelectorAttributes indicates a field limited access. Webhook authors are encouraged to * ensure rawSelector and requirements are not both set * consider the requirements field if set * not try to parse or consider the rawSelector field if set. This is to avoid another CVE-2022-2880 (i.e. getting different systems to agree on how exactly to parse a query is not something we want), see https://www.oxeye.io/resources/golang-parameter-smuggling-attack for more details. For the *SubjectAccessReview endpoints of the kube-apiserver: * If rawSelector is empty and requirements are empty, the request is not limited. * If rawSelector is present and requirements are empty, the rawSelector will be parsed and limited if the parsing succeeds. * If rawSelector is empty and requirements are present, the requirements should be honored * If rawSelector is present and requirements are present, the request is invalid. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const fieldSelectorAttributes: k8s.FieldSelectorAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | rawSelector | string | rawSelector is the serialization of a field selector that would be included in a query parameter. | | requirements | cdk8s-plus-32.k8s.FieldSelectorRequirement[] | requirements is the parsed interpretation of a field selector. | --- ##### `rawSelector`^Optional ```typescript public readonly rawSelector: string; ``` - *Type:* string rawSelector is the serialization of a field selector that would be included in a query parameter. Webhook implementations are encouraged to ignore rawSelector. The kube-apiserver's *SubjectAccessReview will parse the rawSelector as long as the requirements are not present. --- ##### `requirements`^Optional ```typescript public readonly requirements: FieldSelectorRequirement[]; ``` - *Type:* cdk8s-plus-32.k8s.FieldSelectorRequirement[] requirements is the parsed interpretation of a field selector. All requirements must be met for a resource instance to match the selector. Webhook implementations should handle requirements, but how to handle them is up to the webhook. Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements are not understood. --- ### FieldSelectorRequirement FieldSelectorRequirement is a selector that contains values, a key, and an operator that relates the key and values. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const fieldSelectorRequirement: k8s.FieldSelectorRequirement = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | key is the field selector key that the requirement applies to. | | operator | string | operator represents a key's relationship to a set of values. | | values | string[] | values is an array of string values. | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string key is the field selector key that the requirement applies to. --- ##### `operator`^Required ```typescript public readonly operator: string; ``` - *Type:* string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. The list of operators may grow in the future. --- ##### `values`^Optional ```typescript public readonly values: string[]; ``` - *Type:* string[] values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. --- ### FlexPersistentVolumeSource FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const flexPersistentVolumeSource: k8s.FlexPersistentVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | driver | string | driver is the name of the driver to use for this volume. | | fsType | string | fsType is the Filesystem type to mount. | | options | {[ key: string ]: string} | options is Optional: this field holds extra command options if any. | | readOnly | boolean | readOnly is Optional: defaults to false (read/write). | | secretRef | cdk8s-plus-32.k8s.SecretReference | secretRef is Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. | --- ##### `driver`^Required ```typescript public readonly driver: string; ``` - *Type:* string driver is the name of the driver to use for this volume. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. --- ##### `options`^Optional ```typescript public readonly options: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} options is Optional: this field holds extra command options if any. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ##### `secretRef`^Optional ```typescript public readonly secretRef: SecretReference; ``` - *Type:* cdk8s-plus-32.k8s.SecretReference secretRef is Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. --- ### FlexVolumeSource FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const flexVolumeSource: k8s.FlexVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | driver | string | driver is the name of the driver to use for this volume. | | fsType | string | fsType is the filesystem type to mount. | | options | {[ key: string ]: string} | options is Optional: this field holds extra command options if any. | | readOnly | boolean | readOnly is Optional: defaults to false (read/write). | | secretRef | cdk8s-plus-32.k8s.LocalObjectReference | secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. | --- ##### `driver`^Required ```typescript public readonly driver: string; ``` - *Type:* string driver is the name of the driver to use for this volume. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. --- ##### `options`^Optional ```typescript public readonly options: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} options is Optional: this field holds extra command options if any. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ##### `secretRef`^Optional ```typescript public readonly secretRef: LocalObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.LocalObjectReference secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. --- ### FlockerVolumeSource Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const flockerVolumeSource: k8s.FlockerVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | datasetName | string | datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated. | | datasetUuid | string | datasetUUID is the UUID of the dataset. | --- ##### `datasetName`^Optional ```typescript public readonly datasetName: string; ``` - *Type:* string datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated. --- ##### `datasetUuid`^Optional ```typescript public readonly datasetUuid: string; ``` - *Type:* string datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset --- ### FlowDistinguisherMethod FlowDistinguisherMethod specifies the method of a flow distinguisher. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const flowDistinguisherMethod: k8s.FlowDistinguisherMethod = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". | --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required. --- ### FlowSchemaSpec FlowSchemaSpec describes how the FlowSchema's specification looks like. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const flowSchemaSpec: k8s.FlowSchemaSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | priorityLevelConfiguration | cdk8s-plus-32.k8s.PriorityLevelConfigurationReference | `priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. | | distinguisherMethod | cdk8s-plus-32.k8s.FlowDistinguisherMethod | `distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. | | matchingPrecedence | number | `matchingPrecedence` is used to choose among the FlowSchemas that match a given request. | | rules | cdk8s-plus-32.k8s.PolicyRulesWithSubjects[] | `rules` describes which requests will match this flow schema. | --- ##### `priorityLevelConfiguration`^Required ```typescript public readonly priorityLevelConfiguration: PriorityLevelConfigurationReference; ``` - *Type:* cdk8s-plus-32.k8s.PriorityLevelConfigurationReference `priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required. --- ##### `distinguisherMethod`^Optional ```typescript public readonly distinguisherMethod: FlowDistinguisherMethod; ``` - *Type:* cdk8s-plus-32.k8s.FlowDistinguisherMethod `distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. `nil` specifies that the distinguisher is disabled and thus will always be the empty string. --- ##### `matchingPrecedence`^Optional ```typescript public readonly matchingPrecedence: number; ``` - *Type:* number `matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default. --- ##### `rules`^Optional ```typescript public readonly rules: PolicyRulesWithSubjects[]; ``` - *Type:* cdk8s-plus-32.k8s.PolicyRulesWithSubjects[] `rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema. --- ### ForZone ForZone provides information about which zones should consume this endpoint. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const forZone: k8s.ForZone = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | name represents the name of the zone. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name represents the name of the zone. --- ### FromServiceAccountNameOptions #### Initializer ```typescript import { FromServiceAccountNameOptions } from 'cdk8s-plus-32' const fromServiceAccountNameOptions: FromServiceAccountNameOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | namespaceName | string | The name of the namespace the service account belongs to. | --- ##### `namespaceName`^Optional ```typescript public readonly namespaceName: string; ``` - *Type:* string - *Default:* "default" The name of the namespace the service account belongs to. --- ### GCEPersistentDiskPersistentVolumeProps Properties for `GCEPersistentDiskPersistentVolume`. #### Initializer ```typescript import { GCEPersistentDiskPersistentVolumeProps } from 'cdk8s-plus-32' const gCEPersistentDiskPersistentVolumeProps: GCEPersistentDiskPersistentVolumeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | PersistentVolumeAccessMode[] | Contains all ways the volume can be mounted. | | claim | IPersistentVolumeClaim | Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. | | mountOptions | string[] | A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. | | reclaimPolicy | PersistentVolumeReclaimPolicy | When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource. | | storage | cdk8s.Size | What is the storage capacity of this volume. | | storageClassName | string | Name of StorageClass to which this persistent volume belongs. | | volumeMode | PersistentVolumeMode | Defines what type of volume is required by the claim. | | pdName | string | Unique name of the PD resource in GCE. | | fsType | string | Filesystem type of the volume that you want to mount. | | partition | number | The partition in the volume that you want to mount. | | readOnly | boolean | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* PersistentVolumeAccessMode[] - *Default:* No access modes. Contains all ways the volume can be mounted. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes) --- ##### `claim`^Optional ```typescript public readonly claim: IPersistentVolumeClaim; ``` - *Type:* IPersistentVolumeClaim - *Default:* Not bound to a specific claim. Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding](https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding) --- ##### `mountOptions`^Optional ```typescript public readonly mountOptions: string[]; ``` - *Type:* string[] - *Default:* No options. A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options) --- ##### `reclaimPolicy`^Optional ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* PersistentVolumeReclaimPolicy - *Default:* PersistentVolumeReclaimPolicy.RETAIN When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource. The reclaim policy tells the cluster what to do with the volume after it has been released of its claim. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming](https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming) --- ##### `storage`^Optional ```typescript public readonly storage: Size; ``` - *Type:* cdk8s.Size - *Default:* No specified. What is the storage capacity of this volume. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources](https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources) --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`^Optional ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ##### `pdName`^Required ```typescript public readonly pdName: string; ``` - *Type:* string Unique name of the PD resource in GCE. Used to identify the disk in GCE. > [https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk](https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk) --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string - *Default:* 'ext4' Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. > [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore) --- ##### `partition`^Optional ```typescript public readonly partition: number; ``` - *Type:* number - *Default:* No partition. The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". > [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore) --- ### GCEPersistentDiskVolumeOptions Options of `Volume.fromGcePersistentDisk`. #### Initializer ```typescript import { GCEPersistentDiskVolumeOptions } from 'cdk8s-plus-32' const gCEPersistentDiskVolumeOptions: GCEPersistentDiskVolumeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fsType | string | Filesystem type of the volume that you want to mount. | | name | string | The volume name. | | partition | number | The partition in the volume that you want to mount. | | readOnly | boolean | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". | --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string - *Default:* 'ext4' Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. > [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore) --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* auto-generated The volume name. --- ##### `partition`^Optional ```typescript public readonly partition: number; ``` - *Type:* number - *Default:* No partition. The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". > [https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore](https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore) --- ### GcePersistentDiskVolumeSource Represents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const gcePersistentDiskVolumeSource: k8s.GcePersistentDiskVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | pdName | string | pdName is unique name of the PD resource in GCE. | | fsType | string | fsType is filesystem type of the volume that you want to mount. | | partition | number | partition is the partition in the volume that you want to mount. | | readOnly | boolean | readOnly here will force the ReadOnly setting in VolumeMounts. | --- ##### `pdName`^Required ```typescript public readonly pdName: string; ``` - *Type:* string pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk --- ##### `partition`^Optional ```typescript public readonly partition: number; ``` - *Type:* number partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk --- ### GitRepoVolumeSource Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const gitRepoVolumeSource: k8s.GitRepoVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | repository | string | repository is the URL. | | directory | string | directory is the target directory name. | | revision | string | revision is the commit hash for the specified revision. | --- ##### `repository`^Required ```typescript public readonly repository: string; ``` - *Type:* string repository is the URL. --- ##### `directory`^Optional ```typescript public readonly directory: string; ``` - *Type:* string directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. --- ##### `revision`^Optional ```typescript public readonly revision: string; ``` - *Type:* string revision is the commit hash for the specified revision. --- ### GlusterfsPersistentVolumeSource Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const glusterfsPersistentVolumeSource: k8s.GlusterfsPersistentVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endpoints | string | endpoints is the endpoint name that details Glusterfs topology. | | path | string | path is the Glusterfs volume path. | | endpointsNamespace | string | endpointsNamespace is the namespace that contains Glusterfs endpoint. | | readOnly | boolean | readOnly here will force the Glusterfs volume to be mounted with read-only permissions. | --- ##### `endpoints`^Required ```typescript public readonly endpoints: string; ``` - *Type:* string endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod --- ##### `endpointsNamespace`^Optional ```typescript public readonly endpointsNamespace: string; ``` - *Type:* string endpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod --- ### GlusterfsVolumeSource Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const glusterfsVolumeSource: k8s.GlusterfsVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endpoints | string | endpoints is the endpoint name that details Glusterfs topology. | | path | string | path is the Glusterfs volume path. | | readOnly | boolean | readOnly here will force the Glusterfs volume to be mounted with read-only permissions. | --- ##### `endpoints`^Required ```typescript public readonly endpoints: string; ``` - *Type:* string endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod --- ### GroupVersionResourceV1Alpha1 The names of the group, the version, and the resource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const groupVersionResourceV1Alpha1: k8s.GroupVersionResourceV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | group | string | The name of the group. | | resource | string | The name of the resource. | | version | string | The name of the version. | --- ##### `group`^Optional ```typescript public readonly group: string; ``` - *Type:* string The name of the group. --- ##### `resource`^Optional ```typescript public readonly resource: string; ``` - *Type:* string The name of the resource. --- ##### `version`^Optional ```typescript public readonly version: string; ``` - *Type:* string The name of the version. --- ### GrpcAction GRPCAction specifies an action involving a GRPC service. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const grpcAction: k8s.GrpcAction = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | port | number | Port number of the gRPC service. | | service | string | Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). | --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number Port number of the gRPC service. Number must be in the range 1 to 65535. --- ##### `service`^Optional ```typescript public readonly service: string; ``` - *Type:* string Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. --- ### GrpcProbeOptions Options for `Probe.fromGrpc()`. #### Initializer ```typescript import { GrpcProbeOptions } from 'cdk8s-plus-32' const grpcProbeOptions: GrpcProbeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | failureThreshold | number | Minimum consecutive failures for the probe to be considered failed after having succeeded. | | initialDelaySeconds | cdk8s.Duration | Number of seconds after the container has started before liveness probes are initiated. | | periodSeconds | cdk8s.Duration | How often (in seconds) to perform the probe. | | successThreshold | number | Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. | | timeoutSeconds | cdk8s.Duration | Number of seconds after which the probe times out. | | port | number | The TCP port to connect to on the container. | | service | string | Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). | --- ##### `failureThreshold`^Optional ```typescript public readonly failureThreshold: number; ``` - *Type:* number - *Default:* 3 Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. --- ##### `initialDelaySeconds`^Optional ```typescript public readonly initialDelaySeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* immediate Number of seconds after the container has started before liveness probes are initiated. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes) --- ##### `periodSeconds`^Optional ```typescript public readonly periodSeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(10) Minimum value is 1. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. --- ##### `successThreshold`^Optional ```typescript public readonly successThreshold: number; ``` - *Type:* number - *Default:* 1 Must be 1 for liveness and startup. Minimum value is 1. Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. --- ##### `timeoutSeconds`^Optional ```typescript public readonly timeoutSeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(1) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes) --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* defaults to `container.port`. The TCP port to connect to on the container. --- ##### `service`^Optional ```typescript public readonly service: string; ``` - *Type:* string - *Default:* If this is not specified, the default behavior is defined by gRPC. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). --- ### HandlerFromHttpGetOptions Options for `Handler.fromHttpGet`. #### Initializer ```typescript import { HandlerFromHttpGetOptions } from 'cdk8s-plus-32' const handlerFromHttpGetOptions: HandlerFromHttpGetOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | port | number | The TCP port to use when sending the GET request. | --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* defaults to `container.port`. The TCP port to use when sending the GET request. --- ### HandlerFromTcpSocketOptions Options for `Handler.fromTcpSocket`. #### Initializer ```typescript import { HandlerFromTcpSocketOptions } from 'cdk8s-plus-32' const handlerFromTcpSocketOptions: HandlerFromTcpSocketOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | host | string | The host name to connect to on the container. | | port | number | The TCP port to connect to on the container. | --- ##### `host`^Optional ```typescript public readonly host: string; ``` - *Type:* string - *Default:* defaults to the pod IP The host name to connect to on the container. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* defaults to `container.port`. The TCP port to connect to on the container. --- ### HorizontalPodAutoscalerBehaviorV2 HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const horizontalPodAutoscalerBehaviorV2: k8s.HorizontalPodAutoscalerBehaviorV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | scaleDown | cdk8s-plus-32.k8s.HpaScalingRulesV2 | scaleDown is scaling policy for scaling Down. | | scaleUp | cdk8s-plus-32.k8s.HpaScalingRulesV2 | scaleUp is scaling policy for scaling Up. | --- ##### `scaleDown`^Optional ```typescript public readonly scaleDown: HpaScalingRulesV2; ``` - *Type:* cdk8s-plus-32.k8s.HpaScalingRulesV2 scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used). --- ##### `scaleUp`^Optional ```typescript public readonly scaleUp: HpaScalingRulesV2; ``` - *Type:* cdk8s-plus-32.k8s.HpaScalingRulesV2 scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of: * increase no more than 4 pods per 60 seconds * double the number of pods per 60 seconds No stabilization is used. --- ### HorizontalPodAutoscalerProps Properties for HorizontalPodAutoscaler. #### Initializer ```typescript import { HorizontalPodAutoscalerProps } from 'cdk8s-plus-32' const horizontalPodAutoscalerProps: HorizontalPodAutoscalerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | maxReplicas | number | The maximum number of replicas that can be scaled up to. | | target | IScalable | The workload to scale up or down. | | metrics | Metric[] | The metric conditions that trigger a scale up or scale down. | | 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. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `maxReplicas`^Required ```typescript public readonly maxReplicas: number; ``` - *Type:* number The maximum number of replicas that can be scaled up to. --- ##### `target`^Required ```typescript public readonly target: IScalable; ``` - *Type:* IScalable The workload to scale up or down. Scalable workload types: * Deployment * StatefulSet --- ##### `metrics`^Optional ```typescript public readonly metrics: Metric[]; ``` - *Type:* Metric[] - *Default:* If metrics are not provided, then the target resource constraints (e.g. cpu limit) will be used as scaling metrics. The metric conditions that trigger a scale up or scale down. --- ##### `minReplicas`^Optional ```typescript public readonly minReplicas: number; ``` - *Type:* number - *Default:* 1 The minimum number of replicas that can be scaled down to. Can be set to 0 if the alpha feature gate `HPAScaleToZero` is enabled and at least one Object or External metric is configured. --- ##### `scaleDown`^Optional ```typescript public readonly scaleDown: ScalingRules; ``` - *Type:* ScalingRules - *Default:* Scale down to minReplica count with a 5 minute stabilization window. The scaling behavior when scaling down. --- ##### `scaleUp`^Optional ```typescript public readonly scaleUp: ScalingRules; ``` - *Type:* ScalingRules - *Default:* Is the higher of: * Increase no more than 4 pods per 60 seconds * Double the number of pods per 60 seconds The scaling behavior when scaling up. --- ### HorizontalPodAutoscalerSpec specification of a horizontal pod autoscaler. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const horizontalPodAutoscalerSpec: k8s.HorizontalPodAutoscalerSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maxReplicas | number | maxReplicas is the upper limit for the number of pods that can be set by the autoscaler; | | scaleTargetRef | cdk8s-plus-32.k8s.CrossVersionObjectReference | reference to scaled resource; | | minReplicas | number | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. | | targetCpuUtilizationPercentage | number | targetCPUUtilizationPercentage is the target average CPU utilization (represented as a percentage of requested CPU) over all the pods; | --- ##### `maxReplicas`^Required ```typescript public readonly maxReplicas: number; ``` - *Type:* number maxReplicas is the upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas. --- ##### `scaleTargetRef`^Required ```typescript public readonly scaleTargetRef: CrossVersionObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.CrossVersionObjectReference reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource. --- ##### `minReplicas`^Optional ```typescript public readonly minReplicas: number; ``` - *Type:* number minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. --- ##### `targetCpuUtilizationPercentage`^Optional ```typescript public readonly targetCpuUtilizationPercentage: number; ``` - *Type:* number targetCPUUtilizationPercentage is the target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used. --- ### HorizontalPodAutoscalerSpecV2 HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const horizontalPodAutoscalerSpecV2: k8s.HorizontalPodAutoscalerSpecV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maxReplicas | number | maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. | | scaleTargetRef | cdk8s-plus-32.k8s.CrossVersionObjectReferenceV2 | scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. | | behavior | cdk8s-plus-32.k8s.HorizontalPodAutoscalerBehaviorV2 | behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). | | metrics | cdk8s-plus-32.k8s.MetricSpecV2[] | metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). | | minReplicas | number | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. | --- ##### `maxReplicas`^Required ```typescript public readonly maxReplicas: number; ``` - *Type:* number maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. --- ##### `scaleTargetRef`^Required ```typescript public readonly scaleTargetRef: CrossVersionObjectReferenceV2; ``` - *Type:* cdk8s-plus-32.k8s.CrossVersionObjectReferenceV2 scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. --- ##### `behavior`^Optional ```typescript public readonly behavior: HorizontalPodAutoscalerBehaviorV2; ``` - *Type:* cdk8s-plus-32.k8s.HorizontalPodAutoscalerBehaviorV2 behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used. --- ##### `metrics`^Optional ```typescript public readonly metrics: MetricSpecV2[]; ``` - *Type:* cdk8s-plus-32.k8s.MetricSpecV2[] metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization. --- ##### `minReplicas`^Optional ```typescript public readonly minReplicas: number; ``` - *Type:* number minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. --- ### HostAlias HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's /etc/hosts file. #### Initializer ```typescript import { HostAlias } from 'cdk8s-plus-32' const hostAlias: HostAlias = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | hostnames | string[] | Hostnames for the chosen IP address. | | ip | string | IP address of the host file entry. | --- ##### `hostnames`^Required ```typescript public readonly hostnames: string[]; ``` - *Type:* string[] Hostnames for the chosen IP address. --- ##### `ip`^Required ```typescript public readonly ip: string; ``` - *Type:* string IP address of the host file entry. --- ### HostAlias HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const hostAlias: k8s.HostAlias = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ip | string | IP address of the host file entry. | | hostnames | string[] | Hostnames for the above IP address. | --- ##### `ip`^Required ```typescript public readonly ip: string; ``` - *Type:* string IP address of the host file entry. --- ##### `hostnames`^Optional ```typescript public readonly hostnames: string[]; ``` - *Type:* string[] Hostnames for the above IP address. --- ### HostPathVolumeOptions Options for a HostPathVolume-based volume. #### Initializer ```typescript import { HostPathVolumeOptions } from 'cdk8s-plus-32' const hostPathVolumeOptions: HostPathVolumeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | string | The path of the directory on the host. | | type | HostPathVolumeType | The expected type of the path found on the host. | --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string The path of the directory on the host. --- ##### `type`^Optional ```typescript public readonly type: HostPathVolumeType; ``` - *Type:* HostPathVolumeType - *Default:* HostPathVolumeType.DEFAULT The expected type of the path found on the host. --- ### HostPathVolumeSource Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const hostPathVolumeSource: k8s.HostPathVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | string | path of the directory on the host. | | type | string | type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath. | --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string - *Default:* More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath. --- ### HpaScalingPolicyV2 HPAScalingPolicy is a single policy which must hold true for a specified past interval. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const hpaScalingPolicyV2: k8s.HpaScalingPolicyV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | periodSeconds | number | periodSeconds specifies the window of time for which the policy should hold true. | | type | string | type is used to specify the scaling policy. | | value | number | value contains the amount of change which is permitted by the policy. | --- ##### `periodSeconds`^Required ```typescript public readonly periodSeconds: number; ``` - *Type:* number periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min). --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string type is used to specify the scaling policy. --- ##### `value`^Required ```typescript public readonly value: number; ``` - *Type:* number value contains the amount of change which is permitted by the policy. It must be greater than zero --- ### HpaScalingRulesV2 HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const hpaScalingRulesV2: k8s.HpaScalingRulesV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | policies | cdk8s-plus-32.k8s.HpaScalingPolicyV2[] | policies is a list of potential scaling polices which can be used during scaling. | | selectPolicy | string | selectPolicy is used to specify which policy should be used. | | stabilizationWindowSeconds | number | stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. | --- ##### `policies`^Optional ```typescript public readonly policies: HpaScalingPolicyV2[]; ``` - *Type:* cdk8s-plus-32.k8s.HpaScalingPolicyV2[] policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid --- ##### `selectPolicy`^Optional ```typescript public readonly selectPolicy: string; ``` - *Type:* string selectPolicy is used to specify which policy should be used. If not set, the default value Max is used. --- ##### `stabilizationWindowSeconds`^Optional ```typescript public readonly stabilizationWindowSeconds: number; ``` - *Type:* number stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long). --- ### HttpGetAction HTTPGetAction describes an action based on HTTP Get requests. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const httpGetAction: k8s.HttpGetAction = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | port | cdk8s-plus-32.k8s.IntOrString | Name or number of the port to access on the container. | | host | string | Host name to connect to, defaults to the pod IP. | | httpHeaders | cdk8s-plus-32.k8s.HttpHeader[] | Custom headers to set in the request. | | path | string | Path to access on the HTTP server. | | scheme | string | Scheme to use for connecting to the host. | --- ##### `port`^Required ```typescript public readonly port: IntOrString; ``` - *Type:* cdk8s-plus-32.k8s.IntOrString Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. --- ##### `host`^Optional ```typescript public readonly host: string; ``` - *Type:* string Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. --- ##### `httpHeaders`^Optional ```typescript public readonly httpHeaders: HttpHeader[]; ``` - *Type:* cdk8s-plus-32.k8s.HttpHeader[] Custom headers to set in the request. HTTP allows repeated headers. --- ##### `path`^Optional ```typescript public readonly path: string; ``` - *Type:* string Path to access on the HTTP server. --- ##### `scheme`^Optional ```typescript public readonly scheme: string; ``` - *Type:* string - *Default:* HTTP. Scheme to use for connecting to the host. Defaults to HTTP. --- ### HttpGetProbeOptions Options for `Probe.fromHttpGet()`. #### Initializer ```typescript import { HttpGetProbeOptions } from 'cdk8s-plus-32' const httpGetProbeOptions: HttpGetProbeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | failureThreshold | number | Minimum consecutive failures for the probe to be considered failed after having succeeded. | | initialDelaySeconds | cdk8s.Duration | Number of seconds after the container has started before liveness probes are initiated. | | periodSeconds | cdk8s.Duration | How often (in seconds) to perform the probe. | | successThreshold | number | Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. | | timeoutSeconds | cdk8s.Duration | Number of seconds after which the probe times out. | | host | string | The host name to connect to on the container. | | httpHeaders | HttpHeader[] | Custom HTTP headers to set in the probe request. | | port | number | The TCP port to use when sending the GET request. | | scheme | ConnectionScheme | Scheme to use for connecting to the host (HTTP or HTTPS). | --- ##### `failureThreshold`^Optional ```typescript public readonly failureThreshold: number; ``` - *Type:* number - *Default:* 3 Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. --- ##### `initialDelaySeconds`^Optional ```typescript public readonly initialDelaySeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* immediate Number of seconds after the container has started before liveness probes are initiated. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes) --- ##### `periodSeconds`^Optional ```typescript public readonly periodSeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(10) Minimum value is 1. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. --- ##### `successThreshold`^Optional ```typescript public readonly successThreshold: number; ``` - *Type:* number - *Default:* 1 Must be 1 for liveness and startup. Minimum value is 1. Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. --- ##### `timeoutSeconds`^Optional ```typescript public readonly timeoutSeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(1) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes) --- ##### `host`^Optional ```typescript public readonly host: string; ``` - *Type:* string - *Default:* defaults to the pod IP The host name to connect to on the container. --- ##### `httpHeaders`^Optional ```typescript public readonly httpHeaders: HttpHeader[]; ``` - *Type:* HttpHeader[] - *Default:* no custom headers are set Custom HTTP headers to set in the probe request. Note that HTTP allows repeated headers. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* defaults to `container.port`. The TCP port to use when sending the GET request. --- ##### `scheme`^Optional ```typescript public readonly scheme: ConnectionScheme; ``` - *Type:* ConnectionScheme - *Default:* ConnectionScheme.HTTP Scheme to use for connecting to the host (HTTP or HTTPS). --- ### HttpHeader #### Initializer ```typescript import { HttpHeader } from 'cdk8s-plus-32' const httpHeader: HttpHeader = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The HTTP Header name to be used. | | value | string | The HTTP header value to be set. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The HTTP Header name to be used. --- ##### `value`^Required ```typescript public readonly value: string; ``` - *Type:* string The HTTP header value to be set. --- ### HttpHeader HTTPHeader describes a custom header to be used in HTTP probes. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const httpHeader: k8s.HttpHeader = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The header field name. | | value | string | The header field value. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. --- ##### `value`^Required ```typescript public readonly value: string; ``` - *Type:* string The header field value. --- ### HttpIngressPath HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const httpIngressPath: k8s.HttpIngressPath = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | backend | cdk8s-plus-32.k8s.IngressBackend | backend defines the referenced service endpoint to which the traffic will be forwarded to. | | pathType | string | pathType determines the interpretation of the path matching. | | path | string | path is matched against the path of an incoming request. | --- ##### `backend`^Required ```typescript public readonly backend: IngressBackend; ``` - *Type:* cdk8s-plus-32.k8s.IngressBackend backend defines the referenced service endpoint to which the traffic will be forwarded to. --- ##### `pathType`^Required ```typescript public readonly pathType: string; ``` - *Type:* string pathType determines the interpretation of the path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types. --- ##### `path`^Optional ```typescript public readonly path: string; ``` - *Type:* string path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value "Exact" or "Prefix". --- ### HttpIngressRuleValue HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const httpIngressRuleValue: k8s.HttpIngressRuleValue = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | paths | cdk8s-plus-32.k8s.HttpIngressPath[] | paths is a collection of paths that map requests to backends. | --- ##### `paths`^Required ```typescript public readonly paths: HttpIngressPath[]; ``` - *Type:* cdk8s-plus-32.k8s.HttpIngressPath[] paths is a collection of paths that map requests to backends. --- ### ImageVolumeSource ImageVolumeSource represents a image volume resource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const imageVolumeSource: k8s.ImageVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | pullPolicy | string | Policy for pulling OCI objects. | | reference | string | Required: Image or artifact reference to be used. | --- ##### `pullPolicy`^Optional ```typescript public readonly pullPolicy: string; ``` - *Type:* string - *Default:* Always if :latest tag is specified, or IfNotPresent otherwise. Policy for pulling OCI objects. Possible values are: Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. --- ##### `reference`^Optional ```typescript public readonly reference: string; ``` - *Type:* string Required: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. --- ### IngressBackend IngressBackend describes all endpoints for a given service and port. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ingressBackend: k8s.IngressBackend = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | resource | cdk8s-plus-32.k8s.TypedLocalObjectReference | resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. | | service | cdk8s-plus-32.k8s.IngressServiceBackend | service references a service as a backend. | --- ##### `resource`^Optional ```typescript public readonly resource: TypedLocalObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.TypedLocalObjectReference resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service". --- ##### `service`^Optional ```typescript public readonly service: IngressServiceBackend; ``` - *Type:* cdk8s-plus-32.k8s.IngressServiceBackend service references a service as a backend. This is a mutually exclusive setting with "Resource". --- ### IngressClassParametersReference IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ingressClassParametersReference: k8s.IngressClassParametersReference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | kind | string | kind is the type of resource being referenced. | | name | string | name is the name of resource being referenced. | | apiGroup | string | apiGroup is the group for the resource being referenced. | | namespace | string | namespace is the namespace of the resource being referenced. | | scope | string | scope represents if this refers to a cluster or namespace scoped resource. | --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string kind is the type of resource being referenced. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name is the name of resource being referenced. --- ##### `apiGroup`^Optional ```typescript public readonly apiGroup: string; ``` - *Type:* string apiGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string namespace is the namespace of the resource being referenced. This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster". --- ##### `scope`^Optional ```typescript public readonly scope: string; ``` - *Type:* string scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace". --- ### IngressClassSpec IngressClassSpec provides information about the class of an Ingress. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ingressClassSpec: k8s.IngressClassSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | controller | string | controller refers to the name of the controller that should handle this class. | | parameters | cdk8s-plus-32.k8s.IngressClassParametersReference | parameters is a link to a custom resource containing additional configuration for the controller. | --- ##### `controller`^Optional ```typescript public readonly controller: string; ``` - *Type:* string controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable. --- ##### `parameters`^Optional ```typescript public readonly parameters: IngressClassParametersReference; ``` - *Type:* cdk8s-plus-32.k8s.IngressClassParametersReference parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters. --- ### IngressProps Properties for `Ingress`. #### Initializer ```typescript import { IngressProps } from 'cdk8s-plus-32' const ingressProps: IngressProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | className | string | Class Name for this ingress. | | defaultBackend | IngressBackend | The default backend services requests that do not match any rule. | | rules | IngressRule[] | Routing rules for this ingress. | | tls | IngressTls[] | TLS settings for this ingress. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `className`^Optional ```typescript public readonly className: string; ``` - *Type:* string Class Name for this ingress. This field is a reference to an IngressClass resource that contains additional Ingress configuration, including the name of the Ingress controller. --- ##### `defaultBackend`^Optional ```typescript public readonly defaultBackend: IngressBackend; ``` - *Type:* IngressBackend The default backend services requests that do not match any rule. Using this option or the `addDefaultBackend()` method is equivalent to adding a rule with both `path` and `host` undefined. --- ##### `rules`^Optional ```typescript public readonly rules: IngressRule[]; ``` - *Type:* IngressRule[] Routing rules for this ingress. Each rule must define an `IngressBackend` that will receive the requests that match this rule. If both `host` and `path` are not specifiec, this backend will be used as the default backend of the ingress. You can also add rules later using `addRule()`, `addHostRule()`, `addDefaultBackend()` and `addHostDefaultBackend()`. --- ##### `tls`^Optional ```typescript public readonly tls: IngressTls[]; ``` - *Type:* IngressTls[] TLS settings for this ingress. Using this option tells the ingress controller to expose a TLS endpoint. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. --- ### IngressRule Represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching path. #### Initializer ```typescript import { IngressRule } from 'cdk8s-plus-32' const ingressRule: IngressRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | backend | IngressBackend | Backend defines the referenced service endpoint to which the traffic will be forwarded to. | | host | string | Host is the fully qualified domain name of a network host, as defined by RFC 3986. | | path | string | Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. | | pathType | HttpIngressPathType | Specify how the path is matched against request paths. | --- ##### `backend`^Required ```typescript public readonly backend: IngressBackend; ``` - *Type:* IngressBackend Backend defines the referenced service endpoint to which the traffic will be forwarded to. --- ##### `host`^Optional ```typescript public readonly host: string; ``` - *Type:* string - *Default:* If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The `:` delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. --- ##### `path`^Optional ```typescript public readonly path: string; ``` - *Type:* string - *Default:* If unspecified, the path defaults to a catch all sending traffic to the backend. Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. --- ##### `pathType`^Optional ```typescript public readonly pathType: HttpIngressPathType; ``` - *Type:* HttpIngressPathType Specify how the path is matched against request paths. By default, path types will be matched by prefix. > [https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types](https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types) --- ### IngressRule IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ingressRule: k8s.IngressRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | host | string | host is the fully qualified domain name of a network host, as defined by RFC 3986. | | http | cdk8s-plus-32.k8s.HttpIngressRuleValue | *No description.* | --- ##### `host`^Optional ```typescript public readonly host: string; ``` - *Type:* string host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The `:` delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If host is precise, the request matches this rule if the http host header is equal to Host. 2. If host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule. --- ##### `http`^Optional ```typescript public readonly http: HttpIngressRuleValue; ``` - *Type:* cdk8s-plus-32.k8s.HttpIngressRuleValue --- ### IngressServiceBackend IngressServiceBackend references a Kubernetes Service as a Backend. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ingressServiceBackend: k8s.IngressServiceBackend = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | name is the referenced service. | | port | cdk8s-plus-32.k8s.ServiceBackendPort | port of the referenced service. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name is the referenced service. The service must exist in the same namespace as the Ingress object. --- ##### `port`^Optional ```typescript public readonly port: ServiceBackendPort; ``` - *Type:* cdk8s-plus-32.k8s.ServiceBackendPort port of the referenced service. A port name or port number is required for a IngressServiceBackend. --- ### IngressSpec IngressSpec describes the Ingress the user wishes to exist. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ingressSpec: k8s.IngressSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultBackend | cdk8s-plus-32.k8s.IngressBackend | defaultBackend is the backend that should handle requests that don't match any rule. | | ingressClassName | string | ingressClassName is the name of an IngressClass cluster resource. | | rules | cdk8s-plus-32.k8s.IngressRule[] | rules is a list of host rules used to configure the Ingress. | | tls | cdk8s-plus-32.k8s.IngressTls[] | tls represents the TLS configuration. | --- ##### `defaultBackend`^Optional ```typescript public readonly defaultBackend: IngressBackend; ``` - *Type:* cdk8s-plus-32.k8s.IngressBackend defaultBackend is the backend that should handle requests that don't match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller. --- ##### `ingressClassName`^Optional ```typescript public readonly ingressClassName: string; ``` - *Type:* string ingressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -> IngressClass -> Ingress resource). Although the `kubernetes.io/ingress.class` annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present. --- ##### `rules`^Optional ```typescript public readonly rules: IngressRule[]; ``` - *Type:* cdk8s-plus-32.k8s.IngressRule[] rules is a list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. --- ##### `tls`^Optional ```typescript public readonly tls: IngressTls[]; ``` - *Type:* cdk8s-plus-32.k8s.IngressTls[] tls represents the TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. --- ### IngressTls Represents the TLS configuration mapping that is passed to the ingress controller for SSL termination. #### Initializer ```typescript import { IngressTls } from 'cdk8s-plus-32' const ingressTls: IngressTls = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | hosts | string[] | Hosts are a list of hosts included in the TLS certificate. | | secret | ISecret | Secret is the secret that contains the certificate and key used to terminate SSL traffic on 443. | --- ##### `hosts`^Optional ```typescript public readonly hosts: string[]; ``` - *Type:* string[] - *Default:* If unspecified, it defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress. Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the TLS Secret. --- ##### `secret`^Optional ```typescript public readonly secret: ISecret; ``` - *Type:* ISecret - *Default:* If unspecified, it allows SSL routing based on SNI hostname. Secret is the secret that contains the certificate and key used to terminate SSL traffic on 443. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. --- ### IngressTls IngressTLS describes the transport layer security associated with an ingress. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ingressTls: k8s.IngressTls = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | hosts | string[] | hosts is a list of hosts included in the TLS certificate. | | secretName | string | secretName is the name of the secret used to terminate TLS traffic on port 443. | --- ##### `hosts`^Optional ```typescript public readonly hosts: string[]; ``` - *Type:* string[] - *Default:* the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. hosts is a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. --- ##### `secretName`^Optional ```typescript public readonly secretName: string; ``` - *Type:* string secretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the "Host" header is used for routing. --- ### IpAddressSpecV1Beta1 IPAddressSpec describe the attributes in an IP Address. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ipAddressSpecV1Beta1: k8s.IpAddressSpecV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | parentRef | cdk8s-plus-32.k8s.ParentReferenceV1Beta1 | ParentRef references the resource that an IPAddress is attached to. | --- ##### `parentRef`^Required ```typescript public readonly parentRef: ParentReferenceV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.ParentReferenceV1Beta1 ParentRef references the resource that an IPAddress is attached to. An IPAddress must reference a parent object. --- ### IpBlock IPBlock describes a particular CIDR (Ex. "192.168.1.0/24","2001:db8::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ipBlock: k8s.IpBlock = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cidr | string | cidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64". | | except | string[] | except is a slice of CIDRs that should not be included within an IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" Except values will be rejected if they are outside the cidr range. | --- ##### `cidr`^Required ```typescript public readonly cidr: string; ``` - *Type:* string cidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64". --- ##### `except`^Optional ```typescript public readonly except: string[]; ``` - *Type:* string[] except is a slice of CIDRs that should not be included within an IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" Except values will be rejected if they are outside the cidr range. --- ### IscsiPersistentVolumeSource ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const iscsiPersistentVolumeSource: k8s.IscsiPersistentVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | iqn | string | iqn is Target iSCSI Qualified Name. | | lun | number | lun is iSCSI Target Lun number. | | targetPortal | string | targetPortal is iSCSI Target Portal. | | chapAuthDiscovery | boolean | chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication. | | chapAuthSession | boolean | chapAuthSession defines whether support iSCSI Session CHAP authentication. | | fsType | string | fsType is the filesystem type of the volume that you want to mount. | | initiatorName | string | initiatorName is the custom iSCSI Initiator Name. | | iscsiInterface | string | iscsiInterface is the interface Name that uses an iSCSI transport. | | portals | string[] | portals is the iSCSI Target Portal List. | | readOnly | boolean | readOnly here will force the ReadOnly setting in VolumeMounts. | | secretRef | cdk8s-plus-32.k8s.SecretReference | secretRef is the CHAP Secret for iSCSI target and initiator authentication. | --- ##### `iqn`^Required ```typescript public readonly iqn: string; ``` - *Type:* string iqn is Target iSCSI Qualified Name. --- ##### `lun`^Required ```typescript public readonly lun: number; ``` - *Type:* number lun is iSCSI Target Lun number. --- ##### `targetPortal`^Required ```typescript public readonly targetPortal: string; ``` - *Type:* string targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). --- ##### `chapAuthDiscovery`^Optional ```typescript public readonly chapAuthDiscovery: boolean; ``` - *Type:* boolean chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication. --- ##### `chapAuthSession`^Optional ```typescript public readonly chapAuthSession: boolean; ``` - *Type:* boolean chapAuthSession defines whether support iSCSI Session CHAP authentication. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi --- ##### `initiatorName`^Optional ```typescript public readonly initiatorName: string; ``` - *Type:* string initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. --- ##### `iscsiInterface`^Optional ```typescript public readonly iscsiInterface: string; ``` - *Type:* string - *Default:* default' (tcp). iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). --- ##### `portals`^Optional ```typescript public readonly portals: string[]; ``` - *Type:* string[] portals is the iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false. readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. --- ##### `secretRef`^Optional ```typescript public readonly secretRef: SecretReference; ``` - *Type:* cdk8s-plus-32.k8s.SecretReference secretRef is the CHAP Secret for iSCSI target and initiator authentication. --- ### IscsiVolumeSource Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const iscsiVolumeSource: k8s.IscsiVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | iqn | string | iqn is the target iSCSI Qualified Name. | | lun | number | lun represents iSCSI Target Lun number. | | targetPortal | string | targetPortal is iSCSI Target Portal. | | chapAuthDiscovery | boolean | chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication. | | chapAuthSession | boolean | chapAuthSession defines whether support iSCSI Session CHAP authentication. | | fsType | string | fsType is the filesystem type of the volume that you want to mount. | | initiatorName | string | initiatorName is the custom iSCSI Initiator Name. | | iscsiInterface | string | iscsiInterface is the interface Name that uses an iSCSI transport. | | portals | string[] | portals is the iSCSI Target Portal List. | | readOnly | boolean | readOnly here will force the ReadOnly setting in VolumeMounts. | | secretRef | cdk8s-plus-32.k8s.LocalObjectReference | secretRef is the CHAP Secret for iSCSI target and initiator authentication. | --- ##### `iqn`^Required ```typescript public readonly iqn: string; ``` - *Type:* string iqn is the target iSCSI Qualified Name. --- ##### `lun`^Required ```typescript public readonly lun: number; ``` - *Type:* number lun represents iSCSI Target Lun number. --- ##### `targetPortal`^Required ```typescript public readonly targetPortal: string; ``` - *Type:* string targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). --- ##### `chapAuthDiscovery`^Optional ```typescript public readonly chapAuthDiscovery: boolean; ``` - *Type:* boolean chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication. --- ##### `chapAuthSession`^Optional ```typescript public readonly chapAuthSession: boolean; ``` - *Type:* boolean chapAuthSession defines whether support iSCSI Session CHAP authentication. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi --- ##### `initiatorName`^Optional ```typescript public readonly initiatorName: string; ``` - *Type:* string initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. --- ##### `iscsiInterface`^Optional ```typescript public readonly iscsiInterface: string; ``` - *Type:* string - *Default:* default' (tcp). iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). --- ##### `portals`^Optional ```typescript public readonly portals: string[]; ``` - *Type:* string[] portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false. readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. --- ##### `secretRef`^Optional ```typescript public readonly secretRef: LocalObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.LocalObjectReference secretRef is the CHAP Secret for iSCSI target and initiator authentication. --- ### JobProps Properties for `Job`. #### Initializer ```typescript import { JobProps } from 'cdk8s-plus-32' const jobProps: JobProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | boolean | Indicates whether a service account token should be automatically mounted. | | containers | ContainerProps[] | List of containers belonging to the pod. | | dns | PodDnsProps | DNS settings for the pod. | | dockerRegistryAuth | ISecret | A secret containing docker credentials for authenticating to a registry. | | enableServiceLinks | boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | HostAlias[] | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | boolean | Host network for the pod. | | initContainers | ContainerProps[] | List of initialization containers belonging to the pod. | | isolate | boolean | Isolates the pod. | | restartPolicy | RestartPolicy | Restart policy for all containers within the pod. | | securityContext | PodSecurityContextProps | SecurityContext holds pod-level security attributes and common container settings. | | serviceAccount | IServiceAccount | A service account provides an identity for processes that run in a Pod. | | shareProcessNamespace | boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | cdk8s.Duration | Grace period until the pod is terminated. | | volumes | Volume[] | List of volumes that can be mounted by containers belonging to the pod. | | podMetadata | cdk8s.ApiObjectMetadata | The pod metadata of this workload. | | select | boolean | Automatically allocates a pod label selector for this workload and add it to the pod metadata. | | spread | boolean | Automatically spread pods across hostname and zones. | | activeDeadline | cdk8s.Duration | Specifies the duration the job may be active before the system tries to terminate it. | | backoffLimit | number | Specifies the number of retries before marking this job failed. | | ttlAfterFinished | cdk8s.Duration | Limits the lifetime of a Job that has finished execution (either Complete or Failed). | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether a service account token should be automatically mounted. > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server) --- ##### `containers`^Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No containers. Note that a pod spec must include at least one container. List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. You can add additionnal containers using `podSpec.addContainer()` --- ##### `dns`^Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* PodDnsProps - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > [https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/) --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean - *Default:* true Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. > [https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) --- ##### `hostAliases`^Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No init containers. List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added ,removed or updated. > [https://kubernetes.io/docs/concepts/workloads/pods/init-containers/](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) --- ##### `isolate`^Optional ```typescript public readonly isolate: boolean; ``` - *Type:* boolean - *Default:* false Isolates the pod. This will prevent any ingress or egress connections to / from this pod. You can however allow explicit connections post instantiation by using the `.connections` property. --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy) --- ##### `securityContext`^Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount - *Default:* No service account. A service account provides an identity for processes that run in a Pod. When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default). > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) --- ##### `shareProcessNamespace`^Optional ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean - *Default:* false When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. > [https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/](https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/) --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] - *Default:* No volumes. List of volumes that can be mounted by containers belonging to the pod. You can also add volumes later using `podSpec.addVolume()` > [https://kubernetes.io/docs/concepts/storage/volumes](https://kubernetes.io/docs/concepts/storage/volumes) --- ##### `podMetadata`^Optional ```typescript public readonly podMetadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata The pod metadata of this workload. --- ##### `select`^Optional ```typescript public readonly select: boolean; ``` - *Type:* boolean - *Default:* true Automatically allocates a pod label selector for this workload and add it to the pod metadata. This ensures this workload manages pods created by its pod template. --- ##### `spread`^Optional ```typescript public readonly spread: boolean; ``` - *Type:* boolean - *Default:* false Automatically spread pods across hostname and zones. > [https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints) --- ##### `activeDeadline`^Optional ```typescript public readonly activeDeadline: Duration; ``` - *Type:* cdk8s.Duration - *Default:* If unset, then there is no deadline. Specifies the duration the job may be active before the system tries to terminate it. --- ##### `backoffLimit`^Optional ```typescript public readonly backoffLimit: number; ``` - *Type:* number - *Default:* If not set, system defaults to 6. Specifies the number of retries before marking this job failed. --- ##### `ttlAfterFinished`^Optional ```typescript public readonly ttlAfterFinished: Duration; ``` - *Type:* cdk8s.Duration - *Default:* If this field is unset, the Job won't be automatically deleted. Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the `TTLAfterFinished` feature. --- ### JobSpec JobSpec describes how the job execution will look like. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const jobSpec: k8s.JobSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | template | cdk8s-plus-32.k8s.PodTemplateSpec | Describes the pod that will be created when executing a job. | | activeDeadlineSeconds | number | Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; | | backoffLimit | number | Specifies the number of retries before marking this job failed. | | backoffLimitPerIndex | number | Specifies the limit for the number of retries within an index before marking this index as failed. | | completionMode | string | completionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. | | completions | number | Specifies the desired number of successfully finished pods the job should be run with. | | managedBy | string | ManagedBy field indicates the controller that manages a Job. | | manualSelector | boolean | manualSelector controls generation of pod labels and pod selectors. | | maxFailedIndexes | number | Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. | | parallelism | number | Specifies the maximum desired number of pods the job should run at any given time. | | podFailurePolicy | cdk8s-plus-32.k8s.PodFailurePolicy | Specifies the policy of handling failed pods. | | podReplacementPolicy | string | podReplacementPolicy specifies when to create replacement Pods. | | selector | cdk8s-plus-32.k8s.LabelSelector | A label query over pods that should match the pod count. | | successPolicy | cdk8s-plus-32.k8s.SuccessPolicy | successPolicy specifies the policy when the Job can be declared as succeeded. | | suspend | boolean | suspend specifies whether the Job controller should create Pods or not. | | ttlSecondsAfterFinished | number | ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). | --- ##### `template`^Required ```typescript public readonly template: PodTemplateSpec; ``` - *Type:* cdk8s-plus-32.k8s.PodTemplateSpec Describes the pod that will be created when executing a job. The only allowed template.spec.restartPolicy values are "Never" or "OnFailure". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ --- ##### `activeDeadlineSeconds`^Optional ```typescript public readonly activeDeadlineSeconds: number; ``` - *Type:* number Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again. --- ##### `backoffLimit`^Optional ```typescript public readonly backoffLimit: number; ``` - *Type:* number - *Default:* 6 Specifies the number of retries before marking this job failed. Defaults to 6 --- ##### `backoffLimitPerIndex`^Optional ```typescript public readonly backoffLimitPerIndex: number; ``` - *Type:* number Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job's completionMode=Indexed, and the Pod's restart policy is Never. The field is immutable. This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default). --- ##### `completionMode`^Optional ```typescript public readonly completionMode: string; ``` - *Type:* string completionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. `NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other. `Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`. More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job. --- ##### `completions`^Optional ```typescript public readonly completions: number; ``` - *Type:* number Specifies the desired number of successfully finished pods the job should be run with. Setting to null means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ --- ##### `managedBy`^Optional ```typescript public readonly managedBy: string; ``` - *Type:* string ManagedBy field indicates the controller that manages a Job. The k8s Job controller reconciles jobs which don't have this field at all or the field value is the reserved string `kubernetes.io/job-controller`, but skips reconciling Jobs with a custom value for this field. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first "/" must be a valid subdomain as defined by RFC 1123. All characters trailing the first "/" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. This field is immutable. This field is beta-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (enabled by default). --- ##### `manualSelector`^Optional ```typescript public readonly manualSelector: boolean; ``` - *Type:* boolean manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector --- ##### `maxFailedIndexes`^Optional ```typescript public readonly maxFailedIndexes: number; ``` - *Type:* number Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the `Complete` Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5. This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default). --- ##### `parallelism`^Optional ```typescript public readonly parallelism: number; ``` - *Type:* number Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ --- ##### `podFailurePolicy`^Optional ```typescript public readonly podFailurePolicy: PodFailurePolicy; ``` - *Type:* cdk8s-plus-32.k8s.PodFailurePolicy Specifies the policy of handling failed pods. In particular, it allows to specify the set of actions and conditions which need to be satisfied to take the associated action. If empty, the default behaviour applies - the counter of failed pods, represented by the jobs's .status.failed field, is incremented and it is checked against the backoffLimit. This field cannot be used in combination with restartPolicy=OnFailure. --- ##### `podReplacementPolicy`^Optional ```typescript public readonly podReplacementPolicy: string; ``` - *Type:* string podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods when they are terminating (has a metadata.deletionTimestamp) or failed. - Failed means to wait until a previously created Pod is fully terminated (has phase Failed or Succeeded) before creating a replacement Pod. When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an beta field. To use this, enable the JobPodReplacementPolicy feature toggle. This is on by default. --- ##### `selector`^Optional ```typescript public readonly selector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors --- ##### `successPolicy`^Optional ```typescript public readonly successPolicy: SuccessPolicy; ``` - *Type:* cdk8s-plus-32.k8s.SuccessPolicy successPolicy specifies the policy when the Job can be declared as succeeded. If empty, the default behavior applies - the Job is declared as succeeded only when the number of succeeded pods equals to the completions. When the field is specified, it must be immutable and works only for the Indexed Jobs. Once the Job meets the SuccessPolicy, the lingering pods are terminated. This field is beta-level. To use this field, you must enable the `JobSuccessPolicy` feature gate (enabled by default). --- ##### `suspend`^Optional ```typescript public readonly suspend: boolean; ``` - *Type:* boolean - *Default:* false. suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false. --- ##### `ttlSecondsAfterFinished`^Optional ```typescript public readonly ttlSecondsAfterFinished: number; ``` - *Type:* number ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. --- ### JobTemplateSpec JobTemplateSpec describes the data a Job should have when created from a template. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const jobTemplateSpec: k8s.JobTemplateSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata of the jobs created from this template. | | spec | cdk8s-plus-32.k8s.JobSpec | Specification of the desired behavior of the job. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: JobSpec; ``` - *Type:* cdk8s-plus-32.k8s.JobSpec Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### JsonPatchV1Alpha1 JSONPatch defines a JSON Patch. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const jsonPatchV1Alpha1: k8s.JsonPatchV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | expression will be evaluated by CEL to create a [JSON patch](https://jsonpatch.com/). ref: https://github.com/google/cel-spec. | --- ##### `expression`^Optional ```typescript public readonly expression: string; ``` - *Type:* string expression will be evaluated by CEL to create a [JSON patch](https://jsonpatch.com/). ref: https://github.com/google/cel-spec. expression must return an array of JSONPatch values. For example, this CEL expression returns a JSON patch to conditionally modify a value: [ JSONPatch{op: "test", path: "/spec/example", value: "Red"}, JSONPatch{op: "replace", path: "/spec/example", value: "Green"} ] To define an object for the patch value, use Object types. For example: [ JSONPatch{ op: "add", path: "/spec/selector", value: Object.spec.selector{matchLabels: {"environment": "test"}} } ] To use strings containing '/' and '~' as JSONPatch path keys, use "jsonpatch.escapeKey". For example: [ JSONPatch{ op: "add", path: "/metadata/labels/" + jsonpatch.escapeKey("example.com/environment"), value: "test" }, ] CEL expressions have access to the types needed to create JSON patches and objects: - 'JSONPatch' - CEL type of JSON Patch operations. JSONPatch has the fields 'op', 'from', 'path' and 'value'. See [JSON patch](https://jsonpatch.com/) for more details. The 'value' field may be set to any of: string, integer, array, map or object. If set, the 'path' and 'from' fields must be set to a [JSON pointer](https://datatracker.ietf.org/doc/html/rfc6901/) string, where the 'jsonpatch.escapeKey()' CEL function may be used to escape path keys containing '/' and '~'. - 'Object' - CEL type of the resource object. - 'Object.' - CEL type of object field (such as 'Object.spec') - 'Object.....` - CEL type of nested field (such as 'Object.spec.containers') CEL expressions have access to the contents of the API request, organized into CEL variables as well as some other useful variables: - 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value. For example, a variable named 'foo' can be accessed as 'variables.foo'. - 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz - 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the request resource. CEL expressions have access to [Kubernetes CEL function libraries](https://kubernetes.io/docs/reference/using-api/cel/#cel-options-language-features-and-libraries) as well as: - 'jsonpatch.escapeKey' - Performs JSONPatch key escaping. '~' and '/' are escaped as '~0' and `~1' respectively). Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Required. --- ### JsonSchemaProps JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const jsonSchemaProps: k8s.JsonSchemaProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | additionalItems | any | *No description.* | | additionalProperties | any | *No description.* | | allOf | cdk8s-plus-32.k8s.JsonSchemaProps[] | *No description.* | | anyOf | cdk8s-plus-32.k8s.JsonSchemaProps[] | *No description.* | | default | any | default is a default value for undefined object fields. | | definitions | {[ key: string ]: cdk8s-plus-32.k8s.JsonSchemaProps} | *No description.* | | dependencies | {[ key: string ]: any} | *No description.* | | description | string | *No description.* | | enum | any[] | *No description.* | | example | any | *No description.* | | exclusiveMaximum | boolean | *No description.* | | exclusiveMinimum | boolean | *No description.* | | externalDocs | cdk8s-plus-32.k8s.ExternalDocumentation | *No description.* | | format | string | format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:. | | id | string | *No description.* | | items | any | *No description.* | | maximum | number | *No description.* | | maxItems | number | *No description.* | | maxLength | number | *No description.* | | maxProperties | number | *No description.* | | minimum | number | *No description.* | | minItems | number | *No description.* | | minLength | number | *No description.* | | minProperties | number | *No description.* | | multipleOf | number | *No description.* | | not | cdk8s-plus-32.k8s.JsonSchemaProps | *No description.* | | nullable | boolean | *No description.* | | oneOf | cdk8s-plus-32.k8s.JsonSchemaProps[] | *No description.* | | pattern | string | *No description.* | | patternProperties | {[ key: string ]: cdk8s-plus-32.k8s.JsonSchemaProps} | *No description.* | | properties | {[ key: string ]: cdk8s-plus-32.k8s.JsonSchemaProps} | *No description.* | | ref | string | *No description.* | | required | string[] | *No description.* | | schema | string | *No description.* | | title | string | *No description.* | | type | string | *No description.* | | uniqueItems | boolean | *No description.* | | xKubernetesEmbeddedResource | boolean | x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). | | xKubernetesIntOrString | boolean | x-kubernetes-int-or-string specifies that this value is either an integer or a string. | | xKubernetesListMapKeys | string[] | x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. | | xKubernetesListType | string | x-kubernetes-list-type annotates an array to further describe its topology. | | xKubernetesMapType | string | x-kubernetes-map-type annotates an object to further describe its topology. | | xKubernetesPreserveUnknownFields | boolean | x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. | | xKubernetesValidations | cdk8s-plus-32.k8s.ValidationRule[] | x-kubernetes-validations describes a list of validation rules written in the CEL expression language. | --- ##### `additionalItems`^Optional ```typescript public readonly additionalItems: any; ``` - *Type:* any --- ##### `additionalProperties`^Optional ```typescript public readonly additionalProperties: any; ``` - *Type:* any --- ##### `allOf`^Optional ```typescript public readonly allOf: JsonSchemaProps[]; ``` - *Type:* cdk8s-plus-32.k8s.JsonSchemaProps[] --- ##### `anyOf`^Optional ```typescript public readonly anyOf: JsonSchemaProps[]; ``` - *Type:* cdk8s-plus-32.k8s.JsonSchemaProps[] --- ##### `default`^Optional ```typescript public readonly default: any; ``` - *Type:* any default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false. --- ##### `definitions`^Optional ```typescript public readonly definitions: {[ key: string ]: JsonSchemaProps}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.JsonSchemaProps} --- ##### `dependencies`^Optional ```typescript public readonly dependencies: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `enum`^Optional ```typescript public readonly enum: any[]; ``` - *Type:* any[] --- ##### `example`^Optional ```typescript public readonly example: any; ``` - *Type:* any --- ##### `exclusiveMaximum`^Optional ```typescript public readonly exclusiveMaximum: boolean; ``` - *Type:* boolean --- ##### `exclusiveMinimum`^Optional ```typescript public readonly exclusiveMinimum: boolean; ``` - *Type:* boolean --- ##### `externalDocs`^Optional ```typescript public readonly externalDocs: ExternalDocumentation; ``` - *Type:* cdk8s-plus-32.k8s.ExternalDocumentation --- ##### `format`^Optional ```typescript public readonly format: string; ``` - *Type:* string format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:. bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string --- ##### `items`^Optional ```typescript public readonly items: any; ``` - *Type:* any --- ##### `maximum`^Optional ```typescript public readonly maximum: number; ``` - *Type:* number --- ##### `maxItems`^Optional ```typescript public readonly maxItems: number; ``` - *Type:* number --- ##### `maxLength`^Optional ```typescript public readonly maxLength: number; ``` - *Type:* number --- ##### `maxProperties`^Optional ```typescript public readonly maxProperties: number; ``` - *Type:* number --- ##### `minimum`^Optional ```typescript public readonly minimum: number; ``` - *Type:* number --- ##### `minItems`^Optional ```typescript public readonly minItems: number; ``` - *Type:* number --- ##### `minLength`^Optional ```typescript public readonly minLength: number; ``` - *Type:* number --- ##### `minProperties`^Optional ```typescript public readonly minProperties: number; ``` - *Type:* number --- ##### `multipleOf`^Optional ```typescript public readonly multipleOf: number; ``` - *Type:* number --- ##### `not`^Optional ```typescript public readonly not: JsonSchemaProps; ``` - *Type:* cdk8s-plus-32.k8s.JsonSchemaProps --- ##### `nullable`^Optional ```typescript public readonly nullable: boolean; ``` - *Type:* boolean --- ##### `oneOf`^Optional ```typescript public readonly oneOf: JsonSchemaProps[]; ``` - *Type:* cdk8s-plus-32.k8s.JsonSchemaProps[] --- ##### `pattern`^Optional ```typescript public readonly pattern: string; ``` - *Type:* string --- ##### `patternProperties`^Optional ```typescript public readonly patternProperties: {[ key: string ]: JsonSchemaProps}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.JsonSchemaProps} --- ##### `properties`^Optional ```typescript public readonly properties: {[ key: string ]: JsonSchemaProps}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.JsonSchemaProps} --- ##### `ref`^Optional ```typescript public readonly ref: string; ``` - *Type:* string --- ##### `required`^Optional ```typescript public readonly required: string[]; ``` - *Type:* string[] --- ##### `schema`^Optional ```typescript public readonly schema: string; ``` - *Type:* string --- ##### `title`^Optional ```typescript public readonly title: string; ``` - *Type:* string --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string --- ##### `uniqueItems`^Optional ```typescript public readonly uniqueItems: boolean; ``` - *Type:* boolean --- ##### `xKubernetesEmbeddedResource`^Optional ```typescript public readonly xKubernetesEmbeddedResource: boolean; ``` - *Type:* boolean x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). --- ##### `xKubernetesIntOrString`^Optional ```typescript public readonly xKubernetesIntOrString: boolean; ``` - *Type:* boolean x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: 1) anyOf: - type: integer - type: string 2) allOf: - anyOf: - type: integer - type: string - ... zero or more --- ##### `xKubernetesListMapKeys`^Optional ```typescript public readonly xKubernetesListMapKeys: string[]; ``` - *Type:* string[] x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). The properties specified must either be required or have a default value, to ensure those properties are present for all list items. --- ##### `xKubernetesListType`^Optional ```typescript public readonly xKubernetesListType: string; ``` - *Type:* string - *Default:* atomic for arrays. x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: 1) `atomic`: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, ...). 2) `set`: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-type `atomic` or an array with x-kubernetes-list-type `atomic`. 3) `map`: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays. --- ##### `xKubernetesMapType`^Optional ```typescript public readonly xKubernetesMapType: string; ``` - *Type:* string x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: 1) `granular`: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps. 2) `atomic`: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated. --- ##### `xKubernetesPreserveUnknownFields`^Optional ```typescript public readonly xKubernetesPreserveUnknownFields: boolean; ``` - *Type:* boolean x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden. --- ##### `xKubernetesValidations`^Optional ```typescript public readonly xKubernetesValidations: ValidationRule[]; ``` - *Type:* cdk8s-plus-32.k8s.ValidationRule[] x-kubernetes-validations describes a list of validation rules written in the CEL expression language. --- ### KeyToPath Maps a string key to a path within a volume. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const keyToPath: k8s.KeyToPath = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | key is the key to project. | | path | string | path is the relative path of the file to map the key to. | | mode | number | mode is Optional: mode bits used to set permissions on this file. | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string key is the key to project. --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. --- ##### `mode`^Optional ```typescript public readonly mode: number; ``` - *Type:* number mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. --- ### KubeApiServiceListProps APIServiceList is a list of APIService objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeApiServiceListProps: k8s.KubeApiServiceListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeApiServiceProps[] | Items is the list of APIService. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeApiServiceProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeApiServiceProps[] Items is the list of APIService. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeApiServiceProps APIService represents a server for a particular GroupVersion. Name must be "version.group". #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeApiServiceProps: k8s.KubeApiServiceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.ApiServiceSpec | Spec contains information for locating and communicating with a server. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: ApiServiceSpec; ``` - *Type:* cdk8s-plus-32.k8s.ApiServiceSpec Spec contains information for locating and communicating with a server. --- ### KubeBindingProps Binding ties one object to another; for example, a pod is bound to a node by a scheduler. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeBindingProps: k8s.KubeBindingProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | target | cdk8s-plus-32.k8s.ObjectReference | The target object that you want to bind to the standard object. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `target`^Required ```typescript public readonly target: ObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.ObjectReference The target object that you want to bind to the standard object. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeCertificateSigningRequestListProps CertificateSigningRequestList is a collection of CertificateSigningRequest objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeCertificateSigningRequestListProps: k8s.KubeCertificateSigningRequestListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeCertificateSigningRequestProps[] | items is a collection of CertificateSigningRequest objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | *No description.* | --- ##### `items`^Required ```typescript public readonly items: KubeCertificateSigningRequestProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeCertificateSigningRequestProps[] items is a collection of CertificateSigningRequest objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta --- ### KubeCertificateSigningRequestProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeCertificateSigningRequestProps: k8s.KubeCertificateSigningRequestProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.CertificateSigningRequestSpec | spec contains the certificate request, and is immutable after creation. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | *No description.* | --- ##### `spec`^Required ```typescript public readonly spec: CertificateSigningRequestSpec; ``` - *Type:* cdk8s-plus-32.k8s.CertificateSigningRequestSpec spec contains the certificate request, and is immutable after creation. Only the request, signerName, expirationSeconds, and usages fields can be set on creation. Other fields are derived by Kubernetes and cannot be modified by users. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta --- ### KubeClusterRoleBindingListProps ClusterRoleBindingList is a collection of ClusterRoleBindings. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeClusterRoleBindingListProps: k8s.KubeClusterRoleBindingListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeClusterRoleBindingProps[] | Items is a list of ClusterRoleBindings. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard object's metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeClusterRoleBindingProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeClusterRoleBindingProps[] Items is a list of ClusterRoleBindings. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard object's metadata. --- ### KubeClusterRoleBindingProps ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeClusterRoleBindingProps: k8s.KubeClusterRoleBindingProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | roleRef | cdk8s-plus-32.k8s.RoleRef | RoleRef can only reference a ClusterRole in the global namespace. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | subjects | cdk8s-plus-32.k8s.Subject[] | Subjects holds references to the objects the role applies to. | --- ##### `roleRef`^Required ```typescript public readonly roleRef: RoleRef; ``` - *Type:* cdk8s-plus-32.k8s.RoleRef RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. This field is immutable. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. --- ##### `subjects`^Optional ```typescript public readonly subjects: Subject[]; ``` - *Type:* cdk8s-plus-32.k8s.Subject[] Subjects holds references to the objects the role applies to. --- ### KubeClusterRoleListProps ClusterRoleList is a collection of ClusterRoles. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeClusterRoleListProps: k8s.KubeClusterRoleListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeClusterRoleProps[] | Items is a list of ClusterRoles. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard object's metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeClusterRoleProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeClusterRoleProps[] Items is a list of ClusterRoles. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard object's metadata. --- ### KubeClusterRoleProps ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeClusterRoleProps: k8s.KubeClusterRoleProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | aggregationRule | cdk8s-plus-32.k8s.AggregationRule | AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | rules | cdk8s-plus-32.k8s.PolicyRule[] | Rules holds all the PolicyRules for this ClusterRole. | --- ##### `aggregationRule`^Optional ```typescript public readonly aggregationRule: AggregationRule; ``` - *Type:* cdk8s-plus-32.k8s.AggregationRule AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. --- ##### `rules`^Optional ```typescript public readonly rules: PolicyRule[]; ``` - *Type:* cdk8s-plus-32.k8s.PolicyRule[] Rules holds all the PolicyRules for this ClusterRole. --- ### KubeClusterTrustBundleListV1Alpha1Props ClusterTrustBundleList is a collection of ClusterTrustBundle objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeClusterTrustBundleListV1Alpha1Props: k8s.KubeClusterTrustBundleListV1Alpha1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeClusterTrustBundleV1Alpha1Props[] | items is a collection of ClusterTrustBundle objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | metadata contains the list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeClusterTrustBundleV1Alpha1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeClusterTrustBundleV1Alpha1Props[] items is a collection of ClusterTrustBundle objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta metadata contains the list metadata. --- ### KubeClusterTrustBundleV1Alpha1Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeClusterTrustBundleV1Alpha1Props: k8s.KubeClusterTrustBundleV1Alpha1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.ClusterTrustBundleSpecV1Alpha1 | spec contains the signer (if any) and trust anchors. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | metadata contains the object metadata. | --- ##### `spec`^Required ```typescript public readonly spec: ClusterTrustBundleSpecV1Alpha1; ``` - *Type:* cdk8s-plus-32.k8s.ClusterTrustBundleSpecV1Alpha1 spec contains the signer (if any) and trust anchors. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta metadata contains the object metadata. --- ### KubeComponentStatusListProps Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+ #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeComponentStatusListProps: k8s.KubeComponentStatusListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeComponentStatusProps[] | List of ComponentStatus objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeComponentStatusProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeComponentStatusProps[] List of ComponentStatus objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeComponentStatusProps ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+ #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeComponentStatusProps: k8s.KubeComponentStatusProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | conditions | cdk8s-plus-32.k8s.ComponentCondition[] | List of component conditions observed. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `conditions`^Optional ```typescript public readonly conditions: ComponentCondition[]; ``` - *Type:* cdk8s-plus-32.k8s.ComponentCondition[] List of component conditions observed. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeConfigMapListProps ConfigMapList is a resource containing a list of ConfigMap objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeConfigMapListProps: k8s.KubeConfigMapListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeConfigMapProps[] | Items is the list of ConfigMaps. | | metadata | cdk8s-plus-32.k8s.ListMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeConfigMapProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeConfigMapProps[] Items is the list of ConfigMaps. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeConfigMapProps ConfigMap holds configuration data for pods to consume. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeConfigMapProps: k8s.KubeConfigMapProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | binaryData | {[ key: string ]: string} | BinaryData contains the binary data. | | data | {[ key: string ]: string} | Data contains the configuration data. | | immutable | boolean | Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `binaryData`^Optional ```typescript public readonly binaryData: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet. --- ##### `data`^Optional ```typescript public readonly data: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process. --- ##### `immutable`^Optional ```typescript public readonly immutable: boolean; ``` - *Type:* boolean Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeControllerRevisionListProps ControllerRevisionList is a resource containing a list of ControllerRevision objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeControllerRevisionListProps: k8s.KubeControllerRevisionListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeControllerRevisionProps[] | Items is the list of ControllerRevisions. | | metadata | cdk8s-plus-32.k8s.ListMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeControllerRevisionProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeControllerRevisionProps[] Items is the list of ControllerRevisions. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeControllerRevisionProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeControllerRevisionProps: k8s.KubeControllerRevisionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | revision | number | Revision indicates the revision of the state represented by Data. | | data | any | Data is the serialized representation of the state. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `revision`^Required ```typescript public readonly revision: number; ``` - *Type:* number Revision indicates the revision of the state represented by Data. --- ##### `data`^Optional ```typescript public readonly data: any; ``` - *Type:* any Data is the serialized representation of the state. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeCronJobListProps CronJobList is a collection of cron jobs. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeCronJobListProps: k8s.KubeCronJobListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeCronJobProps[] | items is the list of CronJobs. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeCronJobProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeCronJobProps[] items is the list of CronJobs. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeCronJobProps CronJob represents the configuration of a single cron job. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeCronJobProps: k8s.KubeCronJobProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.CronJobSpec | Specification of the desired behavior of a cron job, including the schedule. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: CronJobSpec; ``` - *Type:* cdk8s-plus-32.k8s.CronJobSpec Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeCsiDriverListProps CSIDriverList is a collection of CSIDriver objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeCsiDriverListProps: k8s.KubeCsiDriverListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeCsiDriverProps[] | items is the list of CSIDriver. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeCsiDriverProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeCsiDriverProps[] items is the list of CSIDriver. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeCsiDriverProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeCsiDriverProps: k8s.KubeCsiDriverProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.CsiDriverSpec | spec represents the specification of the CSI Driver. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata. | --- ##### `spec`^Required ```typescript public readonly spec: CsiDriverSpec; ``` - *Type:* cdk8s-plus-32.k8s.CsiDriverSpec spec represents the specification of the CSI Driver. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeCsiNodeListProps CSINodeList is a collection of CSINode objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeCsiNodeListProps: k8s.KubeCsiNodeListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeCsiNodeProps[] | items is the list of CSINode. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeCsiNodeProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeCsiNodeProps[] items is the list of CSINode. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeCsiNodeProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeCsiNodeProps: k8s.KubeCsiNodeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.CsiNodeSpec | spec is the specification of CSINode. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `spec`^Required ```typescript public readonly spec: CsiNodeSpec; ``` - *Type:* cdk8s-plus-32.k8s.CsiNodeSpec spec is the specification of CSINode. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. metadata.name must be the Kubernetes node name. --- ### KubeCsiStorageCapacityListProps CSIStorageCapacityList is a collection of CSIStorageCapacity objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeCsiStorageCapacityListProps: k8s.KubeCsiStorageCapacityListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeCsiStorageCapacityProps[] | items is the list of CSIStorageCapacity objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeCsiStorageCapacityProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeCsiStorageCapacityProps[] items is the list of CSIStorageCapacity objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeCsiStorageCapacityProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeCsiStorageCapacityProps: k8s.KubeCsiStorageCapacityProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | storageClassName | string | storageClassName represents the name of the StorageClass that the reported capacity applies to. | | capacity | cdk8s-plus-32.k8s.Quantity | capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. | | maximumVolumeSize | cdk8s-plus-32.k8s.Quantity | maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | nodeTopology | cdk8s-plus-32.k8s.LabelSelector | nodeTopology defines which nodes have access to the storage for which capacity was reported. | --- ##### `storageClassName`^Required ```typescript public readonly storageClassName: string; ``` - *Type:* string storageClassName represents the name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable. --- ##### `capacity`^Optional ```typescript public readonly capacity: Quantity; ``` - *Type:* cdk8s-plus-32.k8s.Quantity capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable. --- ##### `maximumVolumeSize`^Optional ```typescript public readonly maximumVolumeSize: Quantity; ``` - *Type:* cdk8s-plus-32.k8s.Quantity maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. The name has no particular meaning. It must be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-, a generated name, or a reverse-domain name which ends with the unique CSI driver name. Objects are namespaced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `nodeTopology`^Optional ```typescript public readonly nodeTopology: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector nodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable. --- ### KubeCustomResourceDefinitionListProps CustomResourceDefinitionList is a list of CustomResourceDefinition objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeCustomResourceDefinitionListProps: k8s.KubeCustomResourceDefinitionListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeCustomResourceDefinitionProps[] | items list individual CustomResourceDefinition objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeCustomResourceDefinitionProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeCustomResourceDefinitionProps[] items list individual CustomResourceDefinition objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeCustomResourceDefinitionProps CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeCustomResourceDefinitionProps: k8s.KubeCustomResourceDefinitionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.CustomResourceDefinitionSpec | spec describes how the user wants the resources to appear. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `spec`^Required ```typescript public readonly spec: CustomResourceDefinitionSpec; ``` - *Type:* cdk8s-plus-32.k8s.CustomResourceDefinitionSpec spec describes how the user wants the resources to appear. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeDaemonSetListProps DaemonSetList is a collection of daemon sets. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeDaemonSetListProps: k8s.KubeDaemonSetListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeDaemonSetProps[] | A list of daemon sets. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeDaemonSetProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeDaemonSetProps[] A list of daemon sets. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeDaemonSetProps DaemonSet represents the configuration of a daemon set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeDaemonSetProps: k8s.KubeDaemonSetProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.DaemonSetSpec | The desired behavior of this daemon set. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: DaemonSetSpec; ``` - *Type:* cdk8s-plus-32.k8s.DaemonSetSpec The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeDeploymentListProps DeploymentList is a list of Deployments. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeDeploymentListProps: k8s.KubeDeploymentListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeDeploymentProps[] | Items is the list of Deployments. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeDeploymentProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeDeploymentProps[] Items is the list of Deployments. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. --- ### KubeDeploymentProps Deployment enables declarative updates for Pods and ReplicaSets. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeDeploymentProps: k8s.KubeDeploymentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.DeploymentSpec | Specification of the desired behavior of the Deployment. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: DeploymentSpec; ``` - *Type:* cdk8s-plus-32.k8s.DeploymentSpec Specification of the desired behavior of the Deployment. --- ### KubeDeviceClassListV1Alpha3Props DeviceClassList is a collection of classes. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeDeviceClassListV1Alpha3Props: k8s.KubeDeviceClassListV1Alpha3Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeDeviceClassV1Alpha3Props[] | Items is the list of resource classes. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeDeviceClassV1Alpha3Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeDeviceClassV1Alpha3Props[] Items is the list of resource classes. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. --- ### KubeDeviceClassListV1Beta1Props DeviceClassList is a collection of classes. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeDeviceClassListV1Beta1Props: k8s.KubeDeviceClassListV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeDeviceClassV1Beta1Props[] | Items is the list of resource classes. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeDeviceClassV1Beta1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeDeviceClassV1Beta1Props[] Items is the list of resource classes. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. --- ### KubeDeviceClassV1Alpha3Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeDeviceClassV1Alpha3Props: k8s.KubeDeviceClassV1Alpha3Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.DeviceClassSpecV1Alpha3 | Spec defines what can be allocated and how to configure it. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata. | --- ##### `spec`^Required ```typescript public readonly spec: DeviceClassSpecV1Alpha3; ``` - *Type:* cdk8s-plus-32.k8s.DeviceClassSpecV1Alpha3 Spec defines what can be allocated and how to configure it. This is mutable. Consumers have to be prepared for classes changing at any time, either because they get updated or replaced. Claim allocations are done once based on whatever was set in classes at the time of allocation. Changing the spec automatically increments the metadata.generation number. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata. --- ### KubeDeviceClassV1Beta1Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeDeviceClassV1Beta1Props: k8s.KubeDeviceClassV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.DeviceClassSpecV1Beta1 | Spec defines what can be allocated and how to configure it. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata. | --- ##### `spec`^Required ```typescript public readonly spec: DeviceClassSpecV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.DeviceClassSpecV1Beta1 Spec defines what can be allocated and how to configure it. This is mutable. Consumers have to be prepared for classes changing at any time, either because they get updated or replaced. Claim allocations are done once based on whatever was set in classes at the time of allocation. Changing the spec automatically increments the metadata.generation number. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata. --- ### KubeEndpointSliceListProps EndpointSliceList represents a list of endpoint slices. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeEndpointSliceListProps: k8s.KubeEndpointSliceListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeEndpointSliceProps[] | items is the list of endpoint slices. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeEndpointSliceProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeEndpointSliceProps[] items is the list of endpoint slices. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. --- ### KubeEndpointSliceProps EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeEndpointSliceProps: k8s.KubeEndpointSliceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | addressType | string | addressType specifies the type of address carried by this EndpointSlice. | | endpoints | cdk8s-plus-32.k8s.Endpoint[] | endpoints is a list of unique endpoints in this slice. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | ports | cdk8s-plus-32.k8s.EndpointPort[] | ports specifies the list of network ports exposed by each endpoint in this slice. | --- ##### `addressType`^Required ```typescript public readonly addressType: string; ``` - *Type:* string addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name. --- ##### `endpoints`^Required ```typescript public readonly endpoints: Endpoint[]; ``` - *Type:* cdk8s-plus-32.k8s.Endpoint[] endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. --- ##### `ports`^Optional ```typescript public readonly ports: EndpointPort[]; ``` - *Type:* cdk8s-plus-32.k8s.EndpointPort[] ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports. --- ### KubeEndpointsListProps EndpointsList is a list of endpoints. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeEndpointsListProps: k8s.KubeEndpointsListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeEndpointsProps[] | List of endpoints. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeEndpointsProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeEndpointsProps[] List of endpoints. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeEndpointsProps 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}] }, ] #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeEndpointsProps: k8s.KubeEndpointsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | subsets | cdk8s-plus-32.k8s.EndpointSubset[] | The set of all endpoints is the union of all subsets. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `subsets`^Optional ```typescript public readonly subsets: EndpointSubset[]; ``` - *Type:* cdk8s-plus-32.k8s.EndpointSubset[] The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. --- ### KubeEventListProps EventList is a list of Event objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeEventListProps: k8s.KubeEventListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeEventProps[] | items is a list of schema objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeEventProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeEventProps[] items is a list of schema objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeEventProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeEventProps: k8s.KubeEventProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | eventTime | Date | eventTime is the time when this Event was first observed. | | action | string | action is what action was taken/failed regarding to the regarding object. | | deprecatedCount | number | deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. | | deprecatedFirstTimestamp | Date | deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | | deprecatedLastTimestamp | Date | deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | | deprecatedSource | cdk8s-plus-32.k8s.EventSource | deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | note | string | note is a human-readable description of the status of this operation. | | reason | string | reason is why the action was taken. | | regarding | cdk8s-plus-32.k8s.ObjectReference | regarding contains the object this Event is about. | | related | cdk8s-plus-32.k8s.ObjectReference | related is the optional secondary object for more complex actions. | | reportingController | string | reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events. | | reportingInstance | string | reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters. | | series | cdk8s-plus-32.k8s.EventSeries | series is data about the Event series this event represents or nil if it's a singleton Event. | | type | string | type is the type of this event (Normal, Warning), new types could be added in the future. | --- ##### `eventTime`^Required ```typescript public readonly eventTime: Date; ``` - *Type:* Date eventTime is the time when this Event was first observed. It is required. --- ##### `action`^Optional ```typescript public readonly action: string; ``` - *Type:* string action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters. --- ##### `deprecatedCount`^Optional ```typescript public readonly deprecatedCount: number; ``` - *Type:* number deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. --- ##### `deprecatedFirstTimestamp`^Optional ```typescript public readonly deprecatedFirstTimestamp: Date; ``` - *Type:* Date deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. --- ##### `deprecatedLastTimestamp`^Optional ```typescript public readonly deprecatedLastTimestamp: Date; ``` - *Type:* Date deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. --- ##### `deprecatedSource`^Optional ```typescript public readonly deprecatedSource: EventSource; ``` - *Type:* cdk8s-plus-32.k8s.EventSource deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `note`^Optional ```typescript public readonly note: string; ``` - *Type:* string note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB. --- ##### `reason`^Optional ```typescript public readonly reason: string; ``` - *Type:* string reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters. --- ##### `regarding`^Optional ```typescript public readonly regarding: ObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.ObjectReference regarding contains the object this Event is about. In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object. --- ##### `related`^Optional ```typescript public readonly related: ObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.ObjectReference related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object. --- ##### `reportingController`^Optional ```typescript public readonly reportingController: string; ``` - *Type:* string reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events. --- ##### `reportingInstance`^Optional ```typescript public readonly reportingInstance: string; ``` - *Type:* string reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters. --- ##### `series`^Optional ```typescript public readonly series: EventSeries; ``` - *Type:* cdk8s-plus-32.k8s.EventSeries series is data about the Event series this event represents or nil if it's a singleton Event. --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events. --- ### KubeEvictionProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeEvictionProps: k8s.KubeEvictionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | deleteOptions | cdk8s-plus-32.k8s.DeleteOptions | DeleteOptions may be provided. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | ObjectMeta describes the pod that is being evicted. | --- ##### `deleteOptions`^Optional ```typescript public readonly deleteOptions: DeleteOptions; ``` - *Type:* cdk8s-plus-32.k8s.DeleteOptions DeleteOptions may be provided. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta ObjectMeta describes the pod that is being evicted. --- ### KubeFlowSchemaListProps FlowSchemaList is a list of FlowSchema objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeFlowSchemaListProps: k8s.KubeFlowSchemaListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeFlowSchemaProps[] | `items` is a list of FlowSchemas. | | metadata | cdk8s-plus-32.k8s.ListMeta | `metadata` is the standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeFlowSchemaProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeFlowSchemaProps[] `items` is a list of FlowSchemas. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeFlowSchemaProps 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". #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeFlowSchemaProps: k8s.KubeFlowSchemaProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | `metadata` is the standard object's metadata. | | spec | cdk8s-plus-32.k8s.FlowSchemaSpec | `spec` is the specification of the desired behavior of a FlowSchema. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: FlowSchemaSpec; ``` - *Type:* cdk8s-plus-32.k8s.FlowSchemaSpec `spec` is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeHorizontalPodAutoscalerListProps list of horizontal pod autoscaler objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeHorizontalPodAutoscalerListProps: k8s.KubeHorizontalPodAutoscalerListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeHorizontalPodAutoscalerProps[] | items is the list of horizontal pod autoscaler objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeHorizontalPodAutoscalerProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeHorizontalPodAutoscalerProps[] items is the list of horizontal pod autoscaler objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. --- ### KubeHorizontalPodAutoscalerListV2Props HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeHorizontalPodAutoscalerListV2Props: k8s.KubeHorizontalPodAutoscalerListV2Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeHorizontalPodAutoscalerV2Props[] | items is the list of horizontal pod autoscaler objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | metadata is the standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeHorizontalPodAutoscalerV2Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeHorizontalPodAutoscalerV2Props[] items is the list of horizontal pod autoscaler objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta metadata is the standard list metadata. --- ### KubeHorizontalPodAutoscalerProps configuration of a horizontal pod autoscaler. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeHorizontalPodAutoscalerProps: k8s.KubeHorizontalPodAutoscalerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata. | | spec | cdk8s-plus-32.k8s.HorizontalPodAutoscalerSpec | spec defines the behaviour of autoscaler. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: HorizontalPodAutoscalerSpec; ``` - *Type:* cdk8s-plus-32.k8s.HorizontalPodAutoscalerSpec spec defines the behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. --- ### KubeHorizontalPodAutoscalerV2Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeHorizontalPodAutoscalerV2Props: k8s.KubeHorizontalPodAutoscalerV2Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | metadata is the standard object metadata. | | spec | cdk8s-plus-32.k8s.HorizontalPodAutoscalerSpecV2 | spec is the specification for the behaviour of the autoscaler. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: HorizontalPodAutoscalerSpecV2; ``` - *Type:* cdk8s-plus-32.k8s.HorizontalPodAutoscalerSpecV2 spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. --- ### KubeIngressClassListProps IngressClassList is a collection of IngressClasses. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeIngressClassListProps: k8s.KubeIngressClassListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeIngressClassProps[] | items is the list of IngressClasses. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeIngressClassProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeIngressClassProps[] items is the list of IngressClasses. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. --- ### KubeIngressClassProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeIngressClassProps: k8s.KubeIngressClassProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.IngressClassSpec | spec is the desired state of the IngressClass. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: IngressClassSpec; ``` - *Type:* cdk8s-plus-32.k8s.IngressClassSpec spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeIngressListProps IngressList is a collection of Ingress. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeIngressListProps: k8s.KubeIngressListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeIngressProps[] | items is the list of Ingress. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard object's metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeIngressProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeIngressProps[] items is the list of Ingress. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeIngressProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeIngressProps: k8s.KubeIngressProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.IngressSpec | spec is the desired state of the Ingress. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: IngressSpec; ``` - *Type:* cdk8s-plus-32.k8s.IngressSpec spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeIpAddressListV1Beta1Props IPAddressList contains a list of IPAddress. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeIpAddressListV1Beta1Props: k8s.KubeIpAddressListV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeIpAddressV1Beta1Props[] | items is the list of IPAddresses. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard object's metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeIpAddressV1Beta1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeIpAddressV1Beta1Props[] items is the list of IPAddresses. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeIpAddressV1Beta1Props 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 #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeIpAddressV1Beta1Props: k8s.KubeIpAddressV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.IpAddressSpecV1Beta1 | spec is the desired state of the IPAddress. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: IpAddressSpecV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.IpAddressSpecV1Beta1 spec is the desired state of the IPAddress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeJobListProps JobList is a collection of jobs. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeJobListProps: k8s.KubeJobListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeJobProps[] | items is the list of Jobs. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeJobProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeJobProps[] items is the list of Jobs. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeJobProps Job represents the configuration of a single job. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeJobProps: k8s.KubeJobProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.JobSpec | Specification of the desired behavior of a job. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: JobSpec; ``` - *Type:* cdk8s-plus-32.k8s.JobSpec Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeLeaseCandidateListV1Alpha2Props LeaseCandidateList is a list of Lease objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeLeaseCandidateListV1Alpha2Props: k8s.KubeLeaseCandidateListV1Alpha2Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeLeaseCandidateV1Alpha2Props[] | items is a list of schema objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeLeaseCandidateV1Alpha2Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeLeaseCandidateV1Alpha2Props[] items is a list of schema objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeLeaseCandidateV1Alpha2Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeLeaseCandidateV1Alpha2Props: k8s.KubeLeaseCandidateV1Alpha2Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | | spec | cdk8s-plus-32.k8s.LeaseCandidateSpecV1Alpha2 | spec contains the specification of the Lease. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional ```typescript public readonly spec: LeaseCandidateSpecV1Alpha2; ``` - *Type:* cdk8s-plus-32.k8s.LeaseCandidateSpecV1Alpha2 spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeLeaseListProps LeaseList is a list of Lease objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeLeaseListProps: k8s.KubeLeaseListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeLeaseProps[] | items is a list of schema objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeLeaseProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeLeaseProps[] items is a list of schema objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeLeaseProps Lease defines a lease concept. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeLeaseProps: k8s.KubeLeaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | | spec | cdk8s-plus-32.k8s.LeaseSpec | spec contains the specification of the Lease. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional ```typescript public readonly spec: LeaseSpec; ``` - *Type:* cdk8s-plus-32.k8s.LeaseSpec spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeLimitRangeListProps LimitRangeList is a list of LimitRange items. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeLimitRangeListProps: k8s.KubeLimitRangeListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeLimitRangeProps[] | Items is a list of LimitRange objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeLimitRangeProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeLimitRangeProps[] Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeLimitRangeProps LimitRange sets resource usage limits for each kind of resource in a Namespace. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeLimitRangeProps: k8s.KubeLimitRangeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.LimitRangeSpec | Spec defines the limits enforced. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: LimitRangeSpec; ``` - *Type:* cdk8s-plus-32.k8s.LimitRangeSpec Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeLocalSubjectAccessReviewProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeLocalSubjectAccessReviewProps: k8s.KubeLocalSubjectAccessReviewProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.SubjectAccessReviewSpec | Spec holds information about the request being evaluated. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard list metadata. | --- ##### `spec`^Required ```typescript public readonly spec: SubjectAccessReviewSpec; ``` - *Type:* cdk8s-plus-32.k8s.SubjectAccessReviewSpec Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeMutatingAdmissionPolicyBindingListV1Alpha1Props MutatingAdmissionPolicyBindingList is a list of MutatingAdmissionPolicyBinding. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeMutatingAdmissionPolicyBindingListV1Alpha1Props: k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1Props[] | List of PolicyBinding. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeMutatingAdmissionPolicyBindingV1Alpha1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1Props[] List of PolicyBinding. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeMutatingAdmissionPolicyBindingV1Alpha1Props 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](https://kubernetes.io/docs/reference/using-api/cel/#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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeMutatingAdmissionPolicyBindingV1Alpha1Props: k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata; | | spec | cdk8s-plus-32.k8s.MutatingAdmissionPolicyBindingSpecV1Alpha1 | Specification of the desired behavior of the MutatingAdmissionPolicyBinding. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional ```typescript public readonly spec: MutatingAdmissionPolicyBindingSpecV1Alpha1; ``` - *Type:* cdk8s-plus-32.k8s.MutatingAdmissionPolicyBindingSpecV1Alpha1 Specification of the desired behavior of the MutatingAdmissionPolicyBinding. --- ### KubeMutatingAdmissionPolicyListV1Alpha1Props MutatingAdmissionPolicyList is a list of MutatingAdmissionPolicy. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeMutatingAdmissionPolicyListV1Alpha1Props: k8s.KubeMutatingAdmissionPolicyListV1Alpha1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeMutatingAdmissionPolicyV1Alpha1Props[] | List of ValidatingAdmissionPolicy. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeMutatingAdmissionPolicyV1Alpha1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeMutatingAdmissionPolicyV1Alpha1Props[] List of ValidatingAdmissionPolicy. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeMutatingAdmissionPolicyV1Alpha1Props MutatingAdmissionPolicy describes the definition of an admission mutation policy that mutates the object coming into admission chain. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeMutatingAdmissionPolicyV1Alpha1Props: k8s.KubeMutatingAdmissionPolicyV1Alpha1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata; | | spec | cdk8s-plus-32.k8s.MutatingAdmissionPolicySpecV1Alpha1 | Specification of the desired behavior of the MutatingAdmissionPolicy. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional ```typescript public readonly spec: MutatingAdmissionPolicySpecV1Alpha1; ``` - *Type:* cdk8s-plus-32.k8s.MutatingAdmissionPolicySpecV1Alpha1 Specification of the desired behavior of the MutatingAdmissionPolicy. --- ### KubeMutatingWebhookConfigurationListProps MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeMutatingWebhookConfigurationListProps: k8s.KubeMutatingWebhookConfigurationListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeMutatingWebhookConfigurationProps[] | List of MutatingWebhookConfiguration. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeMutatingWebhookConfigurationProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeMutatingWebhookConfigurationProps[] List of MutatingWebhookConfiguration. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeMutatingWebhookConfigurationProps MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeMutatingWebhookConfigurationProps: k8s.KubeMutatingWebhookConfigurationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata; | | webhooks | cdk8s-plus-32.k8s.MutatingWebhook[] | Webhooks is a list of webhooks and the affected resources and operations. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `webhooks`^Optional ```typescript public readonly webhooks: MutatingWebhook[]; ``` - *Type:* cdk8s-plus-32.k8s.MutatingWebhook[] Webhooks is a list of webhooks and the affected resources and operations. --- ### KubeNamespaceListProps NamespaceList is a list of Namespaces. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeNamespaceListProps: k8s.KubeNamespaceListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeNamespaceProps[] | Items is the list of Namespace objects in the list. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeNamespaceProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeNamespaceProps[] Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeNamespaceProps Namespace provides a scope for Names. Use of multiple namespaces is optional. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeNamespaceProps: k8s.KubeNamespaceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.NamespaceSpec | Spec defines the behavior of the Namespace. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: NamespaceSpec; ``` - *Type:* cdk8s-plus-32.k8s.NamespaceSpec Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeNetworkPolicyListProps NetworkPolicyList is a list of NetworkPolicy objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeNetworkPolicyListProps: k8s.KubeNetworkPolicyListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeNetworkPolicyProps[] | items is a list of schema objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeNetworkPolicyProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeNetworkPolicyProps[] items is a list of schema objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeNetworkPolicyProps NetworkPolicy describes what network traffic is allowed for a set of Pods. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeNetworkPolicyProps: k8s.KubeNetworkPolicyProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.NetworkPolicySpec | spec represents the specification of the desired behavior for this NetworkPolicy. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: NetworkPolicySpec; ``` - *Type:* cdk8s-plus-32.k8s.NetworkPolicySpec spec represents the specification of the desired behavior for this NetworkPolicy. --- ### KubeNodeListProps NodeList is the whole list of all Nodes which have been registered with master. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeNodeListProps: k8s.KubeNodeListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeNodeProps[] | List of nodes. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeNodeProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeNodeProps[] List of nodes. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeNodeProps Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd). #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeNodeProps: k8s.KubeNodeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.NodeSpec | Spec defines the behavior of a node. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: NodeSpec; ``` - *Type:* cdk8s-plus-32.k8s.NodeSpec Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubePersistentVolumeClaimListProps PersistentVolumeClaimList is a list of PersistentVolumeClaim items. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePersistentVolumeClaimListProps: k8s.KubePersistentVolumeClaimListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubePersistentVolumeClaimProps[] | items is a list of persistent volume claims. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubePersistentVolumeClaimProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubePersistentVolumeClaimProps[] items is a list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubePersistentVolumeClaimProps PersistentVolumeClaim is a user's request for and claim to a persistent volume. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePersistentVolumeClaimProps: k8s.KubePersistentVolumeClaimProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.PersistentVolumeClaimSpec | spec defines the desired characteristics of a volume requested by a pod author. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: PersistentVolumeClaimSpec; ``` - *Type:* cdk8s-plus-32.k8s.PersistentVolumeClaimSpec spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims --- ### KubePersistentVolumeListProps PersistentVolumeList is a list of PersistentVolume items. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePersistentVolumeListProps: k8s.KubePersistentVolumeListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubePersistentVolumeProps[] | items is a list of persistent volumes. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubePersistentVolumeProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubePersistentVolumeProps[] items is a list of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubePersistentVolumeProps 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 #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePersistentVolumeProps: k8s.KubePersistentVolumeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.PersistentVolumeSpec | spec defines a specification of a persistent volume owned by the cluster. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: PersistentVolumeSpec; ``` - *Type:* cdk8s-plus-32.k8s.PersistentVolumeSpec spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes --- ### KubePodDisruptionBudgetListProps PodDisruptionBudgetList is a collection of PodDisruptionBudgets. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePodDisruptionBudgetListProps: k8s.KubePodDisruptionBudgetListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubePodDisruptionBudgetProps[] | Items is a list of PodDisruptionBudgets. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard object's metadata. | --- ##### `items`^Required ```typescript public readonly items: KubePodDisruptionBudgetProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubePodDisruptionBudgetProps[] Items is a list of PodDisruptionBudgets. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubePodDisruptionBudgetProps PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePodDisruptionBudgetProps: k8s.KubePodDisruptionBudgetProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.PodDisruptionBudgetSpec | Specification of the desired behavior of the PodDisruptionBudget. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: PodDisruptionBudgetSpec; ``` - *Type:* cdk8s-plus-32.k8s.PodDisruptionBudgetSpec Specification of the desired behavior of the PodDisruptionBudget. --- ### KubePodListProps PodList is a list of Pods. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePodListProps: k8s.KubePodListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubePodProps[] | List of pods. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubePodProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubePodProps[] List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubePodProps Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePodProps: k8s.KubePodProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.PodSpec | Specification of the desired behavior of the pod. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: PodSpec; ``` - *Type:* cdk8s-plus-32.k8s.PodSpec Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubePodTemplateListProps PodTemplateList is a list of PodTemplates. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePodTemplateListProps: k8s.KubePodTemplateListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubePodTemplateProps[] | List of pod templates. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubePodTemplateProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubePodTemplateProps[] List of pod templates. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubePodTemplateProps PodTemplate describes a template for creating copies of a predefined pod. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePodTemplateProps: k8s.KubePodTemplateProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | template | cdk8s-plus-32.k8s.PodTemplateSpec | Template defines the pods that will be created from this pod template. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `template`^Optional ```typescript public readonly template: PodTemplateSpec; ``` - *Type:* cdk8s-plus-32.k8s.PodTemplateSpec Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubePriorityClassListProps PriorityClassList is a collection of priority classes. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePriorityClassListProps: k8s.KubePriorityClassListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubePriorityClassProps[] | items is the list of PriorityClasses. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubePriorityClassProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubePriorityClassProps[] items is the list of PriorityClasses. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubePriorityClassProps PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePriorityClassProps: k8s.KubePriorityClassProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | value | number | value represents the integer value of this priority class. | | description | string | description is an arbitrary string that usually provides guidelines on when this priority class should be used. | | globalDefault | boolean | globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | preemptionPolicy | string | preemptionPolicy is the Policy for preempting pods with lower priority. | --- ##### `value`^Required ```typescript public readonly value: number; ``` - *Type:* number value represents the integer value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string description is an arbitrary string that usually provides guidelines on when this priority class should be used. --- ##### `globalDefault`^Optional ```typescript public readonly globalDefault: boolean; ``` - *Type:* boolean globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `preemptionPolicy`^Optional ```typescript public readonly preemptionPolicy: string; ``` - *Type:* string - *Default:* PreemptLowerPriority if unset. preemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. --- ### KubePriorityLevelConfigurationListProps PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePriorityLevelConfigurationListProps: k8s.KubePriorityLevelConfigurationListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubePriorityLevelConfigurationProps[] | `items` is a list of request-priorities. | | metadata | cdk8s-plus-32.k8s.ListMeta | `metadata` is the standard object's metadata. | --- ##### `items`^Required ```typescript public readonly items: KubePriorityLevelConfigurationProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubePriorityLevelConfigurationProps[] `items` is a list of request-priorities. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubePriorityLevelConfigurationProps PriorityLevelConfiguration represents the configuration of a priority level. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubePriorityLevelConfigurationProps: k8s.KubePriorityLevelConfigurationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | `metadata` is the standard object's metadata. | | spec | cdk8s-plus-32.k8s.PriorityLevelConfigurationSpec | `spec` is the specification of the desired behavior of a "request-priority". | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: PriorityLevelConfigurationSpec; ``` - *Type:* cdk8s-plus-32.k8s.PriorityLevelConfigurationSpec `spec` is the specification of the desired behavior of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeReplicaSetListProps ReplicaSetList is a collection of ReplicaSets. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeReplicaSetListProps: k8s.KubeReplicaSetListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeReplicaSetProps[] | List of ReplicaSets. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeReplicaSetProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeReplicaSetProps[] List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeReplicaSetProps ReplicaSet ensures that a specified number of pod replicas are running at any given time. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeReplicaSetProps: k8s.KubeReplicaSetProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. | | spec | cdk8s-plus-32.k8s.ReplicaSetSpec | Spec defines the specification of the desired behavior of the ReplicaSet. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: ReplicaSetSpec; ``` - *Type:* cdk8s-plus-32.k8s.ReplicaSetSpec Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeReplicationControllerListProps ReplicationControllerList is a collection of replication controllers. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeReplicationControllerListProps: k8s.KubeReplicationControllerListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeReplicationControllerProps[] | List of replication controllers. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeReplicationControllerProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeReplicationControllerProps[] List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeReplicationControllerProps ReplicationController represents the configuration of a replication controller. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeReplicationControllerProps: k8s.KubeReplicationControllerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. | | spec | cdk8s-plus-32.k8s.ReplicationControllerSpec | Spec defines the specification of the desired behavior of the replication controller. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: ReplicationControllerSpec; ``` - *Type:* cdk8s-plus-32.k8s.ReplicationControllerSpec Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeResourceClaimListV1Alpha3Props ResourceClaimList is a collection of claims. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceClaimListV1Alpha3Props: k8s.KubeResourceClaimListV1Alpha3Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeResourceClaimV1Alpha3Props[] | Items is the list of resource claims. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeResourceClaimV1Alpha3Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeResourceClaimV1Alpha3Props[] Items is the list of resource claims. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. --- ### KubeResourceClaimListV1Beta1Props ResourceClaimList is a collection of claims. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceClaimListV1Beta1Props: k8s.KubeResourceClaimListV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeResourceClaimV1Beta1Props[] | Items is the list of resource claims. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeResourceClaimV1Beta1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeResourceClaimV1Beta1Props[] Items is the list of resource claims. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. --- ### KubeResourceClaimTemplateListV1Alpha3Props ResourceClaimTemplateList is a collection of claim templates. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceClaimTemplateListV1Alpha3Props: k8s.KubeResourceClaimTemplateListV1Alpha3Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeResourceClaimTemplateV1Alpha3Props[] | Items is the list of resource claim templates. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeResourceClaimTemplateV1Alpha3Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeResourceClaimTemplateV1Alpha3Props[] Items is the list of resource claim templates. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. --- ### KubeResourceClaimTemplateListV1Beta1Props ResourceClaimTemplateList is a collection of claim templates. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceClaimTemplateListV1Beta1Props: k8s.KubeResourceClaimTemplateListV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeResourceClaimTemplateV1Beta1Props[] | Items is the list of resource claim templates. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeResourceClaimTemplateV1Beta1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeResourceClaimTemplateV1Beta1Props[] Items is the list of resource claim templates. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. --- ### KubeResourceClaimTemplateV1Alpha3Props ResourceClaimTemplate is used to produce ResourceClaim objects. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceClaimTemplateV1Alpha3Props: k8s.KubeResourceClaimTemplateV1Alpha3Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.ResourceClaimTemplateSpecV1Alpha3 | Describes the ResourceClaim that is to be generated. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata. | --- ##### `spec`^Required ```typescript public readonly spec: ResourceClaimTemplateSpecV1Alpha3; ``` - *Type:* cdk8s-plus-32.k8s.ResourceClaimTemplateSpecV1Alpha3 Describes the ResourceClaim that is to be generated. This field is immutable. A ResourceClaim will get created by the control plane for a Pod when needed and then not get updated anymore. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata. --- ### KubeResourceClaimTemplateV1Beta1Props ResourceClaimTemplate is used to produce ResourceClaim objects. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceClaimTemplateV1Beta1Props: k8s.KubeResourceClaimTemplateV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.ResourceClaimTemplateSpecV1Beta1 | Describes the ResourceClaim that is to be generated. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata. | --- ##### `spec`^Required ```typescript public readonly spec: ResourceClaimTemplateSpecV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.ResourceClaimTemplateSpecV1Beta1 Describes the ResourceClaim that is to be generated. This field is immutable. A ResourceClaim will get created by the control plane for a Pod when needed and then not get updated anymore. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata. --- ### KubeResourceClaimV1Alpha3Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceClaimV1Alpha3Props: k8s.KubeResourceClaimV1Alpha3Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.ResourceClaimSpecV1Alpha3 | Spec describes what is being requested and how to configure it. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata. | --- ##### `spec`^Required ```typescript public readonly spec: ResourceClaimSpecV1Alpha3; ``` - *Type:* cdk8s-plus-32.k8s.ResourceClaimSpecV1Alpha3 Spec describes what is being requested and how to configure it. The spec is immutable. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata. --- ### KubeResourceClaimV1Beta1Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceClaimV1Beta1Props: k8s.KubeResourceClaimV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.ResourceClaimSpecV1Beta1 | Spec describes what is being requested and how to configure it. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata. | --- ##### `spec`^Required ```typescript public readonly spec: ResourceClaimSpecV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.ResourceClaimSpecV1Beta1 Spec describes what is being requested and how to configure it. The spec is immutable. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata. --- ### KubeResourceQuotaListProps ResourceQuotaList is a list of ResourceQuota items. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceQuotaListProps: k8s.KubeResourceQuotaListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeResourceQuotaProps[] | Items is a list of ResourceQuota objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeResourceQuotaProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeResourceQuotaProps[] Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeResourceQuotaProps ResourceQuota sets aggregate quota restrictions enforced per namespace. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceQuotaProps: k8s.KubeResourceQuotaProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.ResourceQuotaSpec | Spec defines the desired quota. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: ResourceQuotaSpec; ``` - *Type:* cdk8s-plus-32.k8s.ResourceQuotaSpec Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeResourceSliceListV1Alpha3Props ResourceSliceList is a collection of ResourceSlices. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceSliceListV1Alpha3Props: k8s.KubeResourceSliceListV1Alpha3Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeResourceSliceV1Alpha3Props[] | Items is the list of resource ResourceSlices. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeResourceSliceV1Alpha3Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeResourceSliceV1Alpha3Props[] Items is the list of resource ResourceSlices. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. --- ### KubeResourceSliceListV1Beta1Props ResourceSliceList is a collection of ResourceSlices. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceSliceListV1Beta1Props: k8s.KubeResourceSliceListV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeResourceSliceV1Beta1Props[] | Items is the list of resource ResourceSlices. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeResourceSliceV1Beta1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeResourceSliceV1Beta1Props[] Items is the list of resource ResourceSlices. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. --- ### KubeResourceSliceV1Alpha3Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceSliceV1Alpha3Props: k8s.KubeResourceSliceV1Alpha3Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.ResourceSliceSpecV1Alpha3 | Contains the information published by the driver. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata. | --- ##### `spec`^Required ```typescript public readonly spec: ResourceSliceSpecV1Alpha3; ``` - *Type:* cdk8s-plus-32.k8s.ResourceSliceSpecV1Alpha3 Contains the information published by the driver. Changing the spec automatically increments the metadata.generation number. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata. --- ### KubeResourceSliceV1Beta1Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeResourceSliceV1Beta1Props: k8s.KubeResourceSliceV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.ResourceSliceSpecV1Beta1 | Contains the information published by the driver. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata. | --- ##### `spec`^Required ```typescript public readonly spec: ResourceSliceSpecV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.ResourceSliceSpecV1Beta1 Contains the information published by the driver. Changing the spec automatically increments the metadata.generation number. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata. --- ### KubeRoleBindingListProps RoleBindingList is a collection of RoleBindings. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeRoleBindingListProps: k8s.KubeRoleBindingListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeRoleBindingProps[] | Items is a list of RoleBindings. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard object's metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeRoleBindingProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeRoleBindingProps[] Items is a list of RoleBindings. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard object's metadata. --- ### KubeRoleBindingProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeRoleBindingProps: k8s.KubeRoleBindingProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | roleRef | cdk8s-plus-32.k8s.RoleRef | RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | subjects | cdk8s-plus-32.k8s.Subject[] | Subjects holds references to the objects the role applies to. | --- ##### `roleRef`^Required ```typescript public readonly roleRef: RoleRef; ``` - *Type:* cdk8s-plus-32.k8s.RoleRef RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. This field is immutable. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. --- ##### `subjects`^Optional ```typescript public readonly subjects: Subject[]; ``` - *Type:* cdk8s-plus-32.k8s.Subject[] Subjects holds references to the objects the role applies to. --- ### KubeRoleListProps RoleList is a collection of Roles. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeRoleListProps: k8s.KubeRoleListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeRoleProps[] | Items is a list of Roles. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard object's metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeRoleProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeRoleProps[] Items is a list of Roles. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard object's metadata. --- ### KubeRoleProps Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeRoleProps: k8s.KubeRoleProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | rules | cdk8s-plus-32.k8s.PolicyRule[] | Rules holds all the PolicyRules for this Role. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. --- ##### `rules`^Optional ```typescript public readonly rules: PolicyRule[]; ``` - *Type:* cdk8s-plus-32.k8s.PolicyRule[] Rules holds all the PolicyRules for this Role. --- ### KubeRuntimeClassListProps RuntimeClassList is a list of RuntimeClass objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeRuntimeClassListProps: k8s.KubeRuntimeClassListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeRuntimeClassProps[] | items is a list of schema objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeRuntimeClassProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeRuntimeClassProps[] items is a list of schema objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeRuntimeClassProps 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/ #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeRuntimeClassProps: k8s.KubeRuntimeClassProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | handler | string | handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | | overhead | cdk8s-plus-32.k8s.Overhead | overhead represents the resource overhead associated with running a pod for a given RuntimeClass. | | scheduling | cdk8s-plus-32.k8s.Scheduling | scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. | --- ##### `handler`^Required ```typescript public readonly handler: string; ``` - *Type:* string handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `overhead`^Optional ```typescript public readonly overhead: Overhead; ``` - *Type:* cdk8s-plus-32.k8s.Overhead overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/ --- ##### `scheduling`^Optional ```typescript public readonly scheduling: Scheduling; ``` - *Type:* cdk8s-plus-32.k8s.Scheduling scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. --- ### KubeScaleProps Scale represents a scaling request for a resource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeScaleProps: k8s.KubeScaleProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata; | | spec | cdk8s-plus-32.k8s.ScaleSpec | spec defines the behavior of the scale. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional ```typescript public readonly spec: ScaleSpec; ``` - *Type:* cdk8s-plus-32.k8s.ScaleSpec spec defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. --- ### KubeSecretListProps SecretList is a list of Secret. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeSecretListProps: k8s.KubeSecretListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeSecretProps[] | Items is a list of secret objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeSecretProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeSecretProps[] Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeSecretProps Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeSecretProps: k8s.KubeSecretProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | data | {[ key: string ]: string} | Data contains the secret data. | | immutable | boolean | Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | stringData | {[ key: string ]: string} | stringData allows specifying non-binary secret data in string form. | | type | string | Used to facilitate programmatic handling of secret data. | --- ##### `data`^Optional ```typescript public readonly data: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 --- ##### `immutable`^Optional ```typescript public readonly immutable: boolean; ``` - *Type:* boolean Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `stringData`^Optional ```typescript public readonly stringData: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API. --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types --- ### KubeSelfSubjectAccessReviewProps 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 #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeSelfSubjectAccessReviewProps: k8s.KubeSelfSubjectAccessReviewProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.SelfSubjectAccessReviewSpec | Spec holds information about the request being evaluated. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard list metadata. | --- ##### `spec`^Required ```typescript public readonly spec: SelfSubjectAccessReviewSpec; ``` - *Type:* cdk8s-plus-32.k8s.SelfSubjectAccessReviewSpec Spec holds information about the request being evaluated. user and groups must be empty --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeSelfSubjectReviewProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeSelfSubjectReviewProps: k8s.KubeSelfSubjectReviewProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeSelfSubjectReviewV1Beta1Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeSelfSubjectReviewV1Beta1Props: k8s.KubeSelfSubjectReviewV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeSelfSubjectRulesReviewProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeSelfSubjectRulesReviewProps: k8s.KubeSelfSubjectRulesReviewProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.SelfSubjectRulesReviewSpec | Spec holds information about the request being evaluated. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard list metadata. | --- ##### `spec`^Required ```typescript public readonly spec: SelfSubjectRulesReviewSpec; ``` - *Type:* cdk8s-plus-32.k8s.SelfSubjectRulesReviewSpec Spec holds information about the request being evaluated. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeServiceAccountListProps ServiceAccountList is a list of ServiceAccount objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeServiceAccountListProps: k8s.KubeServiceAccountListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeServiceAccountProps[] | List of ServiceAccounts. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeServiceAccountProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeServiceAccountProps[] List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeServiceAccountProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeServiceAccountProps: k8s.KubeServiceAccountProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | automountServiceAccountToken | boolean | AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. | | imagePullSecrets | cdk8s-plus-32.k8s.LocalObjectReference[] | ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | secrets | cdk8s-plus-32.k8s.ObjectReference[] | Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. | --- ##### `automountServiceAccountToken`^Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level. --- ##### `imagePullSecrets`^Optional ```typescript public readonly imagePullSecrets: LocalObjectReference[]; ``` - *Type:* cdk8s-plus-32.k8s.LocalObjectReference[] ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `secrets`^Optional ```typescript public readonly secrets: ObjectReference[]; ``` - *Type:* cdk8s-plus-32.k8s.ObjectReference[] Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a "kubernetes.io/enforce-mountable-secrets" annotation set to "true". The "kubernetes.io/enforce-mountable-secrets" annotation is deprecated since v1.32. Prefer separate namespaces to isolate access to mounted secrets. This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret --- ### KubeServiceCidrListV1Beta1Props ServiceCIDRList contains a list of ServiceCIDR objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeServiceCidrListV1Beta1Props: k8s.KubeServiceCidrListV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeServiceCidrv1Beta1Props[] | items is the list of ServiceCIDRs. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard object's metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeServiceCidrv1Beta1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeServiceCidrv1Beta1Props[] items is the list of ServiceCIDRs. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeServiceCidrv1Beta1Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeServiceCidrv1Beta1Props: k8s.KubeServiceCidrv1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.ServiceCidrSpecV1Beta1 | spec is the desired state of the ServiceCIDR. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: ServiceCidrSpecV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.ServiceCidrSpecV1Beta1 spec is the desired state of the ServiceCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeServiceListProps ServiceList holds a list of services. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeServiceListProps: k8s.KubeServiceListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeServiceProps[] | List of services. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeServiceProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeServiceProps[] List of services. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeServiceProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeServiceProps: k8s.KubeServiceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.ServiceSpec | Spec defines the behavior of a service. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: ServiceSpec; ``` - *Type:* cdk8s-plus-32.k8s.ServiceSpec Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### KubeStatefulSetListProps StatefulSetList is a collection of StatefulSets. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeStatefulSetListProps: k8s.KubeStatefulSetListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeStatefulSetProps[] | Items is the list of stateful sets. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list's metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeStatefulSetProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeStatefulSetProps[] Items is the list of stateful sets. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeStatefulSetProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeStatefulSetProps: k8s.KubeStatefulSetProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.StatefulSetSpec | Spec defines the desired identities of pods in this set. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: StatefulSetSpec; ``` - *Type:* cdk8s-plus-32.k8s.StatefulSetSpec Spec defines the desired identities of pods in this set. --- ### KubeStatusProps Status is a return value for calls that don't return other objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeStatusProps: k8s.KubeStatusProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | code | number | Suggested HTTP return code for this status, 0 if not set. | | details | cdk8s-plus-32.k8s.StatusDetails | Extended data associated with the reason. | | message | string | A human-readable description of the status of this operation. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | | reason | string | A machine-readable description of why this operation is in the "Failure" status. | --- ##### `code`^Optional ```typescript public readonly code: number; ``` - *Type:* number Suggested HTTP return code for this status, 0 if not set. --- ##### `details`^Optional ```typescript public readonly details: StatusDetails; ``` - *Type:* cdk8s-plus-32.k8s.StatusDetails Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. --- ##### `message`^Optional ```typescript public readonly message: string; ``` - *Type:* string A human-readable description of the status of this operation. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ##### `reason`^Optional ```typescript public readonly reason: string; ``` - *Type:* string A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. --- ### KubeStorageClassListProps StorageClassList is a collection of storage classes. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeStorageClassListProps: k8s.KubeStorageClassListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeStorageClassProps[] | items is the list of StorageClasses. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeStorageClassProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeStorageClassProps[] items is the list of StorageClasses. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeStorageClassProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeStorageClassProps: k8s.KubeStorageClassProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | provisioner | string | provisioner indicates the type of the provisioner. | | allowedTopologies | cdk8s-plus-32.k8s.TopologySelectorTerm[] | allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. | | allowVolumeExpansion | boolean | allowVolumeExpansion shows whether the storage class allow volume expand. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | mountOptions | string[] | mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. | | parameters | {[ key: string ]: string} | parameters holds the parameters for the provisioner that should create volumes of this storage class. | | reclaimPolicy | string | reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. | | volumeBindingMode | string | volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. | --- ##### `provisioner`^Required ```typescript public readonly provisioner: string; ``` - *Type:* string provisioner indicates the type of the provisioner. --- ##### `allowedTopologies`^Optional ```typescript public readonly allowedTopologies: TopologySelectorTerm[]; ``` - *Type:* cdk8s-plus-32.k8s.TopologySelectorTerm[] allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. --- ##### `allowVolumeExpansion`^Optional ```typescript public readonly allowVolumeExpansion: boolean; ``` - *Type:* boolean allowVolumeExpansion shows whether the storage class allow volume expand. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `mountOptions`^Optional ```typescript public readonly mountOptions: string[]; ``` - *Type:* string[] mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. --- ##### `parameters`^Optional ```typescript public readonly parameters: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} parameters holds the parameters for the provisioner that should create volumes of this storage class. --- ##### `reclaimPolicy`^Optional ```typescript public readonly reclaimPolicy: string; ``` - *Type:* string - *Default:* Delete. reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete. --- ##### `volumeBindingMode`^Optional ```typescript public readonly volumeBindingMode: string; ``` - *Type:* string volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature. --- ### KubeStorageVersionListV1Alpha1Props A list of StorageVersions. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeStorageVersionListV1Alpha1Props: k8s.KubeStorageVersionListV1Alpha1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeStorageVersionV1Alpha1Props[] | Items holds a list of StorageVersion. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeStorageVersionV1Alpha1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeStorageVersionV1Alpha1Props[] Items holds a list of StorageVersion. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeStorageVersionMigrationListV1Alpha1Props StorageVersionMigrationList is a collection of storage version migrations. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeStorageVersionMigrationListV1Alpha1Props: k8s.KubeStorageVersionMigrationListV1Alpha1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeStorageVersionMigrationV1Alpha1Props[] | Items is the list of StorageVersionMigration. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeStorageVersionMigrationV1Alpha1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeStorageVersionMigrationV1Alpha1Props[] Items is the list of StorageVersionMigration. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeStorageVersionMigrationV1Alpha1Props StorageVersionMigration represents a migration of stored data to the latest storage version. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeStorageVersionMigrationV1Alpha1Props: k8s.KubeStorageVersionMigrationV1Alpha1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata. | | spec | cdk8s-plus-32.k8s.StorageVersionMigrationSpecV1Alpha1 | Specification of the migration. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: StorageVersionMigrationSpecV1Alpha1; ``` - *Type:* cdk8s-plus-32.k8s.StorageVersionMigrationSpecV1Alpha1 Specification of the migration. --- ### KubeStorageVersionV1Alpha1Props Storage version of a specific resource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeStorageVersionV1Alpha1Props: k8s.KubeStorageVersionV1Alpha1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | any | Spec is an empty spec. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | The name is .. | --- ##### `spec`^Required ```typescript public readonly spec: any; ``` - *Type:* any Spec is an empty spec. It is here to comply with Kubernetes API style. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta The name is .. --- ### KubeSubjectAccessReviewProps SubjectAccessReview checks whether or not a user or group can perform an action. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeSubjectAccessReviewProps: k8s.KubeSubjectAccessReviewProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.SubjectAccessReviewSpec | Spec holds information about the request being evaluated. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard list metadata. | --- ##### `spec`^Required ```typescript public readonly spec: SubjectAccessReviewSpec; ``` - *Type:* cdk8s-plus-32.k8s.SubjectAccessReviewSpec Spec holds information about the request being evaluated. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeTokenRequestProps TokenRequest requests a token for a given service account. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeTokenRequestProps: k8s.KubeTokenRequestProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.TokenRequestSpec | Spec holds information about the request being evaluated. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `spec`^Required ```typescript public readonly spec: TokenRequestSpec; ``` - *Type:* cdk8s-plus-32.k8s.TokenRequestSpec Spec holds information about the request being evaluated. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeTokenReviewProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeTokenReviewProps: k8s.KubeTokenReviewProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.TokenReviewSpec | Spec holds information about the request being evaluated. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `spec`^Required ```typescript public readonly spec: TokenReviewSpec; ``` - *Type:* cdk8s-plus-32.k8s.TokenReviewSpec Spec holds information about the request being evaluated. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeValidatingAdmissionPolicyBindingListProps ValidatingAdmissionPolicyBindingList is a list of ValidatingAdmissionPolicyBinding. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeValidatingAdmissionPolicyBindingListProps: k8s.KubeValidatingAdmissionPolicyBindingListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeValidatingAdmissionPolicyBindingProps[] | List of PolicyBinding. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeValidatingAdmissionPolicyBindingProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeValidatingAdmissionPolicyBindingProps[] List of PolicyBinding. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeValidatingAdmissionPolicyBindingListV1Beta1Props ValidatingAdmissionPolicyBindingList is a list of ValidatingAdmissionPolicyBinding. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeValidatingAdmissionPolicyBindingListV1Beta1Props: k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeValidatingAdmissionPolicyBindingV1Beta1Props[] | List of PolicyBinding. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeValidatingAdmissionPolicyBindingV1Beta1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeValidatingAdmissionPolicyBindingV1Beta1Props[] List of PolicyBinding. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeValidatingAdmissionPolicyBindingProps 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeValidatingAdmissionPolicyBindingProps: k8s.KubeValidatingAdmissionPolicyBindingProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata; | | spec | cdk8s-plus-32.k8s.ValidatingAdmissionPolicyBindingSpec | Specification of the desired behavior of the ValidatingAdmissionPolicyBinding. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional ```typescript public readonly spec: ValidatingAdmissionPolicyBindingSpec; ``` - *Type:* cdk8s-plus-32.k8s.ValidatingAdmissionPolicyBindingSpec Specification of the desired behavior of the ValidatingAdmissionPolicyBinding. --- ### KubeValidatingAdmissionPolicyBindingV1Beta1Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeValidatingAdmissionPolicyBindingV1Beta1Props: k8s.KubeValidatingAdmissionPolicyBindingV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata; | | spec | cdk8s-plus-32.k8s.ValidatingAdmissionPolicyBindingSpecV1Beta1 | Specification of the desired behavior of the ValidatingAdmissionPolicyBinding. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional ```typescript public readonly spec: ValidatingAdmissionPolicyBindingSpecV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.ValidatingAdmissionPolicyBindingSpecV1Beta1 Specification of the desired behavior of the ValidatingAdmissionPolicyBinding. --- ### KubeValidatingAdmissionPolicyListProps ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeValidatingAdmissionPolicyListProps: k8s.KubeValidatingAdmissionPolicyListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeValidatingAdmissionPolicyProps[] | List of ValidatingAdmissionPolicy. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeValidatingAdmissionPolicyProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeValidatingAdmissionPolicyProps[] List of ValidatingAdmissionPolicy. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeValidatingAdmissionPolicyListV1Beta1Props ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeValidatingAdmissionPolicyListV1Beta1Props: k8s.KubeValidatingAdmissionPolicyListV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeValidatingAdmissionPolicyV1Beta1Props[] | List of ValidatingAdmissionPolicy. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeValidatingAdmissionPolicyV1Beta1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeValidatingAdmissionPolicyV1Beta1Props[] List of ValidatingAdmissionPolicy. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeValidatingAdmissionPolicyProps ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeValidatingAdmissionPolicyProps: k8s.KubeValidatingAdmissionPolicyProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata; | | spec | cdk8s-plus-32.k8s.ValidatingAdmissionPolicySpec | Specification of the desired behavior of the ValidatingAdmissionPolicy. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional ```typescript public readonly spec: ValidatingAdmissionPolicySpec; ``` - *Type:* cdk8s-plus-32.k8s.ValidatingAdmissionPolicySpec Specification of the desired behavior of the ValidatingAdmissionPolicy. --- ### KubeValidatingAdmissionPolicyV1Beta1Props ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeValidatingAdmissionPolicyV1Beta1Props: k8s.KubeValidatingAdmissionPolicyV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata; | | spec | cdk8s-plus-32.k8s.ValidatingAdmissionPolicySpecV1Beta1 | Specification of the desired behavior of the ValidatingAdmissionPolicy. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional ```typescript public readonly spec: ValidatingAdmissionPolicySpecV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.ValidatingAdmissionPolicySpecV1Beta1 Specification of the desired behavior of the ValidatingAdmissionPolicy. --- ### KubeValidatingWebhookConfigurationListProps ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeValidatingWebhookConfigurationListProps: k8s.KubeValidatingWebhookConfigurationListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeValidatingWebhookConfigurationProps[] | List of ValidatingWebhookConfiguration. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeValidatingWebhookConfigurationProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeValidatingWebhookConfigurationProps[] List of ValidatingWebhookConfiguration. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ### KubeValidatingWebhookConfigurationProps ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeValidatingWebhookConfigurationProps: k8s.KubeValidatingWebhookConfigurationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata; | | webhooks | cdk8s-plus-32.k8s.ValidatingWebhook[] | Webhooks is a list of webhooks and the affected resources and operations. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `webhooks`^Optional ```typescript public readonly webhooks: ValidatingWebhook[]; ``` - *Type:* cdk8s-plus-32.k8s.ValidatingWebhook[] Webhooks is a list of webhooks and the affected resources and operations. --- ### KubeVolumeAttachmentListProps VolumeAttachmentList is a collection of VolumeAttachment objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeVolumeAttachmentListProps: k8s.KubeVolumeAttachmentListProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeVolumeAttachmentProps[] | items is the list of VolumeAttachments. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeVolumeAttachmentProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeVolumeAttachmentProps[] items is the list of VolumeAttachments. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeVolumeAttachmentProps VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. VolumeAttachment objects are non-namespaced. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeVolumeAttachmentProps: k8s.KubeVolumeAttachmentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.VolumeAttachmentSpec | spec represents specification of the desired attach/detach volume behavior. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object metadata. | --- ##### `spec`^Required ```typescript public readonly spec: VolumeAttachmentSpec; ``` - *Type:* cdk8s-plus-32.k8s.VolumeAttachmentSpec spec represents specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ### KubeVolumeAttributesClassListV1Alpha1Props VolumeAttributesClassList is a collection of VolumeAttributesClass objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeVolumeAttributesClassListV1Alpha1Props: k8s.KubeVolumeAttributesClassListV1Alpha1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeVolumeAttributesClassV1Alpha1Props[] | items is the list of VolumeAttributesClass objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeVolumeAttributesClassV1Alpha1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeVolumeAttributesClassV1Alpha1Props[] items is the list of VolumeAttributesClass objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeVolumeAttributesClassListV1Beta1Props VolumeAttributesClassList is a collection of VolumeAttributesClass objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeVolumeAttributesClassListV1Beta1Props: k8s.KubeVolumeAttributesClassListV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KubeVolumeAttributesClassV1Beta1Props[] | items is the list of VolumeAttributesClass objects. | | metadata | cdk8s-plus-32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `items`^Required ```typescript public readonly items: KubeVolumeAttributesClassV1Beta1Props[]; ``` - *Type:* cdk8s-plus-32.k8s.KubeVolumeAttributesClassV1Beta1Props[] items is the list of VolumeAttributesClass objects. --- ##### `metadata`^Optional ```typescript public readonly metadata: ListMeta; ``` - *Type:* cdk8s-plus-32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ### KubeVolumeAttributesClassV1Alpha1Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeVolumeAttributesClassV1Alpha1Props: k8s.KubeVolumeAttributesClassV1Alpha1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | driverName | string | Name of the CSI driver This field is immutable. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | parameters | {[ key: string ]: string} | parameters hold volume attributes defined by the CSI driver. | --- ##### `driverName`^Required ```typescript public readonly driverName: string; ``` - *Type:* string Name of the CSI driver This field is immutable. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `parameters`^Optional ```typescript public readonly parameters: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} parameters hold volume attributes defined by the CSI driver. These values are opaque to the Kubernetes and are passed directly to the CSI driver. The underlying storage provider supports changing these attributes on an existing volume, however the parameters field itself is immutable. To invoke a volume update, a new VolumeAttributesClass should be created with new parameters, and the PersistentVolumeClaim should be updated to reference the new VolumeAttributesClass. This field is required and must contain at least one key/value pair. The keys cannot be empty, and the maximum number of parameters is 512, with a cumulative max size of 256K. If the CSI driver rejects invalid parameters, the target PersistentVolumeClaim will be set to an "Infeasible" state in the modifyVolumeStatus field. --- ### KubeVolumeAttributesClassV1Beta1Props 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. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const kubeVolumeAttributesClassV1Beta1Props: k8s.KubeVolumeAttributesClassV1Beta1Props = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | driverName | string | Name of the CSI driver This field is immutable. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | parameters | {[ key: string ]: string} | parameters hold volume attributes defined by the CSI driver. | --- ##### `driverName`^Required ```typescript public readonly driverName: string; ``` - *Type:* string Name of the CSI driver This field is immutable. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `parameters`^Optional ```typescript public readonly parameters: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} parameters hold volume attributes defined by the CSI driver. These values are opaque to the Kubernetes and are passed directly to the CSI driver. The underlying storage provider supports changing these attributes on an existing volume, however the parameters field itself is immutable. To invoke a volume update, a new VolumeAttributesClass should be created with new parameters, and the PersistentVolumeClaim should be updated to reference the new VolumeAttributesClass. This field is required and must contain at least one key/value pair. The keys cannot be empty, and the maximum number of parameters is 512, with a cumulative max size of 256K. If the CSI driver rejects invalid parameters, the target PersistentVolumeClaim will be set to an "Infeasible" state in the modifyVolumeStatus field. --- ### LabelSelector A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const labelSelector: k8s.LabelSelector = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | matchExpressions | cdk8s-plus-32.k8s.LabelSelectorRequirement[] | matchExpressions is a list of label selector requirements. | | matchLabels | {[ key: string ]: string} | matchLabels is a map of {key,value} pairs. | --- ##### `matchExpressions`^Optional ```typescript public readonly matchExpressions: LabelSelectorRequirement[]; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelectorRequirement[] matchExpressions is a list of label selector requirements. The requirements are ANDed. --- ##### `matchLabels`^Optional ```typescript public readonly matchLabels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. --- ### LabelSelectorAttributes LabelSelectorAttributes indicates a label limited access. Webhook authors are encouraged to * ensure rawSelector and requirements are not both set * consider the requirements field if set * not try to parse or consider the rawSelector field if set. This is to avoid another CVE-2022-2880 (i.e. getting different systems to agree on how exactly to parse a query is not something we want), see https://www.oxeye.io/resources/golang-parameter-smuggling-attack for more details. For the *SubjectAccessReview endpoints of the kube-apiserver: * If rawSelector is empty and requirements are empty, the request is not limited. * If rawSelector is present and requirements are empty, the rawSelector will be parsed and limited if the parsing succeeds. * If rawSelector is empty and requirements are present, the requirements should be honored * If rawSelector is present and requirements are present, the request is invalid. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const labelSelectorAttributes: k8s.LabelSelectorAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | rawSelector | string | rawSelector is the serialization of a field selector that would be included in a query parameter. | | requirements | cdk8s-plus-32.k8s.LabelSelectorRequirement[] | requirements is the parsed interpretation of a label selector. | --- ##### `rawSelector`^Optional ```typescript public readonly rawSelector: string; ``` - *Type:* string rawSelector is the serialization of a field selector that would be included in a query parameter. Webhook implementations are encouraged to ignore rawSelector. The kube-apiserver's *SubjectAccessReview will parse the rawSelector as long as the requirements are not present. --- ##### `requirements`^Optional ```typescript public readonly requirements: LabelSelectorRequirement[]; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelectorRequirement[] requirements is the parsed interpretation of a label selector. All requirements must be met for a resource instance to match the selector. Webhook implementations should handle requirements, but how to handle them is up to the webhook. Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements are not understood. --- ### LabelSelectorOptions Options for `LabelSelector.of`. #### Initializer ```typescript import { LabelSelectorOptions } from 'cdk8s-plus-32' const labelSelectorOptions: LabelSelectorOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expressions | LabelExpression[] | Expression based label matchers. | | labels | {[ key: string ]: string} | Strict label matchers. | --- ##### `expressions`^Optional ```typescript public readonly expressions: LabelExpression[]; ``` - *Type:* LabelExpression[] Expression based label matchers. --- ##### `labels`^Optional ```typescript public readonly labels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Strict label matchers. --- ### LabelSelectorRequirement A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. #### Initializer ```typescript import { LabelSelectorRequirement } from 'cdk8s-plus-32' const labelSelectorRequirement: LabelSelectorRequirement = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | The label key that the selector applies to. | | operator | string | Represents a key's relationship to a set of values. | | values | string[] | An array of string values. | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string The label key that the selector applies to. --- ##### `operator`^Required ```typescript public readonly operator: string; ``` - *Type:* string Represents a key's relationship to a set of values. --- ##### `values`^Optional ```typescript public readonly values: string[]; ``` - *Type:* string[] An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. --- ### LabelSelectorRequirement A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const labelSelectorRequirement: k8s.LabelSelectorRequirement = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | key is the label key that the selector applies to. | | operator | string | operator represents a key's relationship to a set of values. | | values | string[] | values is an array of string values. | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string key is the label key that the selector applies to. --- ##### `operator`^Required ```typescript public readonly operator: string; ``` - *Type:* string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. --- ##### `values`^Optional ```typescript public readonly values: string[]; ``` - *Type:* string[] values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. --- ### LeaseCandidateSpecV1Alpha2 LeaseCandidateSpec is a specification of a Lease. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const leaseCandidateSpecV1Alpha2: k8s.LeaseCandidateSpecV1Alpha2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | binaryVersion | string | BinaryVersion is the binary version. | | leaseName | string | LeaseName is the name of the lease for which this candidate is contending. | | strategy | string | Strategy is the strategy that coordinated leader election will use for picking the leader. | | emulationVersion | string | EmulationVersion is the emulation version. | | pingTime | Date | PingTime is the last time that the server has requested the LeaseCandidate to renew. | | renewTime | Date | RenewTime is the time that the LeaseCandidate was last updated. | --- ##### `binaryVersion`^Required ```typescript public readonly binaryVersion: string; ``` - *Type:* string BinaryVersion is the binary version. It must be in a semver format without leading `v`. This field is required. --- ##### `leaseName`^Required ```typescript public readonly leaseName: string; ``` - *Type:* string LeaseName is the name of the lease for which this candidate is contending. This field is immutable. --- ##### `strategy`^Required ```typescript public readonly strategy: string; ``` - *Type:* string Strategy is the strategy that coordinated leader election will use for picking the leader. If multiple candidates for the same Lease return different strategies, the strategy provided by the candidate with the latest BinaryVersion will be used. If there is still conflict, this is a user error and coordinated leader election will not operate the Lease until resolved. (Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled. --- ##### `emulationVersion`^Optional ```typescript public readonly emulationVersion: string; ``` - *Type:* string EmulationVersion is the emulation version. It must be in a semver format without leading `v`. EmulationVersion must be less than or equal to BinaryVersion. This field is required when strategy is "OldestEmulationVersion" --- ##### `pingTime`^Optional ```typescript public readonly pingTime: Date; ``` - *Type:* Date PingTime is the last time that the server has requested the LeaseCandidate to renew. It is only done during leader election to check if any LeaseCandidates have become ineligible. When PingTime is updated, the LeaseCandidate will respond by updating RenewTime. --- ##### `renewTime`^Optional ```typescript public readonly renewTime: Date; ``` - *Type:* Date RenewTime is the time that the LeaseCandidate was last updated. Any time a Lease needs to do leader election, the PingTime field is updated to signal to the LeaseCandidate that they should update the RenewTime. Old LeaseCandidate objects are also garbage collected if it has been hours since the last renew. The PingTime field is updated regularly to prevent garbage collection for still active LeaseCandidates. --- ### LeaseSpec LeaseSpec is a specification of a Lease. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const leaseSpec: k8s.LeaseSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | acquireTime | Date | acquireTime is a time when the current lease was acquired. | | holderIdentity | string | holderIdentity contains the identity of the holder of a current lease. | | leaseDurationSeconds | number | leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. | | leaseTransitions | number | leaseTransitions is the number of transitions of a lease between holders. | | preferredHolder | string | PreferredHolder signals to a lease holder that the lease has a more optimal holder and should be given up. | | renewTime | Date | renewTime is a time when the current holder of a lease has last updated the lease. | | strategy | string | Strategy indicates the strategy for picking the leader for coordinated leader election. | --- ##### `acquireTime`^Optional ```typescript public readonly acquireTime: Date; ``` - *Type:* Date acquireTime is a time when the current lease was acquired. --- ##### `holderIdentity`^Optional ```typescript public readonly holderIdentity: string; ``` - *Type:* string holderIdentity contains the identity of the holder of a current lease. If Coordinated Leader Election is used, the holder identity must be equal to the elected LeaseCandidate.metadata.name field. --- ##### `leaseDurationSeconds`^Optional ```typescript public readonly leaseDurationSeconds: number; ``` - *Type:* number leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measured against the time of last observed renewTime. --- ##### `leaseTransitions`^Optional ```typescript public readonly leaseTransitions: number; ``` - *Type:* number leaseTransitions is the number of transitions of a lease between holders. --- ##### `preferredHolder`^Optional ```typescript public readonly preferredHolder: string; ``` - *Type:* string PreferredHolder signals to a lease holder that the lease has a more optimal holder and should be given up. This field can only be set if Strategy is also set. --- ##### `renewTime`^Optional ```typescript public readonly renewTime: Date; ``` - *Type:* Date renewTime is a time when the current holder of a lease has last updated the lease. --- ##### `strategy`^Optional ```typescript public readonly strategy: string; ``` - *Type:* string Strategy indicates the strategy for picking the leader for coordinated leader election. If the field is not specified, there is no active coordination for this lease. (Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled. --- ### Lifecycle Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const lifecycle: k8s.Lifecycle = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | postStart | cdk8s-plus-32.k8s.LifecycleHandler | PostStart is called immediately after a container is created. | | preStop | cdk8s-plus-32.k8s.LifecycleHandler | PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. | --- ##### `postStart`^Optional ```typescript public readonly postStart: LifecycleHandler; ``` - *Type:* cdk8s-plus-32.k8s.LifecycleHandler PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks --- ##### `preStop`^Optional ```typescript public readonly preStop: LifecycleHandler; ``` - *Type:* cdk8s-plus-32.k8s.LifecycleHandler PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks --- ### LifecycleHandler LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const lifecycleHandler: k8s.LifecycleHandler = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | exec | cdk8s-plus-32.k8s.ExecAction | Exec specifies a command to execute in the container. | | httpGet | cdk8s-plus-32.k8s.HttpGetAction | HTTPGet specifies an HTTP GET request to perform. | | sleep | cdk8s-plus-32.k8s.SleepAction | Sleep represents a duration that the container should sleep. | | tcpSocket | cdk8s-plus-32.k8s.TcpSocketAction | Deprecated. | --- ##### `exec`^Optional ```typescript public readonly exec: ExecAction; ``` - *Type:* cdk8s-plus-32.k8s.ExecAction Exec specifies a command to execute in the container. --- ##### `httpGet`^Optional ```typescript public readonly httpGet: HttpGetAction; ``` - *Type:* cdk8s-plus-32.k8s.HttpGetAction HTTPGet specifies an HTTP GET request to perform. --- ##### `sleep`^Optional ```typescript public readonly sleep: SleepAction; ``` - *Type:* cdk8s-plus-32.k8s.SleepAction Sleep represents a duration that the container should sleep. --- ##### `tcpSocket`^Optional ```typescript public readonly tcpSocket: TcpSocketAction; ``` - *Type:* cdk8s-plus-32.k8s.TcpSocketAction Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified. --- ### LimitedPriorityLevelConfiguration LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues: - How are requests for this priority level limited? - What should be done with requests that exceed the limit? #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const limitedPriorityLevelConfiguration: k8s.LimitedPriorityLevelConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | borrowingLimitPercent | number | `borrowingLimitPercent`, if present, configures a limit on how many seats this priority level can borrow from other priority levels. | | lendablePercent | number | `lendablePercent` prescribes the fraction of the level's NominalCL that can be borrowed by other priority levels. | | limitResponse | cdk8s-plus-32.k8s.LimitResponse | `limitResponse` indicates what to do with requests that can not be executed right now. | | nominalConcurrencyShares | number | `nominalConcurrencyShares` (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. | --- ##### `borrowingLimitPercent`^Optional ```typescript public readonly borrowingLimitPercent: number; ``` - *Type:* number `borrowingLimitPercent`, if present, configures a limit on how many seats this priority level can borrow from other priority levels. The limit is known as this level's BorrowingConcurrencyLimit (BorrowingCL) and is a limit on the total number of seats that this level may borrow at any one time. This field holds the ratio of that limit to the level's nominal concurrency limit. When this field is non-nil, it must hold a non-negative integer and the limit is calculated as follows. BorrowingCL(i) = round( NominalCL(i) * borrowingLimitPercent(i)/100.0 ) The value of this field can be more than 100, implying that this priority level can borrow a number of seats that is greater than its own nominal concurrency limit (NominalCL). When this field is left `nil`, the limit is effectively infinite. --- ##### `lendablePercent`^Optional ```typescript public readonly lendablePercent: number; ``` - *Type:* number `lendablePercent` prescribes the fraction of the level's NominalCL that can be borrowed by other priority levels. The value of this field must be between 0 and 100, inclusive, and it defaults to 0. The number of seats that other levels can borrow from this level, known as this level's LendableConcurrencyLimit (LendableCL), is defined as follows. LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 ) --- ##### `limitResponse`^Optional ```typescript public readonly limitResponse: LimitResponse; ``` - *Type:* cdk8s-plus-32.k8s.LimitResponse `limitResponse` indicates what to do with requests that can not be executed right now. --- ##### `nominalConcurrencyShares`^Optional ```typescript public readonly nominalConcurrencyShares: number; ``` - *Type:* number `nominalConcurrencyShares` (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. This is the number of execution seats available at this priority level. This is used both for requests dispatched from this priority level as well as requests dispatched from other priority levels borrowing seats from this level. The server's concurrency limit (ServerCL) is divided among the Limited priority levels in proportion to their NCS values: NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[priority level k] NCS(k) Bigger numbers mean a larger nominal concurrency limit, at the expense of every other priority level. If not specified, this field defaults to a value of 30. Setting this field to zero supports the construction of a "jail" for this priority level that is used to hold some request(s) --- ### LimitRangeItem LimitRangeItem defines a min/max usage limit for any resource that matches on kind. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const limitRangeItem: k8s.LimitRangeItem = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | Type of resource that this limit applies to. | | default | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | Default resource requirement limit value by resource name if resource limit is omitted. | | defaultRequest | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. | | max | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | Max usage constraints on this kind by resource name. | | maxLimitRequestRatio | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; | | min | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | Min usage constraints on this kind by resource name. | --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string Type of resource that this limit applies to. --- ##### `default`^Optional ```typescript public readonly default: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} Default resource requirement limit value by resource name if resource limit is omitted. --- ##### `defaultRequest`^Optional ```typescript public readonly defaultRequest: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. --- ##### `max`^Optional ```typescript public readonly max: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} Max usage constraints on this kind by resource name. --- ##### `maxLimitRequestRatio`^Optional ```typescript public readonly maxLimitRequestRatio: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. --- ##### `min`^Optional ```typescript public readonly min: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} Min usage constraints on this kind by resource name. --- ### LimitRangeSpec LimitRangeSpec defines a min/max usage limit for resources that match on kind. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const limitRangeSpec: k8s.LimitRangeSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | limits | cdk8s-plus-32.k8s.LimitRangeItem[] | Limits is the list of LimitRangeItem objects that are enforced. | --- ##### `limits`^Required ```typescript public readonly limits: LimitRangeItem[]; ``` - *Type:* cdk8s-plus-32.k8s.LimitRangeItem[] Limits is the list of LimitRangeItem objects that are enforced. --- ### LimitResponse LimitResponse defines how to handle requests that can not be executed right now. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const limitResponse: k8s.LimitResponse = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | `type` is "Queue" or "Reject". | | queuing | cdk8s-plus-32.k8s.QueuingConfiguration | `queuing` holds the configuration parameters for queuing. | --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string `type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required. --- ##### `queuing`^Optional ```typescript public readonly queuing: QueuingConfiguration; ``` - *Type:* cdk8s-plus-32.k8s.QueuingConfiguration `queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`. --- ### ListMeta ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const listMeta: k8s.ListMeta = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. | | remainingItemCount | number | remainingItemCount is the number of subsequent items in the list which are not included in this list response. | | resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. | | selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | --- ##### `continue`^Optional ```typescript public readonly continue: string; ``` - *Type:* string continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. --- ##### `remainingItemCount`^Optional ```typescript public readonly remainingItemCount: number; ``` - *Type:* number remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. --- ##### `resourceVersion`^Optional ```typescript public readonly resourceVersion: string; ``` - *Type:* string String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency --- ##### `selfLink`^Optional ```typescript public readonly selfLink: string; ``` - *Type:* string Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. --- ### LocalObjectReference LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const localObjectReference: k8s.LocalObjectReference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name of the referent. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names --- ### LocalVolumeSource Local represents directly-attached storage with node affinity. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const localVolumeSource: k8s.LocalVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | string | path of the full path to the volume on the node. | | fsType | string | fsType is the filesystem type to mount. | --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...). --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a filesystem if unspecified. --- ### ManagedFieldsEntry ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const managedFieldsEntry: k8s.ManagedFieldsEntry = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | APIVersion defines the version of this resource that this field set applies to. | | fieldsType | string | FieldsType is the discriminator for the different fields format and version. | | fieldsV1 | any | FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. | | manager | string | Manager is an identifier of the workflow managing these fields. | | operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. | | subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. | | time | Date | Time is the timestamp of when the ManagedFields entry was added. | --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. --- ##### `fieldsType`^Optional ```typescript public readonly fieldsType: string; ``` - *Type:* string FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" --- ##### `fieldsV1`^Optional ```typescript public readonly fieldsV1: any; ``` - *Type:* any FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. --- ##### `manager`^Optional ```typescript public readonly manager: string; ``` - *Type:* string Manager is an identifier of the workflow managing these fields. --- ##### `operation`^Optional ```typescript public readonly operation: string; ``` - *Type:* string Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. --- ##### `subresource`^Optional ```typescript public readonly subresource: string; ``` - *Type:* string Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. --- ##### `time`^Optional ```typescript public readonly time: Date; ``` - *Type:* Date Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over. --- ### MatchCondition MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const matchCondition: k8s.MatchCondition = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | Expression represents the expression which will be evaluated by CEL. | | name | string | Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. | --- ##### `expression`^Required ```typescript public readonly expression: string; ``` - *Type:* string Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables: 'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the request resource. Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ Required. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName') Required. --- ### MatchConditionV1Alpha1 #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const matchConditionV1Alpha1: k8s.MatchConditionV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | Expression represents the expression which will be evaluated by CEL. | | name | string | Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. | --- ##### `expression`^Required ```typescript public readonly expression: string; ``` - *Type:* string Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables: 'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the request resource. Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ Required. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName') Required. --- ### MatchConditionV1Beta1 MatchCondition represents a condition which must be fulfilled for a request to be sent to a webhook. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const matchConditionV1Beta1: k8s.MatchConditionV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | Expression represents the expression which will be evaluated by CEL. | | name | string | Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. | --- ##### `expression`^Required ```typescript public readonly expression: string; ``` - *Type:* string Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables: 'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the request resource. Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ Required. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName') Required. --- ### MatchResources MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded) #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const matchResources: k8s.MatchResources = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | excludeResourceRules | cdk8s-plus-32.k8s.NamedRuleWithOperations[] | ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. | | matchPolicy | string | matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". | | namespaceSelector | cdk8s-plus-32.k8s.LabelSelector | NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. | | objectSelector | cdk8s-plus-32.k8s.LabelSelector | ObjectSelector decides whether to run the validation based on if the object has matching labels. | | resourceRules | cdk8s-plus-32.k8s.NamedRuleWithOperations[] | ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. | --- ##### `excludeResourceRules`^Optional ```typescript public readonly excludeResourceRules: NamedRuleWithOperations[]; ``` - *Type:* cdk8s-plus-32.k8s.NamedRuleWithOperations[] ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded) --- ##### `matchPolicy`^Optional ```typescript public readonly matchPolicy: string; ``` - *Type:* string - *Default:* Equivalent" matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the ValidatingAdmissionPolicy. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the ValidatingAdmissionPolicy. Defaults to "Equivalent" --- ##### `namespaceSelector`^Optional ```typescript public readonly namespaceSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector - *Default:* the empty LabelSelector, which matches everything. NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the policy. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the policy on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. Default to the empty LabelSelector, which matches everything. --- ##### `objectSelector`^Optional ```typescript public readonly objectSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector - *Default:* the empty LabelSelector, which matches everything. ObjectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. --- ##### `resourceRules`^Optional ```typescript public readonly resourceRules: NamedRuleWithOperations[]; ``` - *Type:* cdk8s-plus-32.k8s.NamedRuleWithOperations[] ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches _any_ Rule. --- ### MatchResourcesV1Alpha1 MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded) #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const matchResourcesV1Alpha1: k8s.MatchResourcesV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | excludeResourceRules | cdk8s-plus-32.k8s.NamedRuleWithOperationsV1Alpha1[] | ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. | | matchPolicy | string | matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". | | namespaceSelector | cdk8s-plus-32.k8s.LabelSelector | NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. | | objectSelector | cdk8s-plus-32.k8s.LabelSelector | ObjectSelector decides whether to run the validation based on if the object has matching labels. | | resourceRules | cdk8s-plus-32.k8s.NamedRuleWithOperationsV1Alpha1[] | ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. | --- ##### `excludeResourceRules`^Optional ```typescript public readonly excludeResourceRules: NamedRuleWithOperationsV1Alpha1[]; ``` - *Type:* cdk8s-plus-32.k8s.NamedRuleWithOperationsV1Alpha1[] ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded) --- ##### `matchPolicy`^Optional ```typescript public readonly matchPolicy: string; ``` - *Type:* string - *Default:* Equivalent" matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the ValidatingAdmissionPolicy. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the ValidatingAdmissionPolicy. Defaults to "Equivalent" --- ##### `namespaceSelector`^Optional ```typescript public readonly namespaceSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector - *Default:* the empty LabelSelector, which matches everything. NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the policy. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the policy on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. Default to the empty LabelSelector, which matches everything. --- ##### `objectSelector`^Optional ```typescript public readonly objectSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector - *Default:* the empty LabelSelector, which matches everything. ObjectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. --- ##### `resourceRules`^Optional ```typescript public readonly resourceRules: NamedRuleWithOperationsV1Alpha1[]; ``` - *Type:* cdk8s-plus-32.k8s.NamedRuleWithOperationsV1Alpha1[] ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches _any_ Rule. --- ### MatchResourcesV1Beta1 MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded) #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const matchResourcesV1Beta1: k8s.MatchResourcesV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | excludeResourceRules | cdk8s-plus-32.k8s.NamedRuleWithOperationsV1Beta1[] | ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. | | matchPolicy | string | matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". | | namespaceSelector | cdk8s-plus-32.k8s.LabelSelector | NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. | | objectSelector | cdk8s-plus-32.k8s.LabelSelector | ObjectSelector decides whether to run the validation based on if the object has matching labels. | | resourceRules | cdk8s-plus-32.k8s.NamedRuleWithOperationsV1Beta1[] | ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. | --- ##### `excludeResourceRules`^Optional ```typescript public readonly excludeResourceRules: NamedRuleWithOperationsV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.NamedRuleWithOperationsV1Beta1[] ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded) --- ##### `matchPolicy`^Optional ```typescript public readonly matchPolicy: string; ``` - *Type:* string - *Default:* Equivalent" matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the ValidatingAdmissionPolicy. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the ValidatingAdmissionPolicy. Defaults to "Equivalent" --- ##### `namespaceSelector`^Optional ```typescript public readonly namespaceSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector - *Default:* the empty LabelSelector, which matches everything. NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the policy. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the policy on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. Default to the empty LabelSelector, which matches everything. --- ##### `objectSelector`^Optional ```typescript public readonly objectSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector - *Default:* the empty LabelSelector, which matches everything. ObjectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. --- ##### `resourceRules`^Optional ```typescript public readonly resourceRules: NamedRuleWithOperationsV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.NamedRuleWithOperationsV1Beta1[] ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches _any_ Rule. --- ### MemoryResources Memory request and limit. #### Initializer ```typescript import { MemoryResources } from 'cdk8s-plus-32' const memoryResources: MemoryResources = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | limit | cdk8s.Size | *No description.* | | request | cdk8s.Size | *No description.* | --- ##### `limit`^Optional ```typescript public readonly limit: Size; ``` - *Type:* cdk8s.Size --- ##### `request`^Optional ```typescript public readonly request: Size; ``` - *Type:* cdk8s.Size --- ### MetricContainerResourceOptions Options for `Metric.containerResource()`. #### Initializer ```typescript import { MetricContainerResourceOptions } from 'cdk8s-plus-32' const metricContainerResourceOptions: MetricContainerResourceOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | container | Container | Container where the metric can be found. | | target | MetricTarget | Target metric value that will trigger scaling. | --- ##### `container`^Required ```typescript public readonly container: Container; ``` - *Type:* Container Container where the metric can be found. --- ##### `target`^Required ```typescript public readonly target: MetricTarget; ``` - *Type:* MetricTarget Target metric value that will trigger scaling. --- ### MetricIdentifierV2 MetricIdentifier defines the name and optionally selector for a metric. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const metricIdentifierV2: k8s.MetricIdentifierV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | name is the name of the given metric. | | selector | cdk8s-plus-32.k8s.LabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name is the name of the given metric. --- ##### `selector`^Optional ```typescript public readonly selector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics. --- ### MetricObjectOptions Options for `Metric.object()`. #### Initializer ```typescript import { MetricObjectOptions } from 'cdk8s-plus-32' const metricObjectOptions: MetricObjectOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name of the metric to scale on. | | target | MetricTarget | The target metric value that will trigger scaling. | | labelSelector | LabelSelector | A selector to find a metric by label. | | object | IResource | Resource where the metric can be found. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the metric to scale on. --- ##### `target`^Required ```typescript public readonly target: MetricTarget; ``` - *Type:* MetricTarget The target metric value that will trigger scaling. --- ##### `labelSelector`^Optional ```typescript public readonly labelSelector: LabelSelector; ``` - *Type:* LabelSelector - *Default:* Just the metric 'name' will be used to gather metrics. A selector to find a metric by label. When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. --- ##### `object`^Required ```typescript public readonly object: IResource; ``` - *Type:* IResource Resource where the metric can be found. --- ### MetricOptions Base options for a Metric. #### Initializer ```typescript import { MetricOptions } from 'cdk8s-plus-32' const metricOptions: MetricOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name of the metric to scale on. | | target | MetricTarget | The target metric value that will trigger scaling. | | labelSelector | LabelSelector | A selector to find a metric by label. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the metric to scale on. --- ##### `target`^Required ```typescript public readonly target: MetricTarget; ``` - *Type:* MetricTarget The target metric value that will trigger scaling. --- ##### `labelSelector`^Optional ```typescript public readonly labelSelector: LabelSelector; ``` - *Type:* LabelSelector - *Default:* Just the metric 'name' will be used to gather metrics. A selector to find a metric by label. When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. --- ### MetricSpecV2 MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once). #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const metricSpecV2: k8s.MetricSpecV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | type is the type of metric source. | | containerResource | cdk8s-plus-32.k8s.ContainerResourceMetricSourceV2 | containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. | | external | cdk8s-plus-32.k8s.ExternalMetricSourceV2 | external refers to a global metric that is not associated with any Kubernetes object. | | object | cdk8s-plus-32.k8s.ObjectMetricSourceV2 | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). | | pods | cdk8s-plus-32.k8s.PodsMetricSourceV2 | pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). | | resource | cdk8s-plus-32.k8s.ResourceMetricSourceV2 | resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. | --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. --- ##### `containerResource`^Optional ```typescript public readonly containerResource: ContainerResourceMetricSourceV2; ``` - *Type:* cdk8s-plus-32.k8s.ContainerResourceMetricSourceV2 containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. --- ##### `external`^Optional ```typescript public readonly external: ExternalMetricSourceV2; ``` - *Type:* cdk8s-plus-32.k8s.ExternalMetricSourceV2 external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). --- ##### `object`^Optional ```typescript public readonly object: ObjectMetricSourceV2; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMetricSourceV2 object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). --- ##### `pods`^Optional ```typescript public readonly pods: PodsMetricSourceV2; ``` - *Type:* cdk8s-plus-32.k8s.PodsMetricSourceV2 pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. --- ##### `resource`^Optional ```typescript public readonly resource: ResourceMetricSourceV2; ``` - *Type:* cdk8s-plus-32.k8s.ResourceMetricSourceV2 resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. --- ### MetricTargetV2 MetricTarget defines the target value, average value, or average utilization of a specific metric. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const metricTargetV2: k8s.MetricTargetV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | type represents whether the metric type is Utilization, Value, or AverageValue. | | averageUtilization | number | averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. | | averageValue | cdk8s-plus-32.k8s.Quantity | averageValue is the target value of the average of the metric across all relevant pods (as a quantity). | | value | cdk8s-plus-32.k8s.Quantity | value is the target value of the metric (as a quantity). | --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string type represents whether the metric type is Utilization, Value, or AverageValue. --- ##### `averageUtilization`^Optional ```typescript public readonly averageUtilization: number; ``` - *Type:* number averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type --- ##### `averageValue`^Optional ```typescript public readonly averageValue: Quantity; ``` - *Type:* cdk8s-plus-32.k8s.Quantity averageValue is the target value of the average of the metric across all relevant pods (as a quantity). --- ##### `value`^Optional ```typescript public readonly value: Quantity; ``` - *Type:* cdk8s-plus-32.k8s.Quantity value is the target value of the metric (as a quantity). --- ### MountOptions Options for mounts. #### Initializer ```typescript import { MountOptions } from 'cdk8s-plus-32' const mountOptions: MountOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | propagation | MountPropagation | Determines how mounts are propagated from the host to container and the other way around. | | readOnly | boolean | Mounted read-only if true, read-write otherwise (false or unspecified). | | subPath | string | Path within the volume from which the container's volume should be mounted.). | | subPathExpr | string | Expanded path within the volume from which the container's volume should be mounted. | --- ##### `propagation`^Optional ```typescript public readonly propagation: MountPropagation; ``` - *Type:* MountPropagation - *Default:* MountPropagation.NONE Determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. Mount propagation allows for sharing volumes mounted by a Container to other Containers in the same Pod, or even to other Pods on the same node. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. --- ##### `subPath`^Optional ```typescript public readonly subPath: string; ``` - *Type:* string - *Default:* "" the volume's root Path within the volume from which the container's volume should be mounted.). --- ##### `subPathExpr`^Optional ```typescript public readonly subPathExpr: string; ``` - *Type:* string - *Default:* "" volume's root. Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). `subPathExpr` and `subPath` are mutually exclusive. --- ### MutatingAdmissionPolicyBindingSpecV1Alpha1 MutatingAdmissionPolicyBindingSpec is the specification of the MutatingAdmissionPolicyBinding. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const mutatingAdmissionPolicyBindingSpecV1Alpha1: k8s.MutatingAdmissionPolicyBindingSpecV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | matchResources | cdk8s-plus-32.k8s.MatchResourcesV1Alpha1 | matchResources limits what resources match this binding and may be mutated by it. | | paramRef | cdk8s-plus-32.k8s.ParamRefV1Alpha1 | paramRef specifies the parameter resource used to configure the admission control policy. | | policyName | string | policyName references a MutatingAdmissionPolicy name which the MutatingAdmissionPolicyBinding binds to. | --- ##### `matchResources`^Optional ```typescript public readonly matchResources: MatchResourcesV1Alpha1; ``` - *Type:* cdk8s-plus-32.k8s.MatchResourcesV1Alpha1 matchResources limits what resources match this binding and may be mutated by it. Note that if matchResources matches a resource, the resource must also match a policy's matchConstraints and matchConditions before the resource may be mutated. When matchResources is unset, it does not constrain resource matching, and only the policy's matchConstraints and matchConditions must match for the resource to be mutated. Additionally, matchResources.resourceRules are optional and do not constraint matching when unset. Note that this is differs from MutatingAdmissionPolicy matchConstraints, where resourceRules are required. The CREATE, UPDATE and CONNECT operations are allowed. The DELETE operation may not be matched. '*' matches CREATE, UPDATE and CONNECT. --- ##### `paramRef`^Optional ```typescript public readonly paramRef: ParamRefV1Alpha1; ``` - *Type:* cdk8s-plus-32.k8s.ParamRefV1Alpha1 paramRef specifies the parameter resource used to configure the admission control policy. It should point to a resource of the type specified in spec.ParamKind of the bound MutatingAdmissionPolicy. If the policy specifies a ParamKind and the resource referred to by ParamRef does not exist, this binding is considered mis-configured and the FailurePolicy of the MutatingAdmissionPolicy applied. If the policy does not specify a ParamKind then this field is ignored, and the rules are evaluated without a param. --- ##### `policyName`^Optional ```typescript public readonly policyName: string; ``` - *Type:* string policyName references a MutatingAdmissionPolicy name which the MutatingAdmissionPolicyBinding binds to. If the referenced resource does not exist, this binding is considered invalid and will be ignored Required. --- ### MutatingAdmissionPolicySpecV1Alpha1 MutatingAdmissionPolicySpec is the specification of the desired behavior of the admission policy. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const mutatingAdmissionPolicySpecV1Alpha1: k8s.MutatingAdmissionPolicySpecV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | failurePolicy | string | failurePolicy defines how to handle failures for the admission policy. | | matchConditions | cdk8s-plus-32.k8s.MatchConditionV1Alpha1[] | matchConditions is a list of conditions that must be met for a request to be validated. | | matchConstraints | cdk8s-plus-32.k8s.MatchResourcesV1Alpha1 | matchConstraints specifies what resources this policy is designed to validate. | | mutations | cdk8s-plus-32.k8s.MutationV1Alpha1[] | mutations contain operations to perform on matching objects. | | paramKind | cdk8s-plus-32.k8s.ParamKindV1Alpha1 | paramKind specifies the kind of resources used to parameterize this policy. | | reinvocationPolicy | string | reinvocationPolicy indicates whether mutations may be called multiple times per MutatingAdmissionPolicyBinding as part of a single admission evaluation. | | variables | cdk8s-plus-32.k8s.VariableV1Alpha1[] | variables contain definitions of variables that can be used in composition of other expressions. | --- ##### `failurePolicy`^Optional ```typescript public readonly failurePolicy: string; ``` - *Type:* string - *Default:* Fail. failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions or bindings. A policy is invalid if paramKind refers to a non-existent Kind. A binding is invalid if paramRef.name refers to a non-existent resource. failurePolicy does not define how validations that evaluate to false are handled. Allowed values are Ignore or Fail. Defaults to Fail. --- ##### `matchConditions`^Optional ```typescript public readonly matchConditions: MatchConditionV1Alpha1[]; ``` - *Type:* cdk8s-plus-32.k8s.MatchConditionV1Alpha1[] matchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the matchConstraints. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed. If a parameter object is provided, it can be accessed via the `params` handle in the same manner as validation expressions. The exact matching logic is (in order): 1. If ANY matchCondition evaluates to FALSE, the policy is skipped. 2. If ALL matchConditions evaluate to TRUE, the policy is evaluated. 3. If any matchCondition evaluates to an error (but none are FALSE): - If failurePolicy=Fail, reject the request - If failurePolicy=Ignore, the policy is skipped --- ##### `matchConstraints`^Optional ```typescript public readonly matchConstraints: MatchResourcesV1Alpha1; ``` - *Type:* cdk8s-plus-32.k8s.MatchResourcesV1Alpha1 matchConstraints specifies what resources this policy is designed to validate. The MutatingAdmissionPolicy cares about a request if it matches _all_ Constraints. However, in order to prevent clusters from being put into an unstable state that cannot be recovered from via the API MutatingAdmissionPolicy cannot match MutatingAdmissionPolicy and MutatingAdmissionPolicyBinding. The CREATE, UPDATE and CONNECT operations are allowed. The DELETE operation may not be matched. '*' matches CREATE, UPDATE and CONNECT. Required. --- ##### `mutations`^Optional ```typescript public readonly mutations: MutationV1Alpha1[]; ``` - *Type:* cdk8s-plus-32.k8s.MutationV1Alpha1[] mutations contain operations to perform on matching objects. mutations may not be empty; a minimum of one mutation is required. mutations are evaluated in order, and are reinvoked according to the reinvocationPolicy. The mutations of a policy are invoked for each binding of this policy and reinvocation of mutations occurs on a per binding basis. --- ##### `paramKind`^Optional ```typescript public readonly paramKind: ParamKindV1Alpha1; ``` - *Type:* cdk8s-plus-32.k8s.ParamKindV1Alpha1 paramKind specifies the kind of resources used to parameterize this policy. If absent, there are no parameters for this policy and the param CEL variable will not be provided to validation expressions. If paramKind refers to a non-existent kind, this policy definition is mis-configured and the FailurePolicy is applied. If paramKind is specified but paramRef is unset in MutatingAdmissionPolicyBinding, the params variable will be null. --- ##### `reinvocationPolicy`^Optional ```typescript public readonly reinvocationPolicy: string; ``` - *Type:* string reinvocationPolicy indicates whether mutations may be called multiple times per MutatingAdmissionPolicyBinding as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". Never: These mutations will not be called more than once per binding in a single admission evaluation. IfNeeded: These mutations may be invoked more than once per binding for a single admission request and there is no guarantee of order with respect to other admission plugins, admission webhooks, bindings of this policy and admission policies. Mutations are only reinvoked when mutations change the object after this mutation is invoked. Required. --- ##### `variables`^Optional ```typescript public readonly variables: VariableV1Alpha1[]; ``` - *Type:* cdk8s-plus-32.k8s.VariableV1Alpha1[] variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under `variables` in other expressions of the policy except matchConditions because matchConditions are evaluated before the rest of the policy. The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, variables must be sorted by the order of first appearance and acyclic. --- ### MutatingWebhook MutatingWebhook describes an admission webhook and the resources and operations it applies to. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const mutatingWebhook: k8s.MutatingWebhook = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | admissionReviewVersions | string[] | AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. | | clientConfig | cdk8s-plus-32.k8s.WebhookClientConfig | ClientConfig defines how to communicate with the hook. | | name | string | The name of the admission webhook. | | sideEffects | string | SideEffects states whether this webhook has side effects. | | failurePolicy | string | FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. | | matchConditions | cdk8s-plus-32.k8s.MatchCondition[] | MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. | | matchPolicy | string | matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". | | namespaceSelector | cdk8s-plus-32.k8s.LabelSelector | NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. | | objectSelector | cdk8s-plus-32.k8s.LabelSelector | ObjectSelector decides whether to run the webhook based on if the object has matching labels. | | reinvocationPolicy | string | reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. | | rules | cdk8s-plus-32.k8s.RuleWithOperations[] | Rules describes what operations on what resources/subresources the webhook cares about. | | timeoutSeconds | number | TimeoutSeconds specifies the timeout for this webhook. | --- ##### `admissionReviewVersions`^Required ```typescript public readonly admissionReviewVersions: string[]; ``` - *Type:* string[] AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. --- ##### `clientConfig`^Required ```typescript public readonly clientConfig: WebhookClientConfig; ``` - *Type:* cdk8s-plus-32.k8s.WebhookClientConfig ClientConfig defines how to communicate with the hook. Required --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. --- ##### `sideEffects`^Required ```typescript public readonly sideEffects: string; ``` - *Type:* string SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. --- ##### `failurePolicy`^Optional ```typescript public readonly failurePolicy: string; ``` - *Type:* string - *Default:* Fail. FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail. --- ##### `matchConditions`^Optional ```typescript public readonly matchConditions: MatchCondition[]; ``` - *Type:* cdk8s-plus-32.k8s.MatchCondition[] MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed. The exact matching logic is (in order): 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped. 2. If ALL matchConditions evaluate to TRUE, the webhook is called. 3. If any matchCondition evaluates to an error (but none are FALSE): - If failurePolicy=Fail, reject the request - If failurePolicy=Ignore, the error is ignored and the webhook is skipped --- ##### `matchPolicy`^Optional ```typescript public readonly matchPolicy: string; ``` - *Type:* string - *Default:* Equivalent" matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Equivalent" --- ##### `namespaceSelector`^Optional ```typescript public readonly namespaceSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector - *Default:* the empty LabelSelector, which matches everything. NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. Default to the empty LabelSelector, which matches everything. --- ##### `objectSelector`^Optional ```typescript public readonly objectSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector - *Default:* the empty LabelSelector, which matches everything. ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. --- ##### `reinvocationPolicy`^Optional ```typescript public readonly reinvocationPolicy: string; ``` - *Type:* string - *Default:* Never". reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". Never: the webhook will not be called more than once in a single admission evaluation. IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. Defaults to "Never". --- ##### `rules`^Optional ```typescript public readonly rules: RuleWithOperations[]; ``` - *Type:* cdk8s-plus-32.k8s.RuleWithOperations[] Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. --- ##### `timeoutSeconds`^Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* 10 seconds. TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. --- ### MutationV1Alpha1 Mutation specifies the CEL expression which is used to apply the Mutation. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const mutationV1Alpha1: k8s.MutationV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | patchType | string | patchType indicates the patch strategy used. | | applyConfiguration | cdk8s-plus-32.k8s.ApplyConfigurationV1Alpha1 | applyConfiguration defines the desired configuration values of an object. | | jsonPatch | cdk8s-plus-32.k8s.JsonPatchV1Alpha1 | jsonPatch defines a [JSON patch](https://jsonpatch.com/) operation to perform a mutation to the object. A CEL expression is used to create the JSON patch. | --- ##### `patchType`^Required ```typescript public readonly patchType: string; ``` - *Type:* string patchType indicates the patch strategy used. Allowed values are "ApplyConfiguration" and "JSONPatch". Required. --- ##### `applyConfiguration`^Optional ```typescript public readonly applyConfiguration: ApplyConfigurationV1Alpha1; ``` - *Type:* cdk8s-plus-32.k8s.ApplyConfigurationV1Alpha1 applyConfiguration defines the desired configuration values of an object. The configuration is applied to the admission object using [structured merge diff](https://github.com/kubernetes-sigs/structured-merge-diff). A CEL expression is used to create apply configuration. --- ##### `jsonPatch`^Optional ```typescript public readonly jsonPatch: JsonPatchV1Alpha1; ``` - *Type:* cdk8s-plus-32.k8s.JsonPatchV1Alpha1 jsonPatch defines a [JSON patch](https://jsonpatch.com/) operation to perform a mutation to the object. A CEL expression is used to create the JSON patch. --- ### NamedRuleWithOperations NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const namedRuleWithOperations: k8s.NamedRuleWithOperations = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiGroups | string[] | APIGroups is the API groups the resources belong to. | | apiVersions | string[] | APIVersions is the API versions the resources belong to. | | operations | string[] | Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. | | resourceNames | string[] | ResourceNames is an optional white list of names that the rule applies to. | | resources | string[] | Resources is a list of resources this rule applies to. | | scope | string | scope specifies the scope of this rule. | --- ##### `apiGroups`^Optional ```typescript public readonly apiGroups: string[]; ``` - *Type:* string[] APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required. --- ##### `apiVersions`^Optional ```typescript public readonly apiVersions: string[]; ``` - *Type:* string[] APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required. --- ##### `operations`^Optional ```typescript public readonly operations: string[]; ``` - *Type:* string[] Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required. --- ##### `resourceNames`^Optional ```typescript public readonly resourceNames: string[]; ``` - *Type:* string[] ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. --- ##### `resources`^Optional ```typescript public readonly resources: string[]; ``` - *Type:* string[] Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '_/scale' means all scale subresources. '_/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required. --- ##### `scope`^Optional ```typescript public readonly scope: string; ``` - *Type:* string - *Default:* . scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". --- ### NamedRuleWithOperationsV1Alpha1 NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const namedRuleWithOperationsV1Alpha1: k8s.NamedRuleWithOperationsV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiGroups | string[] | APIGroups is the API groups the resources belong to. | | apiVersions | string[] | APIVersions is the API versions the resources belong to. | | operations | string[] | Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. | | resourceNames | string[] | ResourceNames is an optional white list of names that the rule applies to. | | resources | string[] | Resources is a list of resources this rule applies to. | | scope | string | scope specifies the scope of this rule. | --- ##### `apiGroups`^Optional ```typescript public readonly apiGroups: string[]; ``` - *Type:* string[] APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required. --- ##### `apiVersions`^Optional ```typescript public readonly apiVersions: string[]; ``` - *Type:* string[] APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required. --- ##### `operations`^Optional ```typescript public readonly operations: string[]; ``` - *Type:* string[] Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required. --- ##### `resourceNames`^Optional ```typescript public readonly resourceNames: string[]; ``` - *Type:* string[] ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. --- ##### `resources`^Optional ```typescript public readonly resources: string[]; ``` - *Type:* string[] Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '_/scale' means all scale subresources. '_/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required. --- ##### `scope`^Optional ```typescript public readonly scope: string; ``` - *Type:* string - *Default:* . scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". --- ### NamedRuleWithOperationsV1Beta1 NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const namedRuleWithOperationsV1Beta1: k8s.NamedRuleWithOperationsV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiGroups | string[] | APIGroups is the API groups the resources belong to. | | apiVersions | string[] | APIVersions is the API versions the resources belong to. | | operations | string[] | Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. | | resourceNames | string[] | ResourceNames is an optional white list of names that the rule applies to. | | resources | string[] | Resources is a list of resources this rule applies to. | | scope | string | scope specifies the scope of this rule. | --- ##### `apiGroups`^Optional ```typescript public readonly apiGroups: string[]; ``` - *Type:* string[] APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required. --- ##### `apiVersions`^Optional ```typescript public readonly apiVersions: string[]; ``` - *Type:* string[] APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required. --- ##### `operations`^Optional ```typescript public readonly operations: string[]; ``` - *Type:* string[] Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required. --- ##### `resourceNames`^Optional ```typescript public readonly resourceNames: string[]; ``` - *Type:* string[] ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. --- ##### `resources`^Optional ```typescript public readonly resources: string[]; ``` - *Type:* string[] Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '_/scale' means all scale subresources. '_/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required. --- ##### `scope`^Optional ```typescript public readonly scope: string; ``` - *Type:* string - *Default:* . scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". --- ### NamespaceProps Properties for `Namespace`. #### Initializer ```typescript import { NamespaceProps } from 'cdk8s-plus-32' const namespaceProps: NamespaceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ### NamespaceSelectorConfig Configuration for selecting namespaces. #### Initializer ```typescript import { NamespaceSelectorConfig } from 'cdk8s-plus-32' const namespaceSelectorConfig: NamespaceSelectorConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | labelSelector | LabelSelector | A selector to select namespaces by labels. | | names | string[] | A list of names to select namespaces by names. | --- ##### `labelSelector`^Optional ```typescript public readonly labelSelector: LabelSelector; ``` - *Type:* LabelSelector A selector to select namespaces by labels. --- ##### `names`^Optional ```typescript public readonly names: string[]; ``` - *Type:* string[] A list of names to select namespaces by names. --- ### NamespaceSpec NamespaceSpec describes the attributes on a Namespace. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const namespaceSpec: k8s.NamespaceSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | finalizers | string[] | Finalizers is an opaque list of values that must be empty to permanently remove object from storage. | --- ##### `finalizers`^Optional ```typescript public readonly finalizers: string[]; ``` - *Type:* string[] Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ --- ### NamespacesSelectOptions Options for `Namespaces.select`. #### Initializer ```typescript import { NamespacesSelectOptions } from 'cdk8s-plus-32' const namespacesSelectOptions: NamespacesSelectOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expressions | LabelExpression[] | Namespaces must satisfy these selectors. | | labels | {[ key: string ]: string} | Labels the namespaces must have. | | names | string[] | Namespaces names must be one of these. | --- ##### `expressions`^Optional ```typescript public readonly expressions: LabelExpression[]; ``` - *Type:* LabelExpression[] - *Default:* no selector requirements. Namespaces must satisfy these selectors. The selectors query labels, just like the `labels` property, but they provide a more advanced matching mechanism. --- ##### `labels`^Optional ```typescript public readonly labels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* no strict labels requirements. Labels the namespaces must have. This is equivalent to using an 'Is' selector. --- ##### `names`^Optional ```typescript public readonly names: string[]; ``` - *Type:* string[] - *Default:* no name requirements. Namespaces names must be one of these. --- ### NetworkPolicyAddEgressRuleOptions Options for `NetworkPolicy.addEgressRule`. #### Initializer ```typescript import { NetworkPolicyAddEgressRuleOptions } from 'cdk8s-plus-32' const networkPolicyAddEgressRuleOptions: NetworkPolicyAddEgressRuleOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ports | NetworkPolicyPort[] | Ports the rule should allow outgoing traffic to. | --- ##### `ports`^Optional ```typescript public readonly ports: NetworkPolicyPort[]; ``` - *Type:* NetworkPolicyPort[] - *Default:* If the peer is a managed pod, take its ports. Otherwise, all ports are allowed. Ports the rule should allow outgoing traffic to. --- ### NetworkPolicyEgressRule NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8 #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const networkPolicyEgressRule: k8s.NetworkPolicyEgressRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ports | cdk8s-plus-32.k8s.NetworkPolicyPort[] | ports is a list of destination ports for outgoing traffic. | | to | cdk8s-plus-32.k8s.NetworkPolicyPeer[] | to is a list of destinations for outgoing traffic of pods selected for this rule. | --- ##### `ports`^Optional ```typescript public readonly ports: NetworkPolicyPort[]; ``` - *Type:* cdk8s-plus-32.k8s.NetworkPolicyPort[] ports is a list of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. --- ##### `to`^Optional ```typescript public readonly to: NetworkPolicyPeer[]; ``` - *Type:* cdk8s-plus-32.k8s.NetworkPolicyPeer[] to is a list of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list. --- ### NetworkPolicyIngressRule NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const networkPolicyIngressRule: k8s.NetworkPolicyIngressRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | from | cdk8s-plus-32.k8s.NetworkPolicyPeer[] | from is a list of sources which should be able to access the pods selected for this rule. | | ports | cdk8s-plus-32.k8s.NetworkPolicyPort[] | ports is a list of ports which should be made accessible on the pods selected for this rule. | --- ##### `from`^Optional ```typescript public readonly from: NetworkPolicyPeer[]; ``` - *Type:* cdk8s-plus-32.k8s.NetworkPolicyPeer[] from is a list of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list. --- ##### `ports`^Optional ```typescript public readonly ports: NetworkPolicyPort[]; ``` - *Type:* cdk8s-plus-32.k8s.NetworkPolicyPort[] ports is a list of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. --- ### NetworkPolicyPeer NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const networkPolicyPeer: k8s.NetworkPolicyPeer = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ipBlock | cdk8s-plus-32.k8s.IpBlock | ipBlock defines policy on a particular IPBlock. | | namespaceSelector | cdk8s-plus-32.k8s.LabelSelector | namespaceSelector selects namespaces using cluster-scoped labels. | | podSelector | cdk8s-plus-32.k8s.LabelSelector | podSelector is a label selector which selects pods. | --- ##### `ipBlock`^Optional ```typescript public readonly ipBlock: IpBlock; ``` - *Type:* cdk8s-plus-32.k8s.IpBlock ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be. --- ##### `namespaceSelector`^Optional ```typescript public readonly namespaceSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector namespaceSelector selects namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. If podSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the namespaces selected by namespaceSelector. Otherwise it selects all pods in the namespaces selected by namespaceSelector. --- ##### `podSelector`^Optional ```typescript public readonly podSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector podSelector is a label selector which selects pods. This field follows standard label selector semantics; if present but empty, it selects all pods. If namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the pods matching podSelector in the policy's own namespace. --- ### NetworkPolicyPeerConfig Configuration for network peers. A peer can either by an ip block, or a selection of pods, not both. #### Initializer ```typescript import { NetworkPolicyPeerConfig } from 'cdk8s-plus-32' const networkPolicyPeerConfig: NetworkPolicyPeerConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ipBlock | NetworkPolicyIpBlock | The ip block this peer represents. | | podSelector | PodSelectorConfig | The pod selector this peer represents. | --- ##### `ipBlock`^Optional ```typescript public readonly ipBlock: NetworkPolicyIpBlock; ``` - *Type:* NetworkPolicyIpBlock The ip block this peer represents. --- ##### `podSelector`^Optional ```typescript public readonly podSelector: PodSelectorConfig; ``` - *Type:* PodSelectorConfig The pod selector this peer represents. --- ### NetworkPolicyPort NetworkPolicyPort describes a port to allow traffic on. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const networkPolicyPort: k8s.NetworkPolicyPort = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endPort | number | endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. | | port | cdk8s-plus-32.k8s.IntOrString | port represents the port on the given protocol. | | protocol | string | protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. | --- ##### `endPort`^Optional ```typescript public readonly endPort: number; ``` - *Type:* number endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. --- ##### `port`^Optional ```typescript public readonly port: IntOrString; ``` - *Type:* cdk8s-plus-32.k8s.IntOrString port represents the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched. --- ##### `protocol`^Optional ```typescript public readonly protocol: string; ``` - *Type:* string protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP. --- ### NetworkPolicyPortProps Properties for `NetworkPolicyPort`. #### Initializer ```typescript import { NetworkPolicyPortProps } from 'cdk8s-plus-32' const networkPolicyPortProps: NetworkPolicyPortProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endPort | number | End port (relative to `port`). | | port | number | Specific port number. | | protocol | NetworkProtocol | Protocol. | --- ##### `endPort`^Optional ```typescript public readonly endPort: number; ``` - *Type:* number - *Default:* not a port range. End port (relative to `port`). Only applies if `port` is defined. Use this to specify a port range, rather that a specific one. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* all ports are allowed. Specific port number. --- ##### `protocol`^Optional ```typescript public readonly protocol: NetworkProtocol; ``` - *Type:* NetworkProtocol - *Default:* NetworkProtocol.TCP Protocol. --- ### NetworkPolicyProps Properties for `NetworkPolicy`. #### Initializer ```typescript import { NetworkPolicyProps } from 'cdk8s-plus-32' const networkPolicyProps: NetworkPolicyProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | egress | NetworkPolicyTraffic | Egress traffic configuration. | | ingress | NetworkPolicyTraffic | Ingress traffic configuration. | | selector | IPodSelector | Which pods does this policy object applies to. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `egress`^Optional ```typescript public readonly egress: NetworkPolicyTraffic; ``` - *Type:* NetworkPolicyTraffic - *Default:* the policy doesn't change egress behavior of the pods it selects. Egress traffic configuration. --- ##### `ingress`^Optional ```typescript public readonly ingress: NetworkPolicyTraffic; ``` - *Type:* NetworkPolicyTraffic - *Default:* the policy doesn't change ingress behavior of the pods it selects. Ingress traffic configuration. --- ##### `selector`^Optional ```typescript public readonly selector: IPodSelector; ``` - *Type:* IPodSelector - *Default:* will select all pods in the namespace of the policy. Which pods does this policy object applies to. This can either be a single pod / workload, or a grouping of pods selected via the `Pods.select` function. Rules is applied to any pods selected by this property. Multiple network policies can select the same set of pods. In this case, the rules for each are combined additively. Note that --- ### NetworkPolicyRule Describes a rule allowing traffic from / to pods matched by a network policy selector. #### Initializer ```typescript import { NetworkPolicyRule } from 'cdk8s-plus-32' const networkPolicyRule: NetworkPolicyRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | peer | INetworkPolicyPeer | Peer this rule interacts with. | | ports | NetworkPolicyPort[] | The ports of the rule. | --- ##### `peer`^Required ```typescript public readonly peer: INetworkPolicyPeer; ``` - *Type:* INetworkPolicyPeer Peer this rule interacts with. --- ##### `ports`^Optional ```typescript public readonly ports: NetworkPolicyPort[]; ``` - *Type:* NetworkPolicyPort[] - *Default:* traffic is allowed on all ports. The ports of the rule. --- ### NetworkPolicySpec NetworkPolicySpec provides the specification of a NetworkPolicy. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const networkPolicySpec: k8s.NetworkPolicySpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | podSelector | cdk8s-plus-32.k8s.LabelSelector | podSelector selects the pods to which this NetworkPolicy object applies. | | egress | cdk8s-plus-32.k8s.NetworkPolicyEgressRule[] | egress is a list of egress rules to be applied to the selected pods. | | ingress | cdk8s-plus-32.k8s.NetworkPolicyIngressRule[] | ingress is a list of ingress rules to be applied to the selected pods. | | policyTypes | string[] | policyTypes is a list of rule types that the NetworkPolicy relates to. | --- ##### `podSelector`^Required ```typescript public readonly podSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector podSelector selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. --- ##### `egress`^Optional ```typescript public readonly egress: NetworkPolicyEgressRule[]; ``` - *Type:* cdk8s-plus-32.k8s.NetworkPolicyEgressRule[] egress is a list of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8 --- ##### `ingress`^Optional ```typescript public readonly ingress: NetworkPolicyIngressRule[]; ``` - *Type:* cdk8s-plus-32.k8s.NetworkPolicyIngressRule[] ingress is a list of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default) --- ##### `policyTypes`^Optional ```typescript public readonly policyTypes: string[]; ``` - *Type:* string[] policyTypes is a list of rule types that the NetworkPolicy relates to. Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. If this field is not specified, it will default based on the existence of ingress or egress rules; policies that contain an egress section are assumed to affect egress, and all policies (whether or not they contain an ingress section) are assumed to affect ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8 --- ### NetworkPolicyTraffic Describes how the network policy should configure egress / ingress traffic. #### Initializer ```typescript import { NetworkPolicyTraffic } from 'cdk8s-plus-32' const networkPolicyTraffic: NetworkPolicyTraffic = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | default | NetworkPolicyTrafficDefault | Specifies the default behavior of the policy when no rules are defined. | | rules | NetworkPolicyRule[] | List of rules to be applied to the selected pods. | --- ##### `default`^Optional ```typescript public readonly default: NetworkPolicyTrafficDefault; ``` - *Type:* NetworkPolicyTrafficDefault - *Default:* unset, the policy does not change the behavior. Specifies the default behavior of the policy when no rules are defined. --- ##### `rules`^Optional ```typescript public readonly rules: NetworkPolicyRule[]; ``` - *Type:* NetworkPolicyRule[] - *Default:* no rules List of rules to be applied to the selected pods. If empty, the behavior of the policy is dictated by the `default` property. --- ### NfsVolumeOptions Options for the NFS based volume. #### Initializer ```typescript import { NfsVolumeOptions } from 'cdk8s-plus-32' const nfsVolumeOptions: NfsVolumeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | string | Path that is exported by the NFS server. | | server | string | Server is the hostname or IP address of the NFS server. | | readOnly | boolean | If set to true, will force the NFS export to be mounted with read-only permissions. | --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string Path that is exported by the NFS server. --- ##### `server`^Required ```typescript public readonly server: string; ``` - *Type:* string Server is the hostname or IP address of the NFS server. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false If set to true, will force the NFS export to be mounted with read-only permissions. --- ### NfsVolumeSource Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const nfsVolumeSource: k8s.NfsVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | string | path that is exported by the NFS server. | | server | string | server is the hostname or IP address of the NFS server. | | readOnly | boolean | readOnly here will force the NFS export to be mounted with read-only permissions. | --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs --- ##### `server`^Required ```typescript public readonly server: string; ``` - *Type:* string server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs --- ### NodeAffinity Node affinity is a group of node affinity scheduling rules. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const nodeAffinity: k8s.NodeAffinity = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | preferredDuringSchedulingIgnoredDuringExecution | cdk8s-plus-32.k8s.PreferredSchedulingTerm[] | The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. | | requiredDuringSchedulingIgnoredDuringExecution | cdk8s-plus-32.k8s.NodeSelector | If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. | --- ##### `preferredDuringSchedulingIgnoredDuringExecution`^Optional ```typescript public readonly preferredDuringSchedulingIgnoredDuringExecution: PreferredSchedulingTerm[]; ``` - *Type:* cdk8s-plus-32.k8s.PreferredSchedulingTerm[] The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. --- ##### `requiredDuringSchedulingIgnoredDuringExecution`^Optional ```typescript public readonly requiredDuringSchedulingIgnoredDuringExecution: NodeSelector; ``` - *Type:* cdk8s-plus-32.k8s.NodeSelector If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. --- ### NodeConfigSource NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const nodeConfigSource: k8s.NodeConfigSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configMap | cdk8s-plus-32.k8s.ConfigMapNodeConfigSource | ConfigMap is a reference to a Node's ConfigMap. | --- ##### `configMap`^Optional ```typescript public readonly configMap: ConfigMapNodeConfigSource; ``` - *Type:* cdk8s-plus-32.k8s.ConfigMapNodeConfigSource ConfigMap is a reference to a Node's ConfigMap. --- ### NodeSelector A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const nodeSelector: k8s.NodeSelector = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nodeSelectorTerms | cdk8s-plus-32.k8s.NodeSelectorTerm[] | Required. | --- ##### `nodeSelectorTerms`^Required ```typescript public readonly nodeSelectorTerms: NodeSelectorTerm[]; ``` - *Type:* cdk8s-plus-32.k8s.NodeSelectorTerm[] Required. A list of node selector terms. The terms are ORed. --- ### NodeSelectorRequirement A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const nodeSelectorRequirement: k8s.NodeSelectorRequirement = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | The label key that the selector applies to. | | operator | string | Represents a key's relationship to a set of values. | | values | string[] | An array of string values. | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string The label key that the selector applies to. --- ##### `operator`^Required ```typescript public readonly operator: string; ``` - *Type:* string Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. --- ##### `values`^Optional ```typescript public readonly values: string[]; ``` - *Type:* string[] An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. --- ### NodeSelectorTerm A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const nodeSelectorTerm: k8s.NodeSelectorTerm = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | matchExpressions | cdk8s-plus-32.k8s.NodeSelectorRequirement[] | A list of node selector requirements by node's labels. | | matchFields | cdk8s-plus-32.k8s.NodeSelectorRequirement[] | A list of node selector requirements by node's fields. | --- ##### `matchExpressions`^Optional ```typescript public readonly matchExpressions: NodeSelectorRequirement[]; ``` - *Type:* cdk8s-plus-32.k8s.NodeSelectorRequirement[] A list of node selector requirements by node's labels. --- ##### `matchFields`^Optional ```typescript public readonly matchFields: NodeSelectorRequirement[]; ``` - *Type:* cdk8s-plus-32.k8s.NodeSelectorRequirement[] A list of node selector requirements by node's fields. --- ### NodeSpec NodeSpec describes the attributes that a node is created with. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const nodeSpec: k8s.NodeSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configSource | cdk8s-plus-32.k8s.NodeConfigSource | Deprecated: Previously used to specify the source of the node's configuration for the DynamicKubeletConfig feature. | | externalId | string | Deprecated. | | podCidr | string | PodCIDR represents the pod IP range assigned to the node. | | podCidRs | string[] | podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. | | providerId | string | ID of the node assigned by the cloud provider in the format: ://. | | taints | cdk8s-plus-32.k8s.Taint[] | If specified, the node's taints. | | unschedulable | boolean | Unschedulable controls node schedulability of new pods. | --- ##### `configSource`^Optional ```typescript public readonly configSource: NodeConfigSource; ``` - *Type:* cdk8s-plus-32.k8s.NodeConfigSource Deprecated: Previously used to specify the source of the node's configuration for the DynamicKubeletConfig feature. This feature is removed. --- ##### `externalId`^Optional ```typescript public readonly externalId: string; ``` - *Type:* string Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 --- ##### `podCidr`^Optional ```typescript public readonly podCidr: string; ``` - *Type:* string PodCIDR represents the pod IP range assigned to the node. --- ##### `podCidRs`^Optional ```typescript public readonly podCidRs: string[]; ``` - *Type:* string[] podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6. --- ##### `providerId`^Optional ```typescript public readonly providerId: string; ``` - *Type:* string ID of the node assigned by the cloud provider in the format: ://. --- ##### `taints`^Optional ```typescript public readonly taints: Taint[]; ``` - *Type:* cdk8s-plus-32.k8s.Taint[] If specified, the node's taints. --- ##### `unschedulable`^Optional ```typescript public readonly unschedulable: boolean; ``` - *Type:* boolean Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration --- ### NodeTaintQueryOptions Options for `NodeTaintQuery`. #### Initializer ```typescript import { NodeTaintQueryOptions } from 'cdk8s-plus-32' const nodeTaintQueryOptions: NodeTaintQueryOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | effect | TaintEffect | The taint effect to match. | | evictAfter | cdk8s.Duration | How much time should a pod that tolerates the `NO_EXECUTE` effect be bound to the node. | --- ##### `effect`^Optional ```typescript public readonly effect: TaintEffect; ``` - *Type:* TaintEffect - *Default:* all effects are matched. The taint effect to match. --- ##### `evictAfter`^Optional ```typescript public readonly evictAfter: Duration; ``` - *Type:* cdk8s.Duration - *Default:* bound forever. How much time should a pod that tolerates the `NO_EXECUTE` effect be bound to the node. Only applies for the `NO_EXECUTE` effect. --- ### NonResourceAttributes NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const nonResourceAttributes: k8s.NonResourceAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | string | Path is the URL path of the request. | | verb | string | Verb is the standard HTTP verb. | --- ##### `path`^Optional ```typescript public readonly path: string; ``` - *Type:* string Path is the URL path of the request. --- ##### `verb`^Optional ```typescript public readonly verb: string; ``` - *Type:* string Verb is the standard HTTP verb. --- ### NonResourcePolicyRule NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const nonResourcePolicyRule: k8s.NonResourcePolicyRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nonResourceUrLs | string[] | `nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. | | verbs | string[] | `verbs` is a list of matching verbs and may not be empty. | --- ##### `nonResourceUrLs`^Required ```typescript public readonly nonResourceUrLs: string[]; ``` - *Type:* string[] `nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example: - "/healthz" is legal - "/hea*" is illegal - "/hea" is legal but matches nothing - "/hea/*" also matches nothing - "/healthz/*" matches all per-component health checks. "*" matches all non-resource urls. if it is present, it must be the only entry. Required. --- ##### `verbs`^Required ```typescript public readonly verbs: string[]; ``` - *Type:* string[] `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required. --- ### ObjectFieldSelector ObjectFieldSelector selects an APIVersioned field of an object. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const objectFieldSelector: k8s.ObjectFieldSelector = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fieldPath | string | Path of the field to select in the specified API version. | | apiVersion | string | Version of the schema the FieldPath is written in terms of, defaults to "v1". | --- ##### `fieldPath`^Required ```typescript public readonly fieldPath: string; ``` - *Type:* string Path of the field to select in the specified API version. --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string Version of the schema the FieldPath is written in terms of, defaults to "v1". --- ### ObjectMeta ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const objectMeta: k8s.ObjectMeta = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | annotations | {[ key: string ]: string} | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. | | creationTimestamp | Date | CreationTimestamp is a timestamp representing the server time when this object was created. | | deletionGracePeriodSeconds | number | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. | | deletionTimestamp | Date | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. | | finalizers | string[] | Must be empty before the object is deleted from the registry. | | generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. | | generation | number | A sequence number representing a specific generation of the desired state. | | labels | {[ key: string ]: string} | Map of string keys and values that can be used to organize and categorize (scope and select) objects. | | managedFields | cdk8s-plus-32.k8s.ManagedFieldsEntry[] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. | | name | string | Name must be unique within a namespace. | | namespace | string | Namespace defines the space within which each name must be unique. | | ownerReferences | cdk8s-plus-32.k8s.OwnerReference[] | List of objects depended by this object. | | resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. | | selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | | uid | string | UID is the unique in time and space value for this object. | --- ##### `annotations`^Optional ```typescript public readonly annotations: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations --- ##### `creationTimestamp`^Optional ```typescript public readonly creationTimestamp: Date; ``` - *Type:* Date CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `deletionGracePeriodSeconds`^Optional ```typescript public readonly deletionGracePeriodSeconds: number; ``` - *Type:* number Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. --- ##### `deletionTimestamp`^Optional ```typescript public readonly deletionTimestamp: Date; ``` - *Type:* Date DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `finalizers`^Optional ```typescript public readonly finalizers: string[]; ``` - *Type:* string[] Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. --- ##### `generateName`^Optional ```typescript public readonly generateName: string; ``` - *Type:* string GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency --- ##### `generation`^Optional ```typescript public readonly generation: number; ``` - *Type:* number A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. --- ##### `labels`^Optional ```typescript public readonly labels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels --- ##### `managedFields`^Optional ```typescript public readonly managedFields: ManagedFieldsEntry[]; ``` - *Type:* cdk8s-plus-32.k8s.ManagedFieldsEntry[] ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces --- ##### `ownerReferences`^Optional ```typescript public readonly ownerReferences: OwnerReference[]; ``` - *Type:* cdk8s-plus-32.k8s.OwnerReference[] List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. --- ##### `resourceVersion`^Optional ```typescript public readonly resourceVersion: string; ``` - *Type:* string An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency --- ##### `selfLink`^Optional ```typescript public readonly selfLink: string; ``` - *Type:* string Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. --- ##### `uid`^Optional ```typescript public readonly uid: string; ``` - *Type:* string UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids --- ### ObjectMetricSourceV2 ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object). #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const objectMetricSourceV2: k8s.ObjectMetricSourceV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | describedObject | cdk8s-plus-32.k8s.CrossVersionObjectReferenceV2 | describedObject specifies the descriptions of a object,such as kind,name apiVersion. | | metric | cdk8s-plus-32.k8s.MetricIdentifierV2 | metric identifies the target metric by name and selector. | | target | cdk8s-plus-32.k8s.MetricTargetV2 | target specifies the target value for the given metric. | --- ##### `describedObject`^Required ```typescript public readonly describedObject: CrossVersionObjectReferenceV2; ``` - *Type:* cdk8s-plus-32.k8s.CrossVersionObjectReferenceV2 describedObject specifies the descriptions of a object,such as kind,name apiVersion. --- ##### `metric`^Required ```typescript public readonly metric: MetricIdentifierV2; ``` - *Type:* cdk8s-plus-32.k8s.MetricIdentifierV2 metric identifies the target metric by name and selector. --- ##### `target`^Required ```typescript public readonly target: MetricTargetV2; ``` - *Type:* cdk8s-plus-32.k8s.MetricTargetV2 target specifies the target value for the given metric. --- ### ObjectReference ObjectReference contains enough information to let you inspect or modify the referred object. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const objectReference: k8s.ObjectReference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | API version of the referent. | | fieldPath | string | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. | | kind | string | Kind of the referent. | | name | string | Name of the referent. | | namespace | string | Namespace of the referent. | | resourceVersion | string | Specific resourceVersion to which this reference is made, if any. | | uid | string | UID of the referent. | --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string API version of the referent. --- ##### `fieldPath`^Optional ```typescript public readonly fieldPath: string; ``` - *Type:* string If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. --- ##### `kind`^Optional ```typescript public readonly kind: string; ``` - *Type:* string Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ --- ##### `resourceVersion`^Optional ```typescript public readonly resourceVersion: string; ``` - *Type:* string Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency --- ##### `uid`^Optional ```typescript public readonly uid: string; ``` - *Type:* string UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids --- ### OpaqueDeviceConfigurationV1Alpha3 OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const opaqueDeviceConfigurationV1Alpha3: k8s.OpaqueDeviceConfigurationV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | driver | string | Driver is used to determine which kubelet plugin needs to be passed these configuration parameters. | | parameters | any | Parameters can contain arbitrary data. | --- ##### `driver`^Required ```typescript public readonly driver: string; ``` - *Type:* string Driver is used to determine which kubelet plugin needs to be passed these configuration parameters. An admission policy provided by the driver developer could use this to decide whether it needs to validate them. Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver. --- ##### `parameters`^Required ```typescript public readonly parameters: any; ``` - *Type:* any Parameters can contain arbitrary data. It is the responsibility of the driver developer to handle validation and versioning. Typically this includes self-identification and a version ("kind" + "apiVersion" for Kubernetes types), with conversion between different versions. The length of the raw data must be smaller or equal to 10 Ki. --- ### OpaqueDeviceConfigurationV1Beta1 OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const opaqueDeviceConfigurationV1Beta1: k8s.OpaqueDeviceConfigurationV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | driver | string | Driver is used to determine which kubelet plugin needs to be passed these configuration parameters. | | parameters | any | Parameters can contain arbitrary data. | --- ##### `driver`^Required ```typescript public readonly driver: string; ``` - *Type:* string Driver is used to determine which kubelet plugin needs to be passed these configuration parameters. An admission policy provided by the driver developer could use this to decide whether it needs to validate them. Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver. --- ##### `parameters`^Required ```typescript public readonly parameters: any; ``` - *Type:* any Parameters can contain arbitrary data. It is the responsibility of the driver developer to handle validation and versioning. Typically this includes self-identification and a version ("kind" + "apiVersion" for Kubernetes types), with conversion between different versions. The length of the raw data must be smaller or equal to 10 Ki. --- ### Overhead Overhead structure represents the resource overhead associated with running a pod. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const overhead: k8s.Overhead = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | podFixed | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | podFixed represents the fixed resource overhead associated with running a pod. | --- ##### `podFixed`^Optional ```typescript public readonly podFixed: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} podFixed represents the fixed resource overhead associated with running a pod. --- ### OwnerReference OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ownerReference: k8s.OwnerReference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | API version of the referent. | | kind | string | Kind of the referent. | | name | string | Name of the referent. | | uid | string | UID of the referent. | | blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. | | controller | boolean | If true, this reference points to the managing controller. | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string API version of the referent. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names --- ##### `uid`^Required ```typescript public readonly uid: string; ``` - *Type:* string UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids --- ##### `blockOwnerDeletion`^Optional ```typescript public readonly blockOwnerDeletion: boolean; ``` - *Type:* boolean - *Default:* false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. --- ##### `controller`^Optional ```typescript public readonly controller: boolean; ``` - *Type:* boolean If true, this reference points to the managing controller. --- ### ParamKind ParamKind is a tuple of Group Kind and Version. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const paramKind: k8s.ParamKind = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | APIVersion is the API group version the resources belong to. | | kind | string | Kind is the API kind the resources belong to. | --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string APIVersion is the API group version the resources belong to. In format of "group/version". Required. --- ##### `kind`^Optional ```typescript public readonly kind: string; ``` - *Type:* string Kind is the API kind the resources belong to. Required. --- ### ParamKindV1Alpha1 ParamKind is a tuple of Group Kind and Version. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const paramKindV1Alpha1: k8s.ParamKindV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | APIVersion is the API group version the resources belong to. | | kind | string | Kind is the API kind the resources belong to. | --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string APIVersion is the API group version the resources belong to. In format of "group/version". Required. --- ##### `kind`^Optional ```typescript public readonly kind: string; ``` - *Type:* string Kind is the API kind the resources belong to. Required. --- ### ParamKindV1Beta1 ParamKind is a tuple of Group Kind and Version. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const paramKindV1Beta1: k8s.ParamKindV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | APIVersion is the API group version the resources belong to. | | kind | string | Kind is the API kind the resources belong to. | --- ##### `apiVersion`^Optional ```typescript public readonly apiVersion: string; ``` - *Type:* string APIVersion is the API group version the resources belong to. In format of "group/version". Required. --- ##### `kind`^Optional ```typescript public readonly kind: string; ``` - *Type:* string Kind is the API kind the resources belong to. Required. --- ### ParamRef ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const paramRef: k8s.ParamRef = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | name is the name of the resource being referenced. | | namespace | string | namespace is the namespace of the referenced resource. | | parameterNotFoundAction | string | `parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. | | selector | cdk8s-plus-32.k8s.LabelSelector | selector can be used to match multiple param objects based on their labels. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string name is the name of the resource being referenced. One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset. A single parameter used for all admission requests can be configured by setting the `name` field, leaving `selector` blank, and setting namespace if `paramKind` is namespace-scoped. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both `name` and `selector` fields. A per-namespace parameter may be used by specifying a namespace-scoped `paramKind` in the policy and leaving this field empty. - If `paramKind` is cluster-scoped, this field MUST be unset. Setting this field results in a configuration error. - If `paramKind` is namespace-scoped, the namespace of the object being evaluated for admission will be used when this field is left unset. Take care that if this is left empty the binding must not match any cluster-scoped resources, which will result in an error. --- ##### `parameterNotFoundAction`^Optional ```typescript public readonly parameterNotFoundAction: string; ``` - *Type:* string `parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to `Allow`, then no matched parameters will be treated as successful validation by the binding. If set to `Deny`, then no matched parameters will be subject to the `failurePolicy` of the policy. Allowed values are `Allow` or `Deny` Required --- ##### `selector`^Optional ```typescript public readonly selector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector selector can be used to match multiple param objects based on their labels. Supply selector: {} to match all resources of the ParamKind. If multiple params are found, they are all evaluated with the policy expressions and the results are ANDed together. One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset. --- ### ParamRefV1Alpha1 ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const paramRefV1Alpha1: k8s.ParamRefV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | `name` is the name of the resource being referenced. | | namespace | string | namespace is the namespace of the referenced resource. | | parameterNotFoundAction | string | `parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. | | selector | cdk8s-plus-32.k8s.LabelSelector | selector can be used to match multiple param objects based on their labels. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string `name` is the name of the resource being referenced. `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both `name` and `selector` fields. A per-namespace parameter may be used by specifying a namespace-scoped `paramKind` in the policy and leaving this field empty. - If `paramKind` is cluster-scoped, this field MUST be unset. Setting this field results in a configuration error. - If `paramKind` is namespace-scoped, the namespace of the object being evaluated for admission will be used when this field is left unset. Take care that if this is left empty the binding must not match any cluster-scoped resources, which will result in an error. --- ##### `parameterNotFoundAction`^Optional ```typescript public readonly parameterNotFoundAction: string; ``` - *Type:* string - *Default:* Deny` `parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to `Allow`, then no matched parameters will be treated as successful validation by the binding. If set to `Deny`, then no matched parameters will be subject to the `failurePolicy` of the policy. Allowed values are `Allow` or `Deny` Default to `Deny` --- ##### `selector`^Optional ```typescript public readonly selector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector selector can be used to match multiple param objects based on their labels. Supply selector: {} to match all resources of the ParamKind. If multiple params are found, they are all evaluated with the policy expressions and the results are ANDed together. One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset. --- ### ParamRefV1Beta1 ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const paramRefV1Beta1: k8s.ParamRefV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | name is the name of the resource being referenced. | | namespace | string | namespace is the namespace of the referenced resource. | | parameterNotFoundAction | string | `parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. | | selector | cdk8s-plus-32.k8s.LabelSelector | selector can be used to match multiple param objects based on their labels. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string name is the name of the resource being referenced. One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset. A single parameter used for all admission requests can be configured by setting the `name` field, leaving `selector` blank, and setting namespace if `paramKind` is namespace-scoped. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both `name` and `selector` fields. A per-namespace parameter may be used by specifying a namespace-scoped `paramKind` in the policy and leaving this field empty. - If `paramKind` is cluster-scoped, this field MUST be unset. Setting this field results in a configuration error. - If `paramKind` is namespace-scoped, the namespace of the object being evaluated for admission will be used when this field is left unset. Take care that if this is left empty the binding must not match any cluster-scoped resources, which will result in an error. --- ##### `parameterNotFoundAction`^Optional ```typescript public readonly parameterNotFoundAction: string; ``` - *Type:* string `parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to `Allow`, then no matched parameters will be treated as successful validation by the binding. If set to `Deny`, then no matched parameters will be subject to the `failurePolicy` of the policy. Allowed values are `Allow` or `Deny` Required --- ##### `selector`^Optional ```typescript public readonly selector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector selector can be used to match multiple param objects based on their labels. Supply selector: {} to match all resources of the ParamKind. If multiple params are found, they are all evaluated with the policy expressions and the results are ANDed together. One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset. --- ### ParentReferenceV1Beta1 ParentReference describes a reference to a parent object. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const parentReferenceV1Beta1: k8s.ParentReferenceV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name is the name of the object being referenced. | | resource | string | Resource is the resource of the object being referenced. | | group | string | Group is the group of the object being referenced. | | namespace | string | Namespace is the namespace of the object being referenced. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is the name of the object being referenced. --- ##### `resource`^Required ```typescript public readonly resource: string; ``` - *Type:* string Resource is the resource of the object being referenced. --- ##### `group`^Optional ```typescript public readonly group: string; ``` - *Type:* string Group is the group of the object being referenced. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string Namespace is the namespace of the object being referenced. --- ### PathMapping Maps a string key to a path within a volume. #### Initializer ```typescript import { PathMapping } from 'cdk8s-plus-32' const pathMapping: PathMapping = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | string | The relative path of the file to map the key to. | | mode | number | Optional: mode bits to use on this file, must be a value between 0 and 0777. | --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. --- ##### `mode`^Optional ```typescript public readonly mode: number; ``` - *Type:* number Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. --- ### PersistentVolumeClaimProps Properties for `PersistentVolumeClaim`. #### Initializer ```typescript import { PersistentVolumeClaimProps } from 'cdk8s-plus-32' const persistentVolumeClaimProps: PersistentVolumeClaimProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | PersistentVolumeAccessMode[] | Contains the access modes the volume should support. | | storage | cdk8s.Size | Minimum storage size the volume should have. | | storageClassName | string | Name of the StorageClass required by the claim. When this property is not set, the behavior is as follows:. | | volume | IPersistentVolume | The PersistentVolume backing this claim. | | volumeMode | PersistentVolumeMode | Defines what type of volume is required by the claim. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* PersistentVolumeAccessMode[] - *Default:* No access modes requirement. Contains the access modes the volume should support. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1](https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1) --- ##### `storage`^Optional ```typescript public readonly storage: Size; ``` - *Type:* cdk8s.Size - *Default:* No storage requirement. Minimum storage size the volume should have. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources](https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources) --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string - *Default:* Not set. Name of the StorageClass required by the claim. When this property is not set, the behavior is as follows:. If the admission plugin is turned on, the storage class marked as default will be used. - If the admission plugin is turned off, the pvc can only be bound to volumes without a storage class. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1](https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1) --- ##### `volume`^Optional ```typescript public readonly volume: IPersistentVolume; ``` - *Type:* IPersistentVolume - *Default:* No specific volume binding. The PersistentVolume backing this claim. The control plane still checks that storage class, access modes, and requested storage size on the volume are valid. Note that in order to guarantee a proper binding, the volume should also define a `claimRef` referring to this claim. Otherwise, the volume may be claimed be other pvc's before it gets a chance to bind to this one. If the volume is managed (i.e not imported), you can use `pv.claim()` to easily create a bi-directional bounded claim. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding.](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding.) --- ##### `volumeMode`^Optional ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ### PersistentVolumeClaimSpec PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const persistentVolumeClaimSpec: k8s.PersistentVolumeClaimSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessModes | string[] | accessModes contains the desired access modes the volume should have. | | dataSource | cdk8s-plus-32.k8s.TypedLocalObjectReference | dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource. | | dataSourceRef | cdk8s-plus-32.k8s.TypedObjectReference | dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. | | resources | cdk8s-plus-32.k8s.VolumeResourceRequirements | resources represents the minimum resources the volume should have. | | selector | cdk8s-plus-32.k8s.LabelSelector | selector is a label query over volumes to consider for binding. | | storageClassName | string | storageClassName is the name of the StorageClass required by the claim. | | volumeAttributesClassName | string | volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. | | volumeMode | string | volumeMode defines what type of volume is required by the claim. | | volumeName | string | volumeName is the binding reference to the PersistentVolume backing this claim. | --- ##### `accessModes`^Optional ```typescript public readonly accessModes: string[]; ``` - *Type:* string[] accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 --- ##### `dataSource`^Optional ```typescript public readonly dataSource: TypedLocalObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.TypedLocalObjectReference dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource. --- ##### `dataSourceRef`^Optional ```typescript public readonly dataSourceRef: TypedObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.TypedObjectReference dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. --- ##### `resources`^Optional ```typescript public readonly resources: VolumeResourceRequirements; ``` - *Type:* cdk8s-plus-32.k8s.VolumeResourceRequirements resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources --- ##### `selector`^Optional ```typescript public readonly selector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector selector is a label query over volumes to consider for binding. --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 --- ##### `volumeAttributesClassName`^Optional ```typescript public readonly volumeAttributesClassName: string; ``` - *Type:* string volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). --- ##### `volumeMode`^Optional ```typescript public readonly volumeMode: string; ``` - *Type:* string volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. --- ##### `volumeName`^Optional ```typescript public readonly volumeName: string; ``` - *Type:* string volumeName is the binding reference to the PersistentVolume backing this claim. --- ### PersistentVolumeClaimTemplate PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const persistentVolumeClaimTemplate: k8s.PersistentVolumeClaimTemplate = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.PersistentVolumeClaimSpec | The specification for the PersistentVolumeClaim. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | May contain labels and annotations that will be copied into the PVC when creating it. | --- ##### `spec`^Required ```typescript public readonly spec: PersistentVolumeClaimSpec; ``` - *Type:* cdk8s-plus-32.k8s.PersistentVolumeClaimSpec The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. --- ### PersistentVolumeClaimTemplateProps A PersistentVolumeClaim template for StatefulSets. #### Initializer ```typescript import { PersistentVolumeClaimTemplateProps } from 'cdk8s-plus-32' const persistentVolumeClaimTemplateProps: PersistentVolumeClaimTemplateProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | PersistentVolumeAccessMode[] | Contains the access modes the volume should support. | | storage | cdk8s.Size | Minimum storage size the volume should have. | | storageClassName | string | Name of the StorageClass required by the claim. When this property is not set, the behavior is as follows:. | | volume | IPersistentVolume | The PersistentVolume backing this claim. | | volumeMode | PersistentVolumeMode | Defines what type of volume is required by the claim. | | name | string | The name of the claim that the StatefulSet controller will create for each pod. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* PersistentVolumeAccessMode[] - *Default:* No access modes requirement. Contains the access modes the volume should support. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1](https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1) --- ##### `storage`^Optional ```typescript public readonly storage: Size; ``` - *Type:* cdk8s.Size - *Default:* No storage requirement. Minimum storage size the volume should have. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources](https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources) --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string - *Default:* Not set. Name of the StorageClass required by the claim. When this property is not set, the behavior is as follows:. If the admission plugin is turned on, the storage class marked as default will be used. - If the admission plugin is turned off, the pvc can only be bound to volumes without a storage class. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1](https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1) --- ##### `volume`^Optional ```typescript public readonly volume: IPersistentVolume; ``` - *Type:* IPersistentVolume - *Default:* No specific volume binding. The PersistentVolume backing this claim. The control plane still checks that storage class, access modes, and requested storage size on the volume are valid. Note that in order to guarantee a proper binding, the volume should also define a `claimRef` referring to this claim. Otherwise, the volume may be claimed be other pvc's before it gets a chance to bind to this one. If the volume is managed (i.e not imported), you can use `pv.claim()` to easily create a bi-directional bounded claim. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding.](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding.) --- ##### `volumeMode`^Optional ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the claim that the StatefulSet controller will create for each pod. This will be used to name the created PVC in the format - This name should match the name of a volume mount in one of the containers. --- ### PersistentVolumeClaimVolumeOptions Options for a PersistentVolumeClaim-based volume. #### Initializer ```typescript import { PersistentVolumeClaimVolumeOptions } from 'cdk8s-plus-32' const persistentVolumeClaimVolumeOptions: PersistentVolumeClaimVolumeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The volume name. | | readOnly | boolean | Will force the ReadOnly setting in VolumeMounts. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* Derived from the PVC name. The volume name. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false Will force the ReadOnly setting in VolumeMounts. --- ### PersistentVolumeClaimVolumeSource PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const persistentVolumeClaimVolumeSource: k8s.PersistentVolumeClaimVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | claimName | string | claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. | | readOnly | boolean | readOnly Will force the ReadOnly setting in VolumeMounts. | --- ##### `claimName`^Required ```typescript public readonly claimName: string; ``` - *Type:* string claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean readOnly Will force the ReadOnly setting in VolumeMounts. Default false. --- ### PersistentVolumeProps Properties for `PersistentVolume`. #### Initializer ```typescript import { PersistentVolumeProps } from 'cdk8s-plus-32' const persistentVolumeProps: PersistentVolumeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | PersistentVolumeAccessMode[] | Contains all ways the volume can be mounted. | | claim | IPersistentVolumeClaim | Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. | | mountOptions | string[] | A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. | | reclaimPolicy | PersistentVolumeReclaimPolicy | When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource. | | storage | cdk8s.Size | What is the storage capacity of this volume. | | storageClassName | string | Name of StorageClass to which this persistent volume belongs. | | volumeMode | PersistentVolumeMode | Defines what type of volume is required by the claim. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* PersistentVolumeAccessMode[] - *Default:* No access modes. Contains all ways the volume can be mounted. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes) --- ##### `claim`^Optional ```typescript public readonly claim: IPersistentVolumeClaim; ``` - *Type:* IPersistentVolumeClaim - *Default:* Not bound to a specific claim. Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding](https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding) --- ##### `mountOptions`^Optional ```typescript public readonly mountOptions: string[]; ``` - *Type:* string[] - *Default:* No options. A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options) --- ##### `reclaimPolicy`^Optional ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* PersistentVolumeReclaimPolicy - *Default:* PersistentVolumeReclaimPolicy.RETAIN When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource. The reclaim policy tells the cluster what to do with the volume after it has been released of its claim. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming](https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming) --- ##### `storage`^Optional ```typescript public readonly storage: Size; ``` - *Type:* cdk8s.Size - *Default:* No specified. What is the storage capacity of this volume. > [https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources](https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources) --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`^Optional ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ### PersistentVolumeSpec PersistentVolumeSpec is the specification of a persistent volume. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const persistentVolumeSpec: k8s.PersistentVolumeSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessModes | string[] | accessModes contains all ways the volume can be mounted. | | awsElasticBlockStore | cdk8s-plus-32.k8s.AwsElasticBlockStoreVolumeSource | awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. | | azureDisk | cdk8s-plus-32.k8s.AzureDiskVolumeSource | azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. | | azureFile | cdk8s-plus-32.k8s.AzureFilePersistentVolumeSource | azureFile represents an Azure File Service mount on the host and bind mount to the pod. | | capacity | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | capacity is the description of the persistent volume's resources and capacity. | | cephfs | cdk8s-plus-32.k8s.CephFsPersistentVolumeSource | cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. | | cinder | cdk8s-plus-32.k8s.CinderPersistentVolumeSource | cinder represents a cinder volume attached and mounted on kubelets host machine. | | claimRef | cdk8s-plus-32.k8s.ObjectReference | claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. | | csi | cdk8s-plus-32.k8s.CsiPersistentVolumeSource | csi represents storage that is handled by an external CSI driver. | | fc | cdk8s-plus-32.k8s.FcVolumeSource | fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. | | flexVolume | cdk8s-plus-32.k8s.FlexPersistentVolumeSource | flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. | | flocker | cdk8s-plus-32.k8s.FlockerVolumeSource | flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. | | gcePersistentDisk | cdk8s-plus-32.k8s.GcePersistentDiskVolumeSource | gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. | | glusterfs | cdk8s-plus-32.k8s.GlusterfsPersistentVolumeSource | glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. | | hostPath | cdk8s-plus-32.k8s.HostPathVolumeSource | hostPath represents a directory on the host. | | iscsi | cdk8s-plus-32.k8s.IscsiPersistentVolumeSource | iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. | | local | cdk8s-plus-32.k8s.LocalVolumeSource | local represents directly-attached storage with node affinity. | | mountOptions | string[] | mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options. | | nfs | cdk8s-plus-32.k8s.NfsVolumeSource | nfs represents an NFS mount on the host. | | nodeAffinity | cdk8s-plus-32.k8s.VolumeNodeAffinity | nodeAffinity defines constraints that limit what nodes this volume can be accessed from. | | persistentVolumeReclaimPolicy | string | persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. | | photonPersistentDisk | cdk8s-plus-32.k8s.PhotonPersistentDiskVolumeSource | photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. | | portworxVolume | cdk8s-plus-32.k8s.PortworxVolumeSource | portworxVolume represents a portworx volume attached and mounted on kubelets host machine. | | quobyte | cdk8s-plus-32.k8s.QuobyteVolumeSource | quobyte represents a Quobyte mount on the host that shares a pod's lifetime. | | rbd | cdk8s-plus-32.k8s.RbdPersistentVolumeSource | rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. | | scaleIo | cdk8s-plus-32.k8s.ScaleIoPersistentVolumeSource | scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. | | storageClassName | string | storageClassName is the name of StorageClass to which this persistent volume belongs. | | storageos | cdk8s-plus-32.k8s.StorageOsPersistentVolumeSource | storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod. | | volumeAttributesClassName | string | Name of VolumeAttributesClass to which this persistent volume belongs. | | volumeMode | string | volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. | | vsphereVolume | cdk8s-plus-32.k8s.VsphereVirtualDiskVolumeSource | vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. | --- ##### `accessModes`^Optional ```typescript public readonly accessModes: string[]; ``` - *Type:* string[] accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes --- ##### `awsElasticBlockStore`^Optional ```typescript public readonly awsElasticBlockStore: AwsElasticBlockStoreVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.AwsElasticBlockStoreVolumeSource awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore --- ##### `azureDisk`^Optional ```typescript public readonly azureDisk: AzureDiskVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.AzureDiskVolumeSource azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver. --- ##### `azureFile`^Optional ```typescript public readonly azureFile: AzureFilePersistentVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.AzureFilePersistentVolumeSource azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver. --- ##### `capacity`^Optional ```typescript public readonly capacity: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity --- ##### `cephfs`^Optional ```typescript public readonly cephfs: CephFsPersistentVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.CephFsPersistentVolumeSource cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported. --- ##### `cinder`^Optional ```typescript public readonly cinder: CinderPersistentVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.CinderPersistentVolumeSource cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md --- ##### `claimRef`^Optional ```typescript public readonly claimRef: ObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.ObjectReference claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding --- ##### `csi`^Optional ```typescript public readonly csi: CsiPersistentVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.CsiPersistentVolumeSource csi represents storage that is handled by an external CSI driver. --- ##### `fc`^Optional ```typescript public readonly fc: FcVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.FcVolumeSource fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. --- ##### `flexVolume`^Optional ```typescript public readonly flexVolume: FlexPersistentVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.FlexPersistentVolumeSource flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead. --- ##### `flocker`^Optional ```typescript public readonly flocker: FlockerVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.FlockerVolumeSource flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported. --- ##### `gcePersistentDisk`^Optional ```typescript public readonly gcePersistentDisk: GcePersistentDiskVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.GcePersistentDiskVolumeSource 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. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk --- ##### `glusterfs`^Optional ```typescript public readonly glusterfs: GlusterfsPersistentVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.GlusterfsPersistentVolumeSource glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.md --- ##### `hostPath`^Optional ```typescript public readonly hostPath: HostPathVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.HostPathVolumeSource hostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- ##### `iscsi`^Optional ```typescript public readonly iscsi: IscsiPersistentVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.IscsiPersistentVolumeSource iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. --- ##### `local`^Optional ```typescript public readonly local: LocalVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.LocalVolumeSource local represents directly-attached storage with node affinity. --- ##### `mountOptions`^Optional ```typescript public readonly mountOptions: string[]; ``` - *Type:* string[] mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options. --- ##### `nfs`^Optional ```typescript public readonly nfs: NfsVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.NfsVolumeSource nfs represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs --- ##### `nodeAffinity`^Optional ```typescript public readonly nodeAffinity: VolumeNodeAffinity; ``` - *Type:* cdk8s-plus-32.k8s.VolumeNodeAffinity nodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. --- ##### `persistentVolumeReclaimPolicy`^Optional ```typescript public readonly persistentVolumeReclaimPolicy: string; ``` - *Type:* string persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming --- ##### `photonPersistentDisk`^Optional ```typescript public readonly photonPersistentDisk: PhotonPersistentDiskVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.PhotonPersistentDiskVolumeSource photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported. --- ##### `portworxVolume`^Optional ```typescript public readonly portworxVolume: PortworxVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.PortworxVolumeSource portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on. --- ##### `quobyte`^Optional ```typescript public readonly quobyte: QuobyteVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.QuobyteVolumeSource quobyte represents a Quobyte mount on the host that shares a pod's lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported. --- ##### `rbd`^Optional ```typescript public readonly rbd: RbdPersistentVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.RbdPersistentVolumeSource rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.md --- ##### `scaleIo`^Optional ```typescript public readonly scaleIo: ScaleIoPersistentVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.ScaleIoPersistentVolumeSource scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported. --- ##### `storageClassName`^Optional ```typescript public readonly storageClassName: string; ``` - *Type:* string storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. --- ##### `storageos`^Optional ```typescript public readonly storageos: StorageOsPersistentVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.StorageOsPersistentVolumeSource storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. More info: https://examples.k8s.io/volumes/storageos/README.md --- ##### `volumeAttributesClassName`^Optional ```typescript public readonly volumeAttributesClassName: string; ``` - *Type:* string Name of VolumeAttributesClass to which this persistent volume belongs. Empty value is not allowed. When this field is not set, it indicates that this volume does not belong to any VolumeAttributesClass. This field is mutable and can be changed by the CSI driver after a volume has been updated successfully to a new class. For an unbound PersistentVolume, the volumeAttributesClassName will be matched with unbound PersistentVolumeClaims during the binding process. This is a beta field and requires enabling VolumeAttributesClass feature (off by default). --- ##### `volumeMode`^Optional ```typescript public readonly volumeMode: string; ``` - *Type:* string volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. --- ##### `vsphereVolume`^Optional ```typescript public readonly vsphereVolume: VsphereVirtualDiskVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.VsphereVirtualDiskVolumeSource vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver. --- ### PhotonPersistentDiskVolumeSource Represents a Photon Controller persistent disk resource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const photonPersistentDiskVolumeSource: k8s.PhotonPersistentDiskVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | pdId | string | pdID is the ID that identifies Photon Controller persistent disk. | | fsType | string | fsType is the filesystem type to mount. | --- ##### `pdId`^Required ```typescript public readonly pdId: string; ``` - *Type:* string pdID is the ID that identifies Photon Controller persistent disk. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. --- ### PodAffinity Pod affinity is a group of inter pod affinity scheduling rules. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podAffinity: k8s.PodAffinity = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | preferredDuringSchedulingIgnoredDuringExecution | cdk8s-plus-32.k8s.WeightedPodAffinityTerm[] | The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. | | requiredDuringSchedulingIgnoredDuringExecution | cdk8s-plus-32.k8s.PodAffinityTerm[] | If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. | --- ##### `preferredDuringSchedulingIgnoredDuringExecution`^Optional ```typescript public readonly preferredDuringSchedulingIgnoredDuringExecution: WeightedPodAffinityTerm[]; ``` - *Type:* cdk8s-plus-32.k8s.WeightedPodAffinityTerm[] The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. --- ##### `requiredDuringSchedulingIgnoredDuringExecution`^Optional ```typescript public readonly requiredDuringSchedulingIgnoredDuringExecution: PodAffinityTerm[]; ``` - *Type:* cdk8s-plus-32.k8s.PodAffinityTerm[] If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. --- ### PodAffinityTerm Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podAffinityTerm: k8s.PodAffinityTerm = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | topologyKey | string | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. | | labelSelector | cdk8s-plus-32.k8s.LabelSelector | A label query over a set of resources, in this case pods. | | matchLabelKeys | string[] | MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. | | mismatchLabelKeys | string[] | MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. | | namespaces | string[] | namespaces specifies a static list of namespace names that the term applies to. | | namespaceSelector | cdk8s-plus-32.k8s.LabelSelector | A label query over the set of namespaces that the term applies to. | --- ##### `topologyKey`^Required ```typescript public readonly topologyKey: string; ``` - *Type:* string This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. --- ##### `labelSelector`^Optional ```typescript public readonly labelSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods. --- ##### `matchLabelKeys`^Optional ```typescript public readonly matchLabelKeys: string[]; ``` - *Type:* string[] MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). --- ##### `mismatchLabelKeys`^Optional ```typescript public readonly mismatchLabelKeys: string[]; ``` - *Type:* string[] MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). --- ##### `namespaces`^Optional ```typescript public readonly namespaces: string[]; ``` - *Type:* string[] namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". --- ##### `namespaceSelector`^Optional ```typescript public readonly namespaceSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. --- ### PodAntiAffinity Pod anti affinity is a group of inter pod anti affinity scheduling rules. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podAntiAffinity: k8s.PodAntiAffinity = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | preferredDuringSchedulingIgnoredDuringExecution | cdk8s-plus-32.k8s.WeightedPodAffinityTerm[] | The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. | | requiredDuringSchedulingIgnoredDuringExecution | cdk8s-plus-32.k8s.PodAffinityTerm[] | If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. | --- ##### `preferredDuringSchedulingIgnoredDuringExecution`^Optional ```typescript public readonly preferredDuringSchedulingIgnoredDuringExecution: WeightedPodAffinityTerm[]; ``` - *Type:* cdk8s-plus-32.k8s.WeightedPodAffinityTerm[] The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. --- ##### `requiredDuringSchedulingIgnoredDuringExecution`^Optional ```typescript public readonly requiredDuringSchedulingIgnoredDuringExecution: PodAffinityTerm[]; ``` - *Type:* cdk8s-plus-32.k8s.PodAffinityTerm[] If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. --- ### PodConnectionsAllowFromOptions Options for `PodConnections.allowFrom`. #### Initializer ```typescript import { PodConnectionsAllowFromOptions } from 'cdk8s-plus-32' const podConnectionsAllowFromOptions: PodConnectionsAllowFromOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | isolation | PodConnectionsIsolation | Which isolation should be applied to establish the connection. | | ports | NetworkPolicyPort[] | Ports to allow incoming traffic to. | --- ##### `isolation`^Optional ```typescript public readonly isolation: PodConnectionsIsolation; ``` - *Type:* PodConnectionsIsolation - *Default:* unset, isolates both the pod and the peer. Which isolation should be applied to establish the connection. --- ##### `ports`^Optional ```typescript public readonly ports: NetworkPolicyPort[]; ``` - *Type:* NetworkPolicyPort[] - *Default:* The pod ports. Ports to allow incoming traffic to. --- ### PodConnectionsAllowToOptions Options for `PodConnections.allowTo`. #### Initializer ```typescript import { PodConnectionsAllowToOptions } from 'cdk8s-plus-32' const podConnectionsAllowToOptions: PodConnectionsAllowToOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | isolation | PodConnectionsIsolation | Which isolation should be applied to establish the connection. | | ports | NetworkPolicyPort[] | Ports to allow outgoing traffic to. | --- ##### `isolation`^Optional ```typescript public readonly isolation: PodConnectionsIsolation; ``` - *Type:* PodConnectionsIsolation - *Default:* unset, isolates both the pod and the peer. Which isolation should be applied to establish the connection. --- ##### `ports`^Optional ```typescript public readonly ports: NetworkPolicyPort[]; ``` - *Type:* NetworkPolicyPort[] - *Default:* If the peer is a managed pod, take its ports. Otherwise, all ports are allowed. Ports to allow outgoing traffic to. --- ### PodDisruptionBudgetSpec PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podDisruptionBudgetSpec: k8s.PodDisruptionBudgetSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maxUnavailable | cdk8s-plus-32.k8s.IntOrString | An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". | | minAvailable | cdk8s-plus-32.k8s.IntOrString | An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". | | selector | cdk8s-plus-32.k8s.LabelSelector | Label query over pods whose evictions are managed by the disruption budget. | | unhealthyPodEvictionPolicy | string | UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods should be considered for eviction. | --- ##### `maxUnavailable`^Optional ```typescript public readonly maxUnavailable: IntOrString; ``` - *Type:* cdk8s-plus-32.k8s.IntOrString An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". --- ##### `minAvailable`^Optional ```typescript public readonly minAvailable: IntOrString; ``` - *Type:* cdk8s-plus-32.k8s.IntOrString An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". --- ##### `selector`^Optional ```typescript public readonly selector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector Label query over pods whose evictions are managed by the disruption budget. A null selector will match no pods, while an empty ({}) selector will select all pods within the namespace. --- ##### `unhealthyPodEvictionPolicy`^Optional ```typescript public readonly unhealthyPodEvictionPolicy: string; ``` - *Type:* string UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods should be considered for eviction. Current implementation considers healthy pods, as pods that have status.conditions item with type="Ready",status="True". Valid policies are IfHealthyBudget and AlwaysAllow. If no policy is specified, the default behavior will be used, which corresponds to the IfHealthyBudget policy. IfHealthyBudget policy means that running pods (status.phase="Running"), but not yet healthy can be evicted only if the guarded application is not disrupted (status.currentHealthy is at least equal to status.desiredHealthy). Healthy pods will be subject to the PDB for eviction. AlwaysAllow policy means that all running pods (status.phase="Running"), but not yet healthy are considered disrupted and can be evicted regardless of whether the criteria in a PDB is met. This means perspective running pods of a disrupted application might not get a chance to become healthy. Healthy pods will be subject to the PDB for eviction. Additional policies may be added in the future. Clients making eviction decisions should disallow eviction of unhealthy pods if they encounter an unrecognized policy in this field. This field is beta-level. The eviction API uses this field when the feature gate PDBUnhealthyPodEvictionPolicy is enabled (enabled by default). --- ### PodDnsConfig PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podDnsConfig: k8s.PodDnsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nameservers | string[] | A list of DNS name server IP addresses. | | options | cdk8s-plus-32.k8s.PodDnsConfigOption[] | A list of DNS resolver options. | | searches | string[] | A list of DNS search domains for host-name lookup. | --- ##### `nameservers`^Optional ```typescript public readonly nameservers: string[]; ``` - *Type:* string[] A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. --- ##### `options`^Optional ```typescript public readonly options: PodDnsConfigOption[]; ``` - *Type:* cdk8s-plus-32.k8s.PodDnsConfigOption[] A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. --- ##### `searches`^Optional ```typescript public readonly searches: string[]; ``` - *Type:* string[] A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. --- ### PodDnsConfigOption PodDNSConfigOption defines DNS resolver options of a pod. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podDnsConfigOption: k8s.PodDnsConfigOption = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name is this DNS resolver option's name. | | value | string | Value is this DNS resolver option's value. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name is this DNS resolver option's name. Required. --- ##### `value`^Optional ```typescript public readonly value: string; ``` - *Type:* string Value is this DNS resolver option's value. --- ### PodDnsProps Properties for `PodDns`. #### Initializer ```typescript import { PodDnsProps } from 'cdk8s-plus-32' const podDnsProps: PodDnsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | hostname | string | Specifies the hostname of the Pod. | | hostnameAsFQDN | boolean | If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). | | nameservers | string[] | A list of IP addresses that will be used as DNS servers for the Pod. | | options | DnsOption[] | List of objects where each object may have a name property (required) and a value property (optional). | | policy | DnsPolicy | Set DNS policy for the pod. | | searches | string[] | A list of DNS search domains for hostname lookup in the Pod. | | subdomain | string | If specified, the fully qualified Pod hostname will be "...svc.". | --- ##### `hostname`^Optional ```typescript public readonly hostname: string; ``` - *Type:* string - *Default:* Set to a system-defined value. Specifies the hostname of the Pod. --- ##### `hostnameAsFQDN`^Optional ```typescript public readonly hostnameAsFQDN: boolean; ``` - *Type:* boolean - *Default:* false If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. --- ##### `nameservers`^Optional ```typescript public readonly nameservers: string[]; ``` - *Type:* string[] A list of IP addresses that will be used as DNS servers for the Pod. There can be at most 3 IP addresses specified. When the policy is set to "NONE", the list must contain at least one IP address, otherwise this property is optional. The servers listed will be combined to the base nameservers generated from the specified DNS policy with duplicate addresses removed. --- ##### `options`^Optional ```typescript public readonly options: DnsOption[]; ``` - *Type:* DnsOption[] List of objects where each object may have a name property (required) and a value property (optional). The contents in this property will be merged to the options generated from the specified DNS policy. Duplicate entries are removed. --- ##### `policy`^Optional ```typescript public readonly policy: DnsPolicy; ``` - *Type:* DnsPolicy - *Default:* DnsPolicy.CLUSTER_FIRST Set DNS policy for the pod. If policy is set to `None`, other configuration must be supplied. --- ##### `searches`^Optional ```typescript public readonly searches: string[]; ``` - *Type:* string[] A list of DNS search domains for hostname lookup in the Pod. When specified, the provided list will be merged into the base search domain names generated from the chosen DNS policy. Duplicate domain names are removed. Kubernetes allows for at most 6 search domains. --- ##### `subdomain`^Optional ```typescript public readonly subdomain: string; ``` - *Type:* string - *Default:* No subdomain. If specified, the fully qualified Pod hostname will be "...svc.". --- ### PodFailurePolicy PodFailurePolicy describes how failed pods influence the backoffLimit. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podFailurePolicy: k8s.PodFailurePolicy = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | rules | cdk8s-plus-32.k8s.PodFailurePolicyRule[] | A list of pod failure policy rules. | --- ##### `rules`^Required ```typescript public readonly rules: PodFailurePolicyRule[]; ``` - *Type:* cdk8s-plus-32.k8s.PodFailurePolicyRule[] A list of pod failure policy rules. The rules are evaluated in order. Once a rule matches a Pod failure, the remaining of the rules are ignored. When no rule matches the Pod failure, the default handling applies - the counter of pod failures is incremented and it is checked against the backoffLimit. At most 20 elements are allowed. --- ### PodFailurePolicyOnExitCodesRequirement PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes. In particular, it lookups the .state.terminated.exitCode for each app container and init container status, represented by the .status.containerStatuses and .status.initContainerStatuses fields in the Pod status, respectively. Containers completed with success (exit code 0) are excluded from the requirement check. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podFailurePolicyOnExitCodesRequirement: k8s.PodFailurePolicyOnExitCodesRequirement = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | operator | string | Represents the relationship between the container exit code(s) and the specified values. | | values | number[] | Specifies the set of values. | | containerName | string | Restricts the check for exit codes to the container with the specified name. | --- ##### `operator`^Required ```typescript public readonly operator: string; ``` - *Type:* string Represents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are: - In: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the 'containerName' field) is in the set of specified values. - NotIn: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the 'containerName' field) is not in the set of specified values. Additional values are considered to be added in the future. Clients should react to an unknown operator by assuming the requirement is not satisfied. --- ##### `values`^Required ```typescript public readonly values: number[]; ``` - *Type:* number[] Specifies the set of values. Each returned container exit code (might be multiple in case of multiple containers) is checked against this set of values with respect to the operator. The list of values must be ordered and must not contain duplicates. Value '0' cannot be used for the In operator. At least one element is required. At most 255 elements are allowed. --- ##### `containerName`^Optional ```typescript public readonly containerName: string; ``` - *Type:* string Restricts the check for exit codes to the container with the specified name. When null, the rule applies to all containers. When specified, it should match one the container or initContainer names in the pod template. --- ### PodFailurePolicyOnPodConditionsPattern PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podFailurePolicyOnPodConditionsPattern: k8s.PodFailurePolicyOnPodConditionsPattern = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | status | string | Specifies the required Pod condition status. | | type | string | Specifies the required Pod condition type. | --- ##### `status`^Required ```typescript public readonly status: string; ``` - *Type:* string - *Default:* True. Specifies the required Pod condition status. To match a pod condition it is required that the specified status equals the pod condition status. Defaults to True. --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string Specifies the required Pod condition type. To match a pod condition it is required that specified type equals the pod condition type. --- ### PodFailurePolicyRule PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in each rule. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podFailurePolicyRule: k8s.PodFailurePolicyRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are:. | | onExitCodes | cdk8s-plus-32.k8s.PodFailurePolicyOnExitCodesRequirement | Represents the requirement on the container exit codes. | | onPodConditions | cdk8s-plus-32.k8s.PodFailurePolicyOnPodConditionsPattern[] | Represents the requirement on the pod conditions. | --- ##### `action`^Required ```typescript public readonly action: string; ``` - *Type:* string Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are:. FailJob: indicates that the pod's job is marked as Failed and all running pods are terminated. - FailIndex: indicates that the pod's index is marked as Failed and will not be restarted. This value is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default). - Ignore: indicates that the counter towards the .backoffLimit is not incremented and a replacement pod is created. - Count: indicates that the pod is handled in the default way - the counter towards the .backoffLimit is incremented. Additional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule. --- ##### `onExitCodes`^Optional ```typescript public readonly onExitCodes: PodFailurePolicyOnExitCodesRequirement; ``` - *Type:* cdk8s-plus-32.k8s.PodFailurePolicyOnExitCodesRequirement Represents the requirement on the container exit codes. --- ##### `onPodConditions`^Optional ```typescript public readonly onPodConditions: PodFailurePolicyOnPodConditionsPattern[]; ``` - *Type:* cdk8s-plus-32.k8s.PodFailurePolicyOnPodConditionsPattern[] Represents the requirement on the pod conditions. The requirement is represented as a list of pod condition patterns. The requirement is satisfied if at least one pattern matches an actual pod condition. At most 20 elements are allowed. --- ### PodOs PodOS defines the OS parameters of a pod. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podOs: k8s.PodOs = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name is the name of the operating system. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is the name of the operating system. The currently supported values are linux and windows. Additional value may be defined in future and can be one of: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration Clients should expect to handle additional values and treat unrecognized values in this field as os: null --- ### PodProps Properties for `Pod`. #### Initializer ```typescript import { PodProps } from 'cdk8s-plus-32' const podProps: PodProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | boolean | Indicates whether a service account token should be automatically mounted. | | containers | ContainerProps[] | List of containers belonging to the pod. | | dns | PodDnsProps | DNS settings for the pod. | | dockerRegistryAuth | ISecret | A secret containing docker credentials for authenticating to a registry. | | enableServiceLinks | boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | HostAlias[] | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | boolean | Host network for the pod. | | initContainers | ContainerProps[] | List of initialization containers belonging to the pod. | | isolate | boolean | Isolates the pod. | | restartPolicy | RestartPolicy | Restart policy for all containers within the pod. | | securityContext | PodSecurityContextProps | SecurityContext holds pod-level security attributes and common container settings. | | serviceAccount | IServiceAccount | A service account provides an identity for processes that run in a Pod. | | shareProcessNamespace | boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | cdk8s.Duration | Grace period until the pod is terminated. | | volumes | Volume[] | List of volumes that can be mounted by containers belonging to the pod. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether a service account token should be automatically mounted. > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server) --- ##### `containers`^Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No containers. Note that a pod spec must include at least one container. List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. You can add additionnal containers using `podSpec.addContainer()` --- ##### `dns`^Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* PodDnsProps - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > [https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/) --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean - *Default:* true Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. > [https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) --- ##### `hostAliases`^Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No init containers. List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added ,removed or updated. > [https://kubernetes.io/docs/concepts/workloads/pods/init-containers/](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) --- ##### `isolate`^Optional ```typescript public readonly isolate: boolean; ``` - *Type:* boolean - *Default:* false Isolates the pod. This will prevent any ingress or egress connections to / from this pod. You can however allow explicit connections post instantiation by using the `.connections` property. --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy) --- ##### `securityContext`^Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount - *Default:* No service account. A service account provides an identity for processes that run in a Pod. When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default). > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) --- ##### `shareProcessNamespace`^Optional ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean - *Default:* false When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. > [https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/](https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/) --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] - *Default:* No volumes. List of volumes that can be mounted by containers belonging to the pod. You can also add volumes later using `podSpec.addVolume()` > [https://kubernetes.io/docs/concepts/storage/volumes](https://kubernetes.io/docs/concepts/storage/volumes) --- ### PodReadinessGate PodReadinessGate contains the reference to a pod condition. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podReadinessGate: k8s.PodReadinessGate = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | conditionType | string | ConditionType refers to a condition in the pod's condition list with matching type. | --- ##### `conditionType`^Required ```typescript public readonly conditionType: string; ``` - *Type:* string ConditionType refers to a condition in the pod's condition list with matching type. --- ### PodResourceClaim PodResourceClaim references exactly one ResourceClaim, either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the pod. It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podResourceClaim: k8s.PodResourceClaim = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name uniquely identifies this resource claim inside the pod. | | resourceClaimName | string | ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod. | | resourceClaimTemplateName | string | ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL. --- ##### `resourceClaimName`^Optional ```typescript public readonly resourceClaimName: string; ``` - *Type:* string ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod. Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set. --- ##### `resourceClaimTemplateName`^Optional ```typescript public readonly resourceClaimTemplateName: string; ``` - *Type:* string ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod. The template will be used to create a new ResourceClaim, which will be bound to this pod. When this pod is deleted, the ResourceClaim will also be deleted. The pod name and resource name, along with a generated component, will be used to form a unique name for the ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses. This field is immutable and no changes will be made to the corresponding ResourceClaim by the control plane after creating the ResourceClaim. Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set. --- ### PodsAllOptions Options for `Pods.all`. #### Initializer ```typescript import { PodsAllOptions } from 'cdk8s-plus-32' const podsAllOptions: PodsAllOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | namespaces | Namespaces | Namespaces the pods are allowed to be in. | --- ##### `namespaces`^Optional ```typescript public readonly namespaces: Namespaces; ``` - *Type:* Namespaces - *Default:* unset, implies the namespace of the resource this selection is used in. Namespaces the pods are allowed to be in. Use `Namespaces.all()` to allow all namespaces. --- ### PodSchedulingAttractOptions Options for `PodScheduling.attract`. #### Initializer ```typescript import { PodSchedulingAttractOptions } from 'cdk8s-plus-32' const podSchedulingAttractOptions: PodSchedulingAttractOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | weight | number | Indicates the attraction is optional (soft), with this weight score. | --- ##### `weight`^Optional ```typescript public readonly weight: number; ``` - *Type:* number - *Default:* no weight. assignment is assumed to be required (hard). Indicates the attraction is optional (soft), with this weight score. --- ### PodSchedulingColocateOptions Options for `PodScheduling.colocate`. #### Initializer ```typescript import { PodSchedulingColocateOptions } from 'cdk8s-plus-32' const podSchedulingColocateOptions: PodSchedulingColocateOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | topology | Topology | Which topology to coloate on. | | weight | number | Indicates the co-location is optional (soft), with this weight score. | --- ##### `topology`^Optional ```typescript public readonly topology: Topology; ``` - *Type:* Topology - *Default:* Topology.HOSTNAME Which topology to coloate on. --- ##### `weight`^Optional ```typescript public readonly weight: number; ``` - *Type:* number - *Default:* no weight. co-location is assumed to be required (hard). Indicates the co-location is optional (soft), with this weight score. --- ### PodSchedulingGate PodSchedulingGate is associated to a Pod to guard its scheduling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podSchedulingGate: k8s.PodSchedulingGate = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name of the scheduling gate. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of the scheduling gate. Each scheduling gate must have a unique name field. --- ### PodSchedulingSeparateOptions Options for `PodScheduling.separate`. #### Initializer ```typescript import { PodSchedulingSeparateOptions } from 'cdk8s-plus-32' const podSchedulingSeparateOptions: PodSchedulingSeparateOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | topology | Topology | Which topology to separate on. | | weight | number | Indicates the separation is optional (soft), with this weight score. | --- ##### `topology`^Optional ```typescript public readonly topology: Topology; ``` - *Type:* Topology - *Default:* Topology.HOSTNAME Which topology to separate on. --- ##### `weight`^Optional ```typescript public readonly weight: number; ``` - *Type:* number - *Default:* no weight. separation is assumed to be required (hard). Indicates the separation is optional (soft), with this weight score. --- ### PodSecurityContext PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podSecurityContext: k8s.PodSecurityContext = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | appArmorProfile | cdk8s-plus-32.k8s.AppArmorProfile | appArmorProfile is the AppArmor options to use by the containers in this pod. | | fsGroup | number | A special supplemental group that applies to all containers in a pod. | | fsGroupChangePolicy | string | fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. | | runAsGroup | number | The GID to run the entrypoint of the container process. | | runAsNonRoot | boolean | Indicates that the container must run as a non-root user. | | runAsUser | number | The UID to run the entrypoint of the container process. | | seccompProfile | cdk8s-plus-32.k8s.SeccompProfile | The seccomp options to use by the containers in this pod. | | seLinuxChangePolicy | string | seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod. | | seLinuxOptions | cdk8s-plus-32.k8s.SeLinuxOptions | The SELinux context to be applied to all containers. | | supplementalGroups | number[] | A list of groups applied to the first process run in each container, in addition to the container's primary GID and fsGroup (if specified). | | supplementalGroupsPolicy | string | Defines how supplemental groups of the first container processes are calculated. | | sysctls | cdk8s-plus-32.k8s.Sysctl[] | Sysctls hold a list of namespaced sysctls used for the pod. | | windowsOptions | cdk8s-plus-32.k8s.WindowsSecurityContextOptions | The Windows specific settings applied to all containers. | --- ##### `appArmorProfile`^Optional ```typescript public readonly appArmorProfile: AppArmorProfile; ``` - *Type:* cdk8s-plus-32.k8s.AppArmorProfile appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows. --- ##### `fsGroup`^Optional ```typescript public readonly fsGroup: number; ``` - *Type:* number A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. --- ##### `fsGroupChangePolicy`^Optional ```typescript public readonly fsGroupChangePolicy: string; ``` - *Type:* string fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows. --- ##### `runAsGroup`^Optional ```typescript public readonly runAsGroup: number; ``` - *Type:* number The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. --- ##### `runAsNonRoot`^Optional ```typescript public readonly runAsNonRoot: boolean; ``` - *Type:* boolean Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. --- ##### `runAsUser`^Optional ```typescript public readonly runAsUser: number; ``` - *Type:* number - *Default:* user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. --- ##### `seccompProfile`^Optional ```typescript public readonly seccompProfile: SeccompProfile; ``` - *Type:* cdk8s-plus-32.k8s.SeccompProfile The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows. --- ##### `seLinuxChangePolicy`^Optional ```typescript public readonly seLinuxChangePolicy: string; ``` - *Type:* string seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux. Valid values are "MountOption" and "Recursive". "Recursive" means relabeling of all files on all Pod volumes by the container runtime. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node. "MountOption" mounts all eligible Pod volumes with `-o context` mount option. This requires all Pods that share the same volume to use the same SELinux label. It is not possible to share the same volume among privileged and unprivileged Pods. Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their CSIDriver instance. Other volumes are always re-labelled recursively. "MountOption" value is allowed only when SELinuxMount feature gate is enabled. If not specified and SELinuxMount feature gate is enabled, "MountOption" is used. If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes and "Recursive" for all other volumes. This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers. All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state. Note that this field cannot be set when spec.os.name is windows. --- ##### `seLinuxOptions`^Optional ```typescript public readonly seLinuxOptions: SeLinuxOptions; ``` - *Type:* cdk8s-plus-32.k8s.SeLinuxOptions The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. --- ##### `supplementalGroups`^Optional ```typescript public readonly supplementalGroups: number[]; ``` - *Type:* number[] A list of groups applied to the first process run in each container, in addition to the container's primary GID and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image. If unspecified, no additional groups are added, though group memberships defined in the container image may still be used, depending on the supplementalGroupsPolicy field. Note that this field cannot be set when spec.os.name is windows. --- ##### `supplementalGroupsPolicy`^Optional ```typescript public readonly supplementalGroupsPolicy: string; ``` - *Type:* string Defines how supplemental groups of the first container processes are calculated. Valid values are "Merge" and "Strict". If not specified, "Merge" is used. (Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled and the container runtime must implement support for this feature. Note that this field cannot be set when spec.os.name is windows. --- ##### `sysctls`^Optional ```typescript public readonly sysctls: Sysctl[]; ``` - *Type:* cdk8s-plus-32.k8s.Sysctl[] Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows. --- ##### `windowsOptions`^Optional ```typescript public readonly windowsOptions: WindowsSecurityContextOptions; ``` - *Type:* cdk8s-plus-32.k8s.WindowsSecurityContextOptions The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. --- ### PodSecurityContextProps Properties for `PodSecurityContext`. #### Initializer ```typescript import { PodSecurityContextProps } from 'cdk8s-plus-32' const podSecurityContextProps: PodSecurityContextProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ensureNonRoot | boolean | Indicates that the container must run as a non-root user. | | fsGroup | number | Modify the ownership and permissions of pod volumes to this GID. | | fsGroupChangePolicy | FsGroupChangePolicy | Defines behavior of changing ownership and permission of the volume before being exposed inside Pod. | | group | number | The GID to run the entrypoint of the container process. | | sysctls | Sysctl[] | Sysctls hold a list of namespaced sysctls used for the pod. | | user | number | The UID to run the entrypoint of the container process. | --- ##### `ensureNonRoot`^Optional ```typescript public readonly ensureNonRoot: boolean; ``` - *Type:* boolean - *Default:* true Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. --- ##### `fsGroup`^Optional ```typescript public readonly fsGroup: number; ``` - *Type:* number - *Default:* Volume ownership is not changed. Modify the ownership and permissions of pod volumes to this GID. --- ##### `fsGroupChangePolicy`^Optional ```typescript public readonly fsGroupChangePolicy: FsGroupChangePolicy; ``` - *Type:* FsGroupChangePolicy - *Default:* FsGroupChangePolicy.ALWAYS Defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. --- ##### `group`^Optional ```typescript public readonly group: number; ``` - *Type:* number - *Default:* Group configured by container runtime The GID to run the entrypoint of the container process. --- ##### `sysctls`^Optional ```typescript public readonly sysctls: Sysctl[]; ``` - *Type:* Sysctl[] - *Default:* No sysctls Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. --- ##### `user`^Optional ```typescript public readonly user: number; ``` - *Type:* number - *Default:* User specified in image metadata The UID to run the entrypoint of the container process. --- ### PodSelectorConfig Configuration for selecting pods, optionally in particular namespaces. #### Initializer ```typescript import { PodSelectorConfig } from 'cdk8s-plus-32' const podSelectorConfig: PodSelectorConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | labelSelector | LabelSelector | A selector to select pods by labels. | | namespaces | NamespaceSelectorConfig | Configuration for selecting which namepsaces are the pods allowed to be in. | --- ##### `labelSelector`^Required ```typescript public readonly labelSelector: LabelSelector; ``` - *Type:* LabelSelector A selector to select pods by labels. --- ##### `namespaces`^Optional ```typescript public readonly namespaces: NamespaceSelectorConfig; ``` - *Type:* NamespaceSelectorConfig Configuration for selecting which namepsaces are the pods allowed to be in. --- ### PodsMetricSourceV2 PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podsMetricSourceV2: k8s.PodsMetricSourceV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metric | cdk8s-plus-32.k8s.MetricIdentifierV2 | metric identifies the target metric by name and selector. | | target | cdk8s-plus-32.k8s.MetricTargetV2 | target specifies the target value for the given metric. | --- ##### `metric`^Required ```typescript public readonly metric: MetricIdentifierV2; ``` - *Type:* cdk8s-plus-32.k8s.MetricIdentifierV2 metric identifies the target metric by name and selector. --- ##### `target`^Required ```typescript public readonly target: MetricTargetV2; ``` - *Type:* cdk8s-plus-32.k8s.MetricTargetV2 target specifies the target value for the given metric. --- ### PodSpec PodSpec is a description of a pod. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podSpec: k8s.PodSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | containers | cdk8s-plus-32.k8s.Container[] | List of containers belonging to the pod. | | activeDeadlineSeconds | number | Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. | | affinity | cdk8s-plus-32.k8s.Affinity | If specified, the pod's scheduling constraints. | | automountServiceAccountToken | boolean | AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. | | dnsConfig | cdk8s-plus-32.k8s.PodDnsConfig | Specifies the DNS parameters of a pod. | | dnsPolicy | string | Set DNS policy for the pod. | | enableServiceLinks | boolean | EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | ephemeralContainers | cdk8s-plus-32.k8s.EphemeralContainer[] | List of ephemeral containers run in this pod. | | hostAliases | cdk8s-plus-32.k8s.HostAlias[] | HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. | | hostIpc | boolean | Use the host's ipc namespace. | | hostname | string | Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. | | hostNetwork | boolean | Host networking requested for this pod. | | hostPid | boolean | Use the host's pid namespace. | | hostUsers | boolean | Use the host's user namespace. | | imagePullSecrets | cdk8s-plus-32.k8s.LocalObjectReference[] | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. | | initContainers | cdk8s-plus-32.k8s.Container[] | List of initialization containers belonging to the pod. | | nodeName | string | NodeName indicates in which node this pod is scheduled. | | nodeSelector | {[ key: string ]: string} | NodeSelector is a selector which must be true for the pod to fit on a node. | | os | cdk8s-plus-32.k8s.PodOs | Specifies the OS of the containers in the pod. | | overhead | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. | | preemptionPolicy | string | PreemptionPolicy is the Policy for preempting pods with lower priority. | | priority | number | The priority value. | | priorityClassName | string | If specified, indicates the pod's priority. | | readinessGates | cdk8s-plus-32.k8s.PodReadinessGate[] | If specified, all readiness gates will be evaluated for pod readiness. | | resourceClaims | cdk8s-plus-32.k8s.PodResourceClaim[] | ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. | | resources | cdk8s-plus-32.k8s.ResourceRequirements | Resources is the total amount of CPU and Memory resources required by all containers in the pod. | | restartPolicy | string | Restart policy for all containers within the pod. | | runtimeClassName | string | RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class. | | schedulerName | string | If specified, the pod will be dispatched by specified scheduler. | | schedulingGates | cdk8s-plus-32.k8s.PodSchedulingGate[] | SchedulingGates is an opaque list of values that if specified will block scheduling the pod. | | securityContext | cdk8s-plus-32.k8s.PodSecurityContext | SecurityContext holds pod-level security attributes and common container settings. | | serviceAccount | string | DeprecatedServiceAccount is a deprecated alias for ServiceAccountName. | | serviceAccountName | string | ServiceAccountName is the name of the ServiceAccount to use to run this pod. | | setHostnameAsFqdn | boolean | If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). | | shareProcessNamespace | boolean | Share a single process namespace between all of the containers in a pod. | | subdomain | string | If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. | | terminationGracePeriodSeconds | number | Optional duration in seconds the pod needs to terminate gracefully. | | tolerations | cdk8s-plus-32.k8s.Toleration[] | If specified, the pod's tolerations. | | topologySpreadConstraints | cdk8s-plus-32.k8s.TopologySpreadConstraint[] | TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. | | volumes | cdk8s-plus-32.k8s.Volume[] | List of volumes that can be mounted by containers belonging to the pod. | --- ##### `containers`^Required ```typescript public readonly containers: Container[]; ``` - *Type:* cdk8s-plus-32.k8s.Container[] List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. --- ##### `activeDeadlineSeconds`^Optional ```typescript public readonly activeDeadlineSeconds: number; ``` - *Type:* number Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. --- ##### `affinity`^Optional ```typescript public readonly affinity: Affinity; ``` - *Type:* cdk8s-plus-32.k8s.Affinity If specified, the pod's scheduling constraints. --- ##### `automountServiceAccountToken`^Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. --- ##### `dnsConfig`^Optional ```typescript public readonly dnsConfig: PodDnsConfig; ``` - *Type:* cdk8s-plus-32.k8s.PodDnsConfig Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. --- ##### `dnsPolicy`^Optional ```typescript public readonly dnsPolicy: string; ``` - *Type:* string - *Default:* ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean - *Default:* true. EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. --- ##### `ephemeralContainers`^Optional ```typescript public readonly ephemeralContainers: EphemeralContainer[]; ``` - *Type:* cdk8s-plus-32.k8s.EphemeralContainer[] List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. --- ##### `hostAliases`^Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* cdk8s-plus-32.k8s.HostAlias[] HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. --- ##### `hostIpc`^Optional ```typescript public readonly hostIpc: boolean; ``` - *Type:* boolean - *Default:* false. Use the host's ipc namespace. Optional: Default to false. --- ##### `hostname`^Optional ```typescript public readonly hostname: string; ``` - *Type:* string Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean - *Default:* false. Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. --- ##### `hostPid`^Optional ```typescript public readonly hostPid: boolean; ``` - *Type:* boolean - *Default:* false. Use the host's pid namespace. Optional: Default to false. --- ##### `hostUsers`^Optional ```typescript public readonly hostUsers: boolean; ``` - *Type:* boolean - *Default:* true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature. Use the host's user namespace. Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature. --- ##### `imagePullSecrets`^Optional ```typescript public readonly imagePullSecrets: LocalObjectReference[]; ``` - *Type:* cdk8s-plus-32.k8s.LocalObjectReference[] ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod --- ##### `initContainers`^Optional ```typescript public readonly initContainers: Container[]; ``` - *Type:* cdk8s-plus-32.k8s.Container[] List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ --- ##### `nodeName`^Optional ```typescript public readonly nodeName: string; ``` - *Type:* string NodeName indicates in which node this pod is scheduled. If empty, this pod is a candidate for scheduling by the scheduler defined in schedulerName. Once this field is set, the kubelet for this node becomes responsible for the lifecycle of this pod. This field should not be used to express a desire for the pod to be scheduled on a specific node. https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodename --- ##### `nodeSelector`^Optional ```typescript public readonly nodeSelector: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ --- ##### `os`^Optional ```typescript public readonly os: PodOs; ``` - *Type:* cdk8s-plus-32.k8s.PodOs Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set. If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.appArmorProfile - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.securityContext.supplementalGroupsPolicy - spec.containers[*].securityContext.appArmorProfile - spec.containers[*].securityContext.seLinuxOptions - spec.containers[*].securityContext.seccompProfile - spec.containers[*].securityContext.capabilities - spec.containers[*].securityContext.readOnlyRootFilesystem - spec.containers[*].securityContext.privileged - spec.containers[*].securityContext.allowPrivilegeEscalation - spec.containers[*].securityContext.procMount - spec.containers[*].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup --- ##### `overhead`^Optional ```typescript public readonly overhead: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md --- ##### `preemptionPolicy`^Optional ```typescript public readonly preemptionPolicy: string; ``` - *Type:* string - *Default:* PreemptLowerPriority if unset. PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. --- ##### `priority`^Optional ```typescript public readonly priority: number; ``` - *Type:* number The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. --- ##### `priorityClassName`^Optional ```typescript public readonly priorityClassName: string; ``` - *Type:* string If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. --- ##### `readinessGates`^Optional ```typescript public readonly readinessGates: PodReadinessGate[]; ``` - *Type:* cdk8s-plus-32.k8s.PodReadinessGate[] If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates --- ##### `resourceClaims`^Optional ```typescript public readonly resourceClaims: PodResourceClaim[]; ``` - *Type:* cdk8s-plus-32.k8s.PodResourceClaim[] ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. The resources will be made available to those containers which consume them by name. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. --- ##### `resources`^Optional ```typescript public readonly resources: ResourceRequirements; ``` - *Type:* cdk8s-plus-32.k8s.ResourceRequirements Resources is the total amount of CPU and Memory resources required by all containers in the pod. It supports specifying Requests and Limits for "cpu" and "memory" resource names only. ResourceClaims are not supported. This field enables fine-grained control over resource allocation for the entire pod, allowing resource sharing among containers in a pod. This is an alpha field and requires enabling the PodLevelResources feature gate. --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: string; ``` - *Type:* string - *Default:* Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy Restart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy --- ##### `runtimeClassName`^Optional ```typescript public readonly runtimeClassName: string; ``` - *Type:* string RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class. --- ##### `schedulerName`^Optional ```typescript public readonly schedulerName: string; ``` - *Type:* string If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. --- ##### `schedulingGates`^Optional ```typescript public readonly schedulingGates: PodSchedulingGate[]; ``` - *Type:* cdk8s-plus-32.k8s.PodSchedulingGate[] SchedulingGates is an opaque list of values that if specified will block scheduling the pod. If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod. SchedulingGates can only be set at pod creation time, and be removed only afterwards. --- ##### `securityContext`^Optional ```typescript public readonly securityContext: PodSecurityContext; ``` - *Type:* cdk8s-plus-32.k8s.PodSecurityContext - *Default:* empty. See type description for default values of each field. SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: string; ``` - *Type:* string DeprecatedServiceAccount is a deprecated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. --- ##### `serviceAccountName`^Optional ```typescript public readonly serviceAccountName: string; ``` - *Type:* string ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ --- ##### `setHostnameAsFqdn`^Optional ```typescript public readonly setHostnameAsFqdn: boolean; ``` - *Type:* boolean - *Default:* false. If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. --- ##### `shareProcessNamespace`^Optional ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean - *Default:* false. Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. --- ##### `subdomain`^Optional ```typescript public readonly subdomain: string; ``` - *Type:* string If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. --- ##### `terminationGracePeriodSeconds`^Optional ```typescript public readonly terminationGracePeriodSeconds: number; ``` - *Type:* number - *Default:* 30 seconds. Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. --- ##### `tolerations`^Optional ```typescript public readonly tolerations: Toleration[]; ``` - *Type:* cdk8s-plus-32.k8s.Toleration[] If specified, the pod's tolerations. --- ##### `topologySpreadConstraints`^Optional ```typescript public readonly topologySpreadConstraints: TopologySpreadConstraint[]; ``` - *Type:* cdk8s-plus-32.k8s.TopologySpreadConstraint[] TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. --- ##### `volumes`^Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* cdk8s-plus-32.k8s.Volume[] List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes --- ### PodsSelectOptions Options for `Pods.select`. #### Initializer ```typescript import { PodsSelectOptions } from 'cdk8s-plus-32' const podsSelectOptions: PodsSelectOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expressions | LabelExpression[] | Expressions the pods must satisify. | | labels | {[ key: string ]: string} | Labels the pods must have. | | namespaces | Namespaces | Namespaces the pods are allowed to be in. | --- ##### `expressions`^Optional ```typescript public readonly expressions: LabelExpression[]; ``` - *Type:* LabelExpression[] - *Default:* no expressions requirements. Expressions the pods must satisify. --- ##### `labels`^Optional ```typescript public readonly labels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* no strict labels requirements. Labels the pods must have. --- ##### `namespaces`^Optional ```typescript public readonly namespaces: Namespaces; ``` - *Type:* Namespaces - *Default:* unset, implies the namespace of the resource this selection is used in. Namespaces the pods are allowed to be in. Use `Namespaces.all()` to allow all namespaces. --- ### PodTemplateSpec PodTemplateSpec describes the data a pod should have when created from a template. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const podTemplateSpec: k8s.PodTemplateSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s-plus-32.k8s.ObjectMeta | Standard object's metadata. | | spec | cdk8s-plus-32.k8s.PodSpec | Specification of the desired behavior of the pod. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional ```typescript public readonly spec: PodSpec; ``` - *Type:* cdk8s-plus-32.k8s.PodSpec Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- ### PolicyRule PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const policyRule: k8s.PolicyRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | verbs | string[] | Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. | | apiGroups | string[] | APIGroups is the name of the APIGroup that contains the resources. | | nonResourceUrLs | string[] | NonResourceURLs is a set of partial urls that a user should have access to. | | resourceNames | string[] | ResourceNames is an optional white list of names that the rule applies to. | | resources | string[] | Resources is a list of resources this rule applies to. | --- ##### `verbs`^Required ```typescript public readonly verbs: string[]; ``` - *Type:* string[] Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs. --- ##### `apiGroups`^Optional ```typescript public readonly apiGroups: string[]; ``` - *Type:* string[] APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups. --- ##### `nonResourceUrLs`^Optional ```typescript public readonly nonResourceUrLs: string[]; ``` - *Type:* string[] NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. --- ##### `resourceNames`^Optional ```typescript public readonly resourceNames: string[]; ``` - *Type:* string[] ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. --- ##### `resources`^Optional ```typescript public readonly resources: string[]; ``` - *Type:* string[] Resources is a list of resources this rule applies to. '*' represents all resources. --- ### PolicyRulesWithSubjects PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const policyRulesWithSubjects: k8s.PolicyRulesWithSubjects = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | subjects | cdk8s-plus-32.k8s.Subject[] | subjects is the list of normal user, serviceaccount, or group that this rule cares about. | | nonResourceRules | cdk8s-plus-32.k8s.NonResourcePolicyRule[] | `nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL. | | resourceRules | cdk8s-plus-32.k8s.ResourcePolicyRule[] | `resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. | --- ##### `subjects`^Required ```typescript public readonly subjects: Subject[]; ``` - *Type:* cdk8s-plus-32.k8s.Subject[] subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required. --- ##### `nonResourceRules`^Optional ```typescript public readonly nonResourceRules: NonResourcePolicyRule[]; ``` - *Type:* cdk8s-plus-32.k8s.NonResourcePolicyRule[] `nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL. --- ##### `resourceRules`^Optional ```typescript public readonly resourceRules: ResourcePolicyRule[]; ``` - *Type:* cdk8s-plus-32.k8s.ResourcePolicyRule[] `resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be non-empty. --- ### PortworxVolumeSource PortworxVolumeSource represents a Portworx volume resource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const portworxVolumeSource: k8s.PortworxVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | volumeId | string | volumeID uniquely identifies a Portworx volume. | | fsType | string | fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. | | readOnly | boolean | readOnly defaults to false (read/write). | --- ##### `volumeId`^Required ```typescript public readonly volumeId: string; ``` - *Type:* string volumeID uniquely identifies a Portworx volume. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ### Preconditions Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const preconditions: k8s.Preconditions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | resourceVersion | string | Specifies the target ResourceVersion. | | uid | string | Specifies the target UID. | --- ##### `resourceVersion`^Optional ```typescript public readonly resourceVersion: string; ``` - *Type:* string Specifies the target ResourceVersion. --- ##### `uid`^Optional ```typescript public readonly uid: string; ``` - *Type:* string Specifies the target UID. --- ### PreferredSchedulingTerm An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const preferredSchedulingTerm: k8s.PreferredSchedulingTerm = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | preference | cdk8s-plus-32.k8s.NodeSelectorTerm | A node selector term, associated with the corresponding weight. | | weight | number | Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. | --- ##### `preference`^Required ```typescript public readonly preference: NodeSelectorTerm; ``` - *Type:* cdk8s-plus-32.k8s.NodeSelectorTerm A node selector term, associated with the corresponding weight. --- ##### `weight`^Required ```typescript public readonly weight: number; ``` - *Type:* number Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. --- ### PriorityLevelConfigurationReference PriorityLevelConfigurationReference contains information that points to the "request-priority" being used. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const priorityLevelConfigurationReference: k8s.PriorityLevelConfigurationReference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | `name` is the name of the priority level configuration being referenced Required. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string `name` is the name of the priority level configuration being referenced Required. --- ### PriorityLevelConfigurationSpec PriorityLevelConfigurationSpec specifies the configuration of a priority level. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const priorityLevelConfigurationSpec: k8s.PriorityLevelConfigurationSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | `type` indicates whether this priority level is subject to limitation on request execution. | | exempt | cdk8s-plus-32.k8s.ExemptPriorityLevelConfiguration | `exempt` specifies how requests are handled for an exempt priority level. | | limited | cdk8s-plus-32.k8s.LimitedPriorityLevelConfiguration | `limited` specifies how requests are handled for a Limited priority level. | --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string `type` indicates whether this priority level is subject to limitation on request execution. A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required. --- ##### `exempt`^Optional ```typescript public readonly exempt: ExemptPriorityLevelConfiguration; ``` - *Type:* cdk8s-plus-32.k8s.ExemptPriorityLevelConfiguration `exempt` specifies how requests are handled for an exempt priority level. This field MUST be empty if `type` is `"Limited"`. This field MAY be non-empty if `type` is `"Exempt"`. If empty and `type` is `"Exempt"` then the default values for `ExemptPriorityLevelConfiguration` apply. --- ##### `limited`^Optional ```typescript public readonly limited: LimitedPriorityLevelConfiguration; ``` - *Type:* cdk8s-plus-32.k8s.LimitedPriorityLevelConfiguration `limited` specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if `type` is `"Limited"`. --- ### Probe Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const probe: k8s.Probe = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | exec | cdk8s-plus-32.k8s.ExecAction | Exec specifies a command to execute in the container. | | failureThreshold | number | Minimum consecutive failures for the probe to be considered failed after having succeeded. | | grpc | cdk8s-plus-32.k8s.GrpcAction | GRPC specifies a GRPC HealthCheckRequest. | | httpGet | cdk8s-plus-32.k8s.HttpGetAction | HTTPGet specifies an HTTP GET request to perform. | | initialDelaySeconds | number | Number of seconds after the container has started before liveness probes are initiated. | | periodSeconds | number | How often (in seconds) to perform the probe. | | successThreshold | number | Minimum consecutive successes for the probe to be considered successful after having failed. | | tcpSocket | cdk8s-plus-32.k8s.TcpSocketAction | TCPSocket specifies a connection to a TCP port. | | terminationGracePeriodSeconds | number | Optional duration in seconds the pod needs to terminate gracefully upon probe failure. | | timeoutSeconds | number | Number of seconds after which the probe times out. | --- ##### `exec`^Optional ```typescript public readonly exec: ExecAction; ``` - *Type:* cdk8s-plus-32.k8s.ExecAction Exec specifies a command to execute in the container. --- ##### `failureThreshold`^Optional ```typescript public readonly failureThreshold: number; ``` - *Type:* number - *Default:* 3. Minimum value is 1. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. --- ##### `grpc`^Optional ```typescript public readonly grpc: GrpcAction; ``` - *Type:* cdk8s-plus-32.k8s.GrpcAction GRPC specifies a GRPC HealthCheckRequest. --- ##### `httpGet`^Optional ```typescript public readonly httpGet: HttpGetAction; ``` - *Type:* cdk8s-plus-32.k8s.HttpGetAction HTTPGet specifies an HTTP GET request to perform. --- ##### `initialDelaySeconds`^Optional ```typescript public readonly initialDelaySeconds: number; ``` - *Type:* number Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes --- ##### `periodSeconds`^Optional ```typescript public readonly periodSeconds: number; ``` - *Type:* number - *Default:* 10 seconds. Minimum value is 1. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. --- ##### `successThreshold`^Optional ```typescript public readonly successThreshold: number; ``` - *Type:* number - *Default:* 1. Must be 1 for liveness and startup. Minimum value is 1. Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. --- ##### `tcpSocket`^Optional ```typescript public readonly tcpSocket: TcpSocketAction; ``` - *Type:* cdk8s-plus-32.k8s.TcpSocketAction TCPSocket specifies a connection to a TCP port. --- ##### `terminationGracePeriodSeconds`^Optional ```typescript public readonly terminationGracePeriodSeconds: number; ``` - *Type:* number Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. --- ##### `timeoutSeconds`^Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes --- ### ProbeOptions Probe options. #### Initializer ```typescript import { ProbeOptions } from 'cdk8s-plus-32' const probeOptions: ProbeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | failureThreshold | number | Minimum consecutive failures for the probe to be considered failed after having succeeded. | | initialDelaySeconds | cdk8s.Duration | Number of seconds after the container has started before liveness probes are initiated. | | periodSeconds | cdk8s.Duration | How often (in seconds) to perform the probe. | | successThreshold | number | Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. | | timeoutSeconds | cdk8s.Duration | Number of seconds after which the probe times out. | --- ##### `failureThreshold`^Optional ```typescript public readonly failureThreshold: number; ``` - *Type:* number - *Default:* 3 Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. --- ##### `initialDelaySeconds`^Optional ```typescript public readonly initialDelaySeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* immediate Number of seconds after the container has started before liveness probes are initiated. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes) --- ##### `periodSeconds`^Optional ```typescript public readonly periodSeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(10) Minimum value is 1. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. --- ##### `successThreshold`^Optional ```typescript public readonly successThreshold: number; ``` - *Type:* number - *Default:* 1 Must be 1 for liveness and startup. Minimum value is 1. Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. --- ##### `timeoutSeconds`^Optional ```typescript public readonly timeoutSeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(1) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes) --- ### ProjectedVolumeSource Represents a projected volume source. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const projectedVolumeSource: k8s.ProjectedVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultMode | number | defaultMode are the mode bits used to set permissions on created files by default. | | sources | cdk8s-plus-32.k8s.VolumeProjection[] | sources is the list of volume projections. | --- ##### `defaultMode`^Optional ```typescript public readonly defaultMode: number; ``` - *Type:* number defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. --- ##### `sources`^Optional ```typescript public readonly sources: VolumeProjection[]; ``` - *Type:* cdk8s-plus-32.k8s.VolumeProjection[] sources is the list of volume projections. Each entry in this list handles one source. --- ### QueuingConfiguration QueuingConfiguration holds the configuration parameters for queuing. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const queuingConfiguration: k8s.QueuingConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | handSize | number | `handSize` is a small positive number that configures the shuffle sharding of requests into queues. | | queueLengthLimit | number | `queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; | | queues | number | `queues` is the number of queues for this priority level. | --- ##### `handSize`^Optional ```typescript public readonly handSize: number; ``` - *Type:* number `handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8. --- ##### `queueLengthLimit`^Optional ```typescript public readonly queueLengthLimit: number; ``` - *Type:* number `queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50. --- ##### `queues`^Optional ```typescript public readonly queues: number; ``` - *Type:* number `queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64. --- ### QuobyteVolumeSource Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const quobyteVolumeSource: k8s.QuobyteVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | registry | string | registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes. | | volume | string | volume is a string that references an already created Quobyte volume by name. | | group | string | group to map volume access to Default is no group. | | readOnly | boolean | readOnly here will force the Quobyte volume to be mounted with read-only permissions. | | tenant | string | tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin. | | user | string | user to map volume access to Defaults to serivceaccount user. | --- ##### `registry`^Required ```typescript public readonly registry: string; ``` - *Type:* string registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes. --- ##### `volume`^Required ```typescript public readonly volume: string; ``` - *Type:* string volume is a string that references an already created Quobyte volume by name. --- ##### `group`^Optional ```typescript public readonly group: string; ``` - *Type:* string - *Default:* no group group to map volume access to Default is no group. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false. readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. --- ##### `tenant`^Optional ```typescript public readonly tenant: string; ``` - *Type:* string tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin. --- ##### `user`^Optional ```typescript public readonly user: string; ``` - *Type:* string - *Default:* serivceaccount user user to map volume access to Defaults to serivceaccount user. --- ### RbdPersistentVolumeSource Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const rbdPersistentVolumeSource: k8s.RbdPersistentVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | image | string | image is the rados image name. | | monitors | string[] | monitors is a collection of Ceph monitors. | | fsType | string | fsType is the filesystem type of the volume that you want to mount. | | keyring | string | keyring is the path to key ring for RBDUser. | | pool | string | pool is the rados pool name. | | readOnly | boolean | readOnly here will force the ReadOnly setting in VolumeMounts. | | secretRef | cdk8s-plus-32.k8s.SecretReference | secretRef is name of the authentication secret for RBDUser. | | user | string | user is the rados user name. | --- ##### `image`^Required ```typescript public readonly image: string; ``` - *Type:* string image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ##### `monitors`^Required ```typescript public readonly monitors: string[]; ``` - *Type:* string[] monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd --- ##### `keyring`^Optional ```typescript public readonly keyring: string; ``` - *Type:* string - *Default:* etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ##### `pool`^Optional ```typescript public readonly pool: string; ``` - *Type:* string - *Default:* rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ##### `secretRef`^Optional ```typescript public readonly secretRef: SecretReference; ``` - *Type:* cdk8s-plus-32.k8s.SecretReference - *Default:* nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ##### `user`^Optional ```typescript public readonly user: string; ``` - *Type:* string - *Default:* admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ### RbdVolumeSource Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const rbdVolumeSource: k8s.RbdVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | image | string | image is the rados image name. | | monitors | string[] | monitors is a collection of Ceph monitors. | | fsType | string | fsType is the filesystem type of the volume that you want to mount. | | keyring | string | keyring is the path to key ring for RBDUser. | | pool | string | pool is the rados pool name. | | readOnly | boolean | readOnly here will force the ReadOnly setting in VolumeMounts. | | secretRef | cdk8s-plus-32.k8s.LocalObjectReference | secretRef is name of the authentication secret for RBDUser. | | user | string | user is the rados user name. | --- ##### `image`^Required ```typescript public readonly image: string; ``` - *Type:* string image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ##### `monitors`^Required ```typescript public readonly monitors: string[]; ``` - *Type:* string[] monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd --- ##### `keyring`^Optional ```typescript public readonly keyring: string; ``` - *Type:* string - *Default:* etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ##### `pool`^Optional ```typescript public readonly pool: string; ``` - *Type:* string - *Default:* rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ##### `secretRef`^Optional ```typescript public readonly secretRef: LocalObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.LocalObjectReference - *Default:* nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ##### `user`^Optional ```typescript public readonly user: string; ``` - *Type:* string - *Default:* admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it --- ### ReplicaSetSpec ReplicaSetSpec is the specification of a ReplicaSet. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const replicaSetSpec: k8s.ReplicaSetSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | selector | cdk8s-plus-32.k8s.LabelSelector | Selector is a label query over pods that should match the replica count. | | minReadySeconds | number | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. | | replicas | number | Replicas is the number of desired replicas. | | template | cdk8s-plus-32.k8s.PodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. | --- ##### `selector`^Required ```typescript public readonly selector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors --- ##### `minReadySeconds`^Optional ```typescript public readonly minReadySeconds: number; ``` - *Type:* number - *Default:* 0 (pod will be considered available as soon as it is ready) Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) --- ##### `replicas`^Optional ```typescript public readonly replicas: number; ``` - *Type:* number - *Default:* 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller --- ##### `template`^Optional ```typescript public readonly template: PodTemplateSpec; ``` - *Type:* cdk8s-plus-32.k8s.PodTemplateSpec Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template --- ### ReplicationControllerSpec ReplicationControllerSpec is the specification of a replication controller. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const replicationControllerSpec: k8s.ReplicationControllerSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | minReadySeconds | number | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. | | replicas | number | Replicas is the number of desired replicas. | | selector | {[ key: string ]: string} | Selector is a label query over pods that should match the Replicas count. | | template | cdk8s-plus-32.k8s.PodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. | --- ##### `minReadySeconds`^Optional ```typescript public readonly minReadySeconds: number; ``` - *Type:* number - *Default:* 0 (pod will be considered available as soon as it is ready) Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) --- ##### `replicas`^Optional ```typescript public readonly replicas: number; ``` - *Type:* number - *Default:* 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller --- ##### `selector`^Optional ```typescript public readonly selector: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors --- ##### `template`^Optional ```typescript public readonly template: PodTemplateSpec; ``` - *Type:* cdk8s-plus-32.k8s.PodTemplateSpec Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. The only allowed template.spec.restartPolicy value is "Always". More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template --- ### ResourceAttributes ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourceAttributes: k8s.ResourceAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fieldSelector | cdk8s-plus-32.k8s.FieldSelectorAttributes | fieldSelector describes the limitation on access based on field. It can only limit access, not broaden it. | | group | string | Group is the API Group of the Resource. | | labelSelector | cdk8s-plus-32.k8s.LabelSelectorAttributes | labelSelector describes the limitation on access based on labels. It can only limit access, not broaden it. | | name | string | Name is the name of the resource being requested for a "get" or deleted for a "delete". | | namespace | string | Namespace is the namespace of the action being requested. | | resource | string | Resource is one of the existing resource types. | | subresource | string | Subresource is one of the existing resource types. | | verb | string | Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. | | version | string | Version is the API Version of the Resource. | --- ##### `fieldSelector`^Optional ```typescript public readonly fieldSelector: FieldSelectorAttributes; ``` - *Type:* cdk8s-plus-32.k8s.FieldSelectorAttributes fieldSelector describes the limitation on access based on field. It can only limit access, not broaden it. This field is alpha-level. To use this field, you must enable the `AuthorizeWithSelectors` feature gate (disabled by default). --- ##### `group`^Optional ```typescript public readonly group: string; ``` - *Type:* string Group is the API Group of the Resource. "*" means all. --- ##### `labelSelector`^Optional ```typescript public readonly labelSelector: LabelSelectorAttributes; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelectorAttributes labelSelector describes the limitation on access based on labels. It can only limit access, not broaden it. This field is alpha-level. To use this field, you must enable the `AuthorizeWithSelectors` feature gate (disabled by default). --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview --- ##### `resource`^Optional ```typescript public readonly resource: string; ``` - *Type:* string Resource is one of the existing resource types. "*" means all. --- ##### `subresource`^Optional ```typescript public readonly subresource: string; ``` - *Type:* string Subresource is one of the existing resource types. "" means none. --- ##### `verb`^Optional ```typescript public readonly verb: string; ``` - *Type:* string Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. --- ##### `version`^Optional ```typescript public readonly version: string; ``` - *Type:* string Version is the API Version of the Resource. "*" means all. --- ### ResourceClaim ResourceClaim references one entry in PodSpec.ResourceClaims. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourceClaim: k8s.ResourceClaim = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. | | request | string | Request is the name chosen for a request in the referenced claim. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. --- ##### `request`^Optional ```typescript public readonly request: string; ``` - *Type:* string Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request. --- ### ResourceClaimSpecV1Alpha3 ResourceClaimSpec defines what is being requested in a ResourceClaim and how to configure it. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourceClaimSpecV1Alpha3: k8s.ResourceClaimSpecV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | devices | cdk8s-plus-32.k8s.DeviceClaimV1Alpha3 | Devices defines how to request devices. | --- ##### `devices`^Optional ```typescript public readonly devices: DeviceClaimV1Alpha3; ``` - *Type:* cdk8s-plus-32.k8s.DeviceClaimV1Alpha3 Devices defines how to request devices. --- ### ResourceClaimSpecV1Beta1 ResourceClaimSpec defines what is being requested in a ResourceClaim and how to configure it. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourceClaimSpecV1Beta1: k8s.ResourceClaimSpecV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | devices | cdk8s-plus-32.k8s.DeviceClaimV1Beta1 | Devices defines how to request devices. | --- ##### `devices`^Optional ```typescript public readonly devices: DeviceClaimV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.DeviceClaimV1Beta1 Devices defines how to request devices. --- ### ResourceClaimTemplateSpecV1Alpha3 ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourceClaimTemplateSpecV1Alpha3: k8s.ResourceClaimTemplateSpecV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.ResourceClaimSpecV1Alpha3 | Spec for the ResourceClaim. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | ObjectMeta may contain labels and annotations that will be copied into the ResourceClaim when creating it. | --- ##### `spec`^Required ```typescript public readonly spec: ResourceClaimSpecV1Alpha3; ``` - *Type:* cdk8s-plus-32.k8s.ResourceClaimSpecV1Alpha3 Spec for the ResourceClaim. The entire content is copied unchanged into the ResourceClaim that gets created from this template. The same fields as in a ResourceClaim are also valid here. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta ObjectMeta may contain labels and annotations that will be copied into the ResourceClaim when creating it. No other fields are allowed and will be rejected during validation. --- ### ResourceClaimTemplateSpecV1Beta1 ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourceClaimTemplateSpecV1Beta1: k8s.ResourceClaimTemplateSpecV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | spec | cdk8s-plus-32.k8s.ResourceClaimSpecV1Beta1 | Spec for the ResourceClaim. | | metadata | cdk8s-plus-32.k8s.ObjectMeta | ObjectMeta may contain labels and annotations that will be copied into the ResourceClaim when creating it. | --- ##### `spec`^Required ```typescript public readonly spec: ResourceClaimSpecV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.ResourceClaimSpecV1Beta1 Spec for the ResourceClaim. The entire content is copied unchanged into the ResourceClaim that gets created from this template. The same fields as in a ResourceClaim are also valid here. --- ##### `metadata`^Optional ```typescript public readonly metadata: ObjectMeta; ``` - *Type:* cdk8s-plus-32.k8s.ObjectMeta ObjectMeta may contain labels and annotations that will be copied into the ResourceClaim when creating it. No other fields are allowed and will be rejected during validation. --- ### ResourceFieldSelector ResourceFieldSelector represents container resources (cpu, memory) and their output format. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourceFieldSelector: k8s.ResourceFieldSelector = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | resource | string | Required: resource to select. | | containerName | string | Container name: required for volumes, optional for env vars. | | divisor | cdk8s-plus-32.k8s.Quantity | Specifies the output format of the exposed resources, defaults to "1". | --- ##### `resource`^Required ```typescript public readonly resource: string; ``` - *Type:* string Required: resource to select. --- ##### `containerName`^Optional ```typescript public readonly containerName: string; ``` - *Type:* string Container name: required for volumes, optional for env vars. --- ##### `divisor`^Optional ```typescript public readonly divisor: Quantity; ``` - *Type:* cdk8s-plus-32.k8s.Quantity Specifies the output format of the exposed resources, defaults to "1". --- ### ResourceMetricSourceV2 ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourceMetricSourceV2: k8s.ResourceMetricSourceV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | name is the name of the resource in question. | | target | cdk8s-plus-32.k8s.MetricTargetV2 | target specifies the target value for the given metric. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name is the name of the resource in question. --- ##### `target`^Required ```typescript public readonly target: MetricTargetV2; ``` - *Type:* cdk8s-plus-32.k8s.MetricTargetV2 target specifies the target value for the given metric. --- ### ResourcePolicyRule ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) either (d1) the request does not specify a namespace (i.e., `Namespace==""`) and clusterScope is true or (d2) the request specifies a namespace and least one member of namespaces matches the request's namespace. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourcePolicyRule: k8s.ResourcePolicyRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiGroups | string[] | `apiGroups` is a list of matching API groups and may not be empty. | | resources | string[] | `resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required. | | verbs | string[] | `verbs` is a list of matching verbs and may not be empty. | | clusterScope | boolean | `clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). | | namespaces | string[] | `namespaces` is a list of target namespaces that restricts matches. | --- ##### `apiGroups`^Required ```typescript public readonly apiGroups: string[]; ``` - *Type:* string[] `apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required. --- ##### `resources`^Required ```typescript public readonly resources: string[]; ``` - *Type:* string[] `resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required. --- ##### `verbs`^Required ```typescript public readonly verbs: string[]; ``` - *Type:* string[] `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required. --- ##### `clusterScope`^Optional ```typescript public readonly clusterScope: boolean; ``` - *Type:* boolean `clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list. --- ##### `namespaces`^Optional ```typescript public readonly namespaces: string[]; ``` - *Type:* string[] `namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true. --- ### ResourcePoolV1Alpha3 ResourcePool describes the pool that ResourceSlices belong to. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourcePoolV1Alpha3: k8s.ResourcePoolV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | generation | number | Generation tracks the change in a pool over time. | | name | string | Name is used to identify the pool. | | resourceSliceCount | number | ResourceSliceCount is the total number of ResourceSlices in the pool at this generation number. Must be greater than zero. | --- ##### `generation`^Required ```typescript public readonly generation: number; ``` - *Type:* number Generation tracks the change in a pool over time. Whenever a driver changes something about one or more of the resources in a pool, it must change the generation in all ResourceSlices which are part of that pool. Consumers of ResourceSlices should only consider resources from the pool with the highest generation number. The generation may be reset by drivers, which should be fine for consumers, assuming that all ResourceSlices in a pool are updated to match or deleted. Combined with ResourceSliceCount, this mechanism enables consumers to detect pools which are comprised of multiple ResourceSlices and are in an incomplete state. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is used to identify the pool. For node-local devices, this is often the node name, but this is not required. It must not be longer than 253 characters and must consist of one or more DNS sub-domains separated by slashes. This field is immutable. --- ##### `resourceSliceCount`^Required ```typescript public readonly resourceSliceCount: number; ``` - *Type:* number ResourceSliceCount is the total number of ResourceSlices in the pool at this generation number. Must be greater than zero. Consumers can use this to check whether they have seen all ResourceSlices belonging to the same pool. --- ### ResourcePoolV1Beta1 ResourcePool describes the pool that ResourceSlices belong to. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourcePoolV1Beta1: k8s.ResourcePoolV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | generation | number | Generation tracks the change in a pool over time. | | name | string | Name is used to identify the pool. | | resourceSliceCount | number | ResourceSliceCount is the total number of ResourceSlices in the pool at this generation number. Must be greater than zero. | --- ##### `generation`^Required ```typescript public readonly generation: number; ``` - *Type:* number Generation tracks the change in a pool over time. Whenever a driver changes something about one or more of the resources in a pool, it must change the generation in all ResourceSlices which are part of that pool. Consumers of ResourceSlices should only consider resources from the pool with the highest generation number. The generation may be reset by drivers, which should be fine for consumers, assuming that all ResourceSlices in a pool are updated to match or deleted. Combined with ResourceSliceCount, this mechanism enables consumers to detect pools which are comprised of multiple ResourceSlices and are in an incomplete state. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is used to identify the pool. For node-local devices, this is often the node name, but this is not required. It must not be longer than 253 characters and must consist of one or more DNS sub-domains separated by slashes. This field is immutable. --- ##### `resourceSliceCount`^Required ```typescript public readonly resourceSliceCount: number; ``` - *Type:* number ResourceSliceCount is the total number of ResourceSlices in the pool at this generation number. Must be greater than zero. Consumers can use this to check whether they have seen all ResourceSlices belonging to the same pool. --- ### ResourceProps Initialization properties for resources. #### Initializer ```typescript import { ResourceProps } from 'cdk8s-plus-32' const resourceProps: ResourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ### ResourceQuotaSpec ResourceQuotaSpec defines the desired hard limits to enforce for Quota. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourceQuotaSpec: k8s.ResourceQuotaSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | hard | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | hard is the set of desired hard limits for each named resource. | | scopes | string[] | A collection of filters that must match each object tracked by a quota. | | scopeSelector | cdk8s-plus-32.k8s.ScopeSelector | scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. | --- ##### `hard`^Optional ```typescript public readonly hard: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ --- ##### `scopes`^Optional ```typescript public readonly scopes: string[]; ``` - *Type:* string[] A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. --- ##### `scopeSelector`^Optional ```typescript public readonly scopeSelector: ScopeSelector; ``` - *Type:* cdk8s-plus-32.k8s.ScopeSelector scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. --- ### ResourceRequirements ResourceRequirements describes the compute resource requirements. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourceRequirements: k8s.ResourceRequirements = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | claims | cdk8s-plus-32.k8s.ResourceClaim[] | Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. | | limits | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | Limits describes the maximum amount of compute resources allowed. | | requests | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | Requests describes the minimum amount of compute resources required. | --- ##### `claims`^Optional ```typescript public readonly claims: ResourceClaim[]; ``` - *Type:* cdk8s-plus-32.k8s.ResourceClaim[] Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. --- ##### `limits`^Optional ```typescript public readonly limits: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ --- ##### `requests`^Optional ```typescript public readonly requests: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ --- ### ResourceSliceSpecV1Alpha3 ResourceSliceSpec contains the information published by the driver in one ResourceSlice. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourceSliceSpecV1Alpha3: k8s.ResourceSliceSpecV1Alpha3 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | driver | string | Driver identifies the DRA driver providing the capacity information. | | pool | cdk8s-plus-32.k8s.ResourcePoolV1Alpha3 | Pool describes the pool that this ResourceSlice belongs to. | | allNodes | boolean | AllNodes indicates that all nodes have access to the resources in the pool. | | devices | cdk8s-plus-32.k8s.DeviceV1Alpha3[] | Devices lists some or all of the devices in this pool. | | nodeName | string | NodeName identifies the node which provides the resources in this pool. | | nodeSelector | cdk8s-plus-32.k8s.NodeSelector | NodeSelector defines which nodes have access to the resources in the pool, when that pool is not limited to a single node. | --- ##### `driver`^Required ```typescript public readonly driver: string; ``` - *Type:* string Driver identifies the DRA driver providing the capacity information. A field selector can be used to list only ResourceSlice objects with a certain driver name. Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver. This field is immutable. --- ##### `pool`^Required ```typescript public readonly pool: ResourcePoolV1Alpha3; ``` - *Type:* cdk8s-plus-32.k8s.ResourcePoolV1Alpha3 Pool describes the pool that this ResourceSlice belongs to. --- ##### `allNodes`^Optional ```typescript public readonly allNodes: boolean; ``` - *Type:* boolean AllNodes indicates that all nodes have access to the resources in the pool. Exactly one of NodeName, NodeSelector and AllNodes must be set. --- ##### `devices`^Optional ```typescript public readonly devices: DeviceV1Alpha3[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceV1Alpha3[] Devices lists some or all of the devices in this pool. Must not have more than 128 entries. --- ##### `nodeName`^Optional ```typescript public readonly nodeName: string; ``` - *Type:* string NodeName identifies the node which provides the resources in this pool. A field selector can be used to list only ResourceSlice objects belonging to a certain node. This field can be used to limit access from nodes to ResourceSlices with the same node name. It also indicates to autoscalers that adding new nodes of the same type as some old node might also make new resources available. Exactly one of NodeName, NodeSelector and AllNodes must be set. This field is immutable. --- ##### `nodeSelector`^Optional ```typescript public readonly nodeSelector: NodeSelector; ``` - *Type:* cdk8s-plus-32.k8s.NodeSelector NodeSelector defines which nodes have access to the resources in the pool, when that pool is not limited to a single node. Must use exactly one term. Exactly one of NodeName, NodeSelector and AllNodes must be set. --- ### ResourceSliceSpecV1Beta1 ResourceSliceSpec contains the information published by the driver in one ResourceSlice. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const resourceSliceSpecV1Beta1: k8s.ResourceSliceSpecV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | driver | string | Driver identifies the DRA driver providing the capacity information. | | pool | cdk8s-plus-32.k8s.ResourcePoolV1Beta1 | Pool describes the pool that this ResourceSlice belongs to. | | allNodes | boolean | AllNodes indicates that all nodes have access to the resources in the pool. | | devices | cdk8s-plus-32.k8s.DeviceV1Beta1[] | Devices lists some or all of the devices in this pool. | | nodeName | string | NodeName identifies the node which provides the resources in this pool. | | nodeSelector | cdk8s-plus-32.k8s.NodeSelector | NodeSelector defines which nodes have access to the resources in the pool, when that pool is not limited to a single node. | --- ##### `driver`^Required ```typescript public readonly driver: string; ``` - *Type:* string Driver identifies the DRA driver providing the capacity information. A field selector can be used to list only ResourceSlice objects with a certain driver name. Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver. This field is immutable. --- ##### `pool`^Required ```typescript public readonly pool: ResourcePoolV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.ResourcePoolV1Beta1 Pool describes the pool that this ResourceSlice belongs to. --- ##### `allNodes`^Optional ```typescript public readonly allNodes: boolean; ``` - *Type:* boolean AllNodes indicates that all nodes have access to the resources in the pool. Exactly one of NodeName, NodeSelector and AllNodes must be set. --- ##### `devices`^Optional ```typescript public readonly devices: DeviceV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.DeviceV1Beta1[] Devices lists some or all of the devices in this pool. Must not have more than 128 entries. --- ##### `nodeName`^Optional ```typescript public readonly nodeName: string; ``` - *Type:* string NodeName identifies the node which provides the resources in this pool. A field selector can be used to list only ResourceSlice objects belonging to a certain node. This field can be used to limit access from nodes to ResourceSlices with the same node name. It also indicates to autoscalers that adding new nodes of the same type as some old node might also make new resources available. Exactly one of NodeName, NodeSelector and AllNodes must be set. This field is immutable. --- ##### `nodeSelector`^Optional ```typescript public readonly nodeSelector: NodeSelector; ``` - *Type:* cdk8s-plus-32.k8s.NodeSelector NodeSelector defines which nodes have access to the resources in the pool, when that pool is not limited to a single node. Must use exactly one term. Exactly one of NodeName, NodeSelector and AllNodes must be set. --- ### RoleBindingProps Properties for `RoleBinding`. #### Initializer ```typescript import { RoleBindingProps } from 'cdk8s-plus-32' const roleBindingProps: RoleBindingProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | role | IRole | The role to bind to. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `role`^Required ```typescript public readonly role: IRole; ``` - *Type:* IRole The role to bind to. A RoleBinding can reference a Role or a ClusterRole. --- ### RolePolicyRule Policy rule of a `Role. #### Initializer ```typescript import { RolePolicyRule } from 'cdk8s-plus-32' const rolePolicyRule: RolePolicyRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | resources | IApiResource[] | Resources this rule applies to. | | verbs | string[] | Verbs to allow. | --- ##### `resources`^Required ```typescript public readonly resources: IApiResource[]; ``` - *Type:* IApiResource[] Resources this rule applies to. --- ##### `verbs`^Required ```typescript public readonly verbs: string[]; ``` - *Type:* string[] Verbs to allow. (e.g ['get', 'watch']) --- ### RoleProps Properties for `Role`. #### Initializer ```typescript import { RoleProps } from 'cdk8s-plus-32' const roleProps: RoleProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | rules | RolePolicyRule[] | A list of rules the role should allow. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `rules`^Optional ```typescript public readonly rules: RolePolicyRule[]; ``` - *Type:* RolePolicyRule[] - *Default:* [] A list of rules the role should allow. --- ### RoleRef RoleRef contains information that points to the role being used. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const roleRef: k8s.RoleRef = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiGroup | string | APIGroup is the group for the resource being referenced. | | kind | string | Kind is the type of resource being referenced. | | name | string | Name is the name of resource being referenced. | --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string APIGroup is the group for the resource being referenced. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string Kind is the type of resource being referenced. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is the name of resource being referenced. --- ### RollingUpdateDaemonSet Spec to control the desired behavior of daemon set rolling update. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const rollingUpdateDaemonSet: k8s.RollingUpdateDaemonSet = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maxSurge | cdk8s-plus-32.k8s.IntOrString | The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. | | maxUnavailable | cdk8s-plus-32.k8s.IntOrString | The maximum number of DaemonSet pods that can be unavailable during the update. | --- ##### `maxSurge`^Optional ```typescript public readonly maxSurge: IntOrString; ``` - *Type:* cdk8s-plus-32.k8s.IntOrString The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption. --- ##### `maxUnavailable`^Optional ```typescript public readonly maxUnavailable: IntOrString; ``` - *Type:* cdk8s-plus-32.k8s.IntOrString The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0 if MaxSurge is 0 Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. --- ### RollingUpdateDeployment Spec to control the desired behavior of rolling update. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const rollingUpdateDeployment: k8s.RollingUpdateDeployment = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maxSurge | cdk8s-plus-32.k8s.IntOrString | The maximum number of pods that can be scheduled above the desired number of pods. | | maxUnavailable | cdk8s-plus-32.k8s.IntOrString | The maximum number of pods that can be unavailable during the update. | --- ##### `maxSurge`^Optional ```typescript public readonly maxSurge: IntOrString; ``` - *Type:* cdk8s-plus-32.k8s.IntOrString - *Default:* 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. --- ##### `maxUnavailable`^Optional ```typescript public readonly maxUnavailable: IntOrString; ``` - *Type:* cdk8s-plus-32.k8s.IntOrString - *Default:* 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. --- ### RollingUpdateStatefulSetStrategy RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const rollingUpdateStatefulSetStrategy: k8s.RollingUpdateStatefulSetStrategy = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maxUnavailable | cdk8s-plus-32.k8s.IntOrString | The maximum number of pods that can be unavailable during the update. | | partition | number | Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. | --- ##### `maxUnavailable`^Optional ```typescript public readonly maxUnavailable: IntOrString; ``` - *Type:* cdk8s-plus-32.k8s.IntOrString - *Default:* 1. This field is alpha-level and is only honored by servers that enable the MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it will be counted towards MaxUnavailable. The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0. Defaults to 1. This field is alpha-level and is only honored by servers that enable the MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it will be counted towards MaxUnavailable. --- ##### `partition`^Optional ```typescript public readonly partition: number; ``` - *Type:* number Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0. --- ### RuleWithOperations RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const ruleWithOperations: k8s.RuleWithOperations = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiGroups | string[] | APIGroups is the API groups the resources belong to. | | apiVersions | string[] | APIVersions is the API versions the resources belong to. | | operations | string[] | Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. | | resources | string[] | Resources is a list of resources this rule applies to. | | scope | string | scope specifies the scope of this rule. | --- ##### `apiGroups`^Optional ```typescript public readonly apiGroups: string[]; ``` - *Type:* string[] APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required. --- ##### `apiVersions`^Optional ```typescript public readonly apiVersions: string[]; ``` - *Type:* string[] APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required. --- ##### `operations`^Optional ```typescript public readonly operations: string[]; ``` - *Type:* string[] Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required. --- ##### `resources`^Optional ```typescript public readonly resources: string[]; ``` - *Type:* string[] Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '_/scale' means all scale subresources. '_/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required. --- ##### `scope`^Optional ```typescript public readonly scope: string; ``` - *Type:* string - *Default:* . scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". --- ### ScaleIoPersistentVolumeSource ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const scaleIoPersistentVolumeSource: k8s.ScaleIoPersistentVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | gateway | string | gateway is the host address of the ScaleIO API Gateway. | | secretRef | cdk8s-plus-32.k8s.SecretReference | secretRef references to the secret for ScaleIO user and other sensitive information. | | system | string | system is the name of the storage system as configured in ScaleIO. | | fsType | string | fsType is the filesystem type to mount. | | protectionDomain | string | protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. | | readOnly | boolean | readOnly defaults to false (read/write). | | sslEnabled | boolean | sslEnabled is the flag to enable/disable SSL communication with Gateway, default false. | | storageMode | string | storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. | | storagePool | string | storagePool is the ScaleIO Storage Pool associated with the protection domain. | | volumeName | string | volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. | --- ##### `gateway`^Required ```typescript public readonly gateway: string; ``` - *Type:* string gateway is the host address of the ScaleIO API Gateway. --- ##### `secretRef`^Required ```typescript public readonly secretRef: SecretReference; ``` - *Type:* cdk8s-plus-32.k8s.SecretReference secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. --- ##### `system`^Required ```typescript public readonly system: string; ``` - *Type:* string system is the name of the storage system as configured in ScaleIO. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string - *Default:* xfs" fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs" --- ##### `protectionDomain`^Optional ```typescript public readonly protectionDomain: string; ``` - *Type:* string protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ##### `sslEnabled`^Optional ```typescript public readonly sslEnabled: boolean; ``` - *Type:* boolean sslEnabled is the flag to enable/disable SSL communication with Gateway, default false. --- ##### `storageMode`^Optional ```typescript public readonly storageMode: string; ``` - *Type:* string - *Default:* ThinProvisioned. storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. --- ##### `storagePool`^Optional ```typescript public readonly storagePool: string; ``` - *Type:* string storagePool is the ScaleIO Storage Pool associated with the protection domain. --- ##### `volumeName`^Optional ```typescript public readonly volumeName: string; ``` - *Type:* string volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. --- ### ScaleIoVolumeSource ScaleIOVolumeSource represents a persistent ScaleIO volume. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const scaleIoVolumeSource: k8s.ScaleIoVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | gateway | string | gateway is the host address of the ScaleIO API Gateway. | | secretRef | cdk8s-plus-32.k8s.LocalObjectReference | secretRef references to the secret for ScaleIO user and other sensitive information. | | system | string | system is the name of the storage system as configured in ScaleIO. | | fsType | string | fsType is the filesystem type to mount. | | protectionDomain | string | protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. | | readOnly | boolean | readOnly Defaults to false (read/write). | | sslEnabled | boolean | sslEnabled Flag enable/disable SSL communication with Gateway, default false. | | storageMode | string | storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. | | storagePool | string | storagePool is the ScaleIO Storage Pool associated with the protection domain. | | volumeName | string | volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. | --- ##### `gateway`^Required ```typescript public readonly gateway: string; ``` - *Type:* string gateway is the host address of the ScaleIO API Gateway. --- ##### `secretRef`^Required ```typescript public readonly secretRef: LocalObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.LocalObjectReference secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. --- ##### `system`^Required ```typescript public readonly system: string; ``` - *Type:* string system is the name of the storage system as configured in ScaleIO. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string - *Default:* xfs". fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". --- ##### `protectionDomain`^Optional ```typescript public readonly protectionDomain: string; ``` - *Type:* string protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ##### `sslEnabled`^Optional ```typescript public readonly sslEnabled: boolean; ``` - *Type:* boolean sslEnabled Flag enable/disable SSL communication with Gateway, default false. --- ##### `storageMode`^Optional ```typescript public readonly storageMode: string; ``` - *Type:* string - *Default:* ThinProvisioned. storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. --- ##### `storagePool`^Optional ```typescript public readonly storagePool: string; ``` - *Type:* string storagePool is the ScaleIO Storage Pool associated with the protection domain. --- ##### `volumeName`^Optional ```typescript public readonly volumeName: string; ``` - *Type:* string volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. --- ### ScaleSpec ScaleSpec describes the attributes of a scale subresource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const scaleSpec: k8s.ScaleSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | replicas | number | replicas is the desired number of instances for the scaled object. | --- ##### `replicas`^Optional ```typescript public readonly replicas: number; ``` - *Type:* number replicas is the desired number of instances for the scaled object. --- ### ScalingPolicy #### Initializer ```typescript import { ScalingPolicy } from 'cdk8s-plus-32' const scalingPolicy: ScalingPolicy = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | replicas | Replicas | The type and quantity of replicas to change. | | duration | cdk8s.Duration | The amount of time the scaling policy has to continue scaling before the target metric must be revalidated. | --- ##### `replicas`^Required ```typescript public readonly replicas: Replicas; ``` - *Type:* Replicas The type and quantity of replicas to change. --- ##### `duration`^Optional ```typescript public readonly duration: Duration; ``` - *Type:* cdk8s.Duration - *Default:* 15 seconds The amount of time the scaling policy has to continue scaling before the target metric must be revalidated. Must be greater than 0 seconds and no longer than 30 minutes. --- ### ScalingRules Defines the scaling behavior for one direction. #### Initializer ```typescript import { ScalingRules } from 'cdk8s-plus-32' const scalingRules: ScalingRules = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | policies | ScalingPolicy[] | The scaling policies. | | stabilizationWindow | cdk8s.Duration | Defines the window of past metrics that the autoscaler should consider when calculating wether or not autoscaling should occur. | | strategy | ScalingStrategy | The strategy to use when scaling. | --- ##### `policies`^Optional ```typescript public readonly policies: ScalingPolicy[]; ``` - *Type:* ScalingPolicy[] - *Default:* * Scale up * Increase no more than 4 pods per 60 seconds * Double the number of pods per 60 seconds * Scale down * Decrease to minReplica count The scaling policies. --- ##### `stabilizationWindow`^Optional ```typescript public readonly stabilizationWindow: Duration; ``` - *Type:* cdk8s.Duration - *Default:* * On scale down no stabilization is performed. * On scale up stabilization is performed for 5 minutes. Defines the window of past metrics that the autoscaler should consider when calculating wether or not autoscaling should occur. Minimum duration is 1 second, max is 1 hour. --- *Example* ```typescript stabilizationWindow: Duration.minutes(30) // Autoscaler considers the last 30 minutes of metrics when deciding whether to scale. ``` ##### `strategy`^Optional ```typescript public readonly strategy: ScalingStrategy; ``` - *Type:* ScalingStrategy - *Default:* MAX_CHANGE The strategy to use when scaling. --- ### ScalingTarget Properties used to configure the target of an Autoscaler. #### Initializer ```typescript import { ScalingTarget } from 'cdk8s-plus-32' const scalingTarget: ScalingTarget = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | The object's API version (e.g. "authorization.k8s.io/v1"). | | containers | Container[] | Container definitions associated with the target. | | kind | string | The object kind (e.g. "Deployment"). | | name | string | The Kubernetes name of this resource. | | replicas | number | The fixed number of replicas defined on the target. | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `containers`^Required ```typescript public readonly containers: Container[]; ``` - *Type:* Container[] Container definitions associated with the target. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The Kubernetes name of this resource. --- ##### `replicas`^Optional ```typescript public readonly replicas: number; ``` - *Type:* number The fixed number of replicas defined on the target. This is used for validation purposes as Scalable targets should not have a fixed number of replicas. --- ### Scheduling Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const scheduling: k8s.Scheduling = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nodeSelector | {[ key: string ]: string} | nodeSelector lists labels that must be present on nodes that support this RuntimeClass. | | tolerations | cdk8s-plus-32.k8s.Toleration[] | tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. | --- ##### `nodeSelector`^Optional ```typescript public readonly nodeSelector: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. --- ##### `tolerations`^Optional ```typescript public readonly tolerations: Toleration[]; ``` - *Type:* cdk8s-plus-32.k8s.Toleration[] tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. --- ### ScopedResourceSelectorRequirement A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const scopedResourceSelectorRequirement: k8s.ScopedResourceSelectorRequirement = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | operator | string | Represents a scope's relationship to a set of values. | | scopeName | string | The name of the scope that the selector applies to. | | values | string[] | An array of string values. | --- ##### `operator`^Required ```typescript public readonly operator: string; ``` - *Type:* string Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. --- ##### `scopeName`^Required ```typescript public readonly scopeName: string; ``` - *Type:* string The name of the scope that the selector applies to. --- ##### `values`^Optional ```typescript public readonly values: string[]; ``` - *Type:* string[] An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. --- ### ScopeSelector A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const scopeSelector: k8s.ScopeSelector = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | matchExpressions | cdk8s-plus-32.k8s.ScopedResourceSelectorRequirement[] | A list of scope selector requirements by scope of the resources. | --- ##### `matchExpressions`^Optional ```typescript public readonly matchExpressions: ScopedResourceSelectorRequirement[]; ``` - *Type:* cdk8s-plus-32.k8s.ScopedResourceSelectorRequirement[] A list of scope selector requirements by scope of the resources. --- ### SeccompProfile #### Initializer ```typescript import { SeccompProfile } from 'cdk8s-plus-32' const seccompProfile: SeccompProfile = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | SeccompProfileType | Indicates which kind of seccomp profile will be applied. | | localhostProfile | string | localhostProfile indicates a profile defined in a file on the node should be used. | --- ##### `type`^Required ```typescript public readonly type: SeccompProfileType; ``` - *Type:* SeccompProfileType Indicates which kind of seccomp profile will be applied. --- ##### `localhostProfile`^Optional ```typescript public readonly localhostProfile: string; ``` - *Type:* string - *Default:* empty string localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". --- ### SeccompProfile SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const seccompProfile: k8s.SeccompProfile = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | type indicates which kind of seccomp profile will be applied. Valid options are:. | | localhostProfile | string | localhostProfile indicates a profile defined in a file on the node should be used. | --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string type indicates which kind of seccomp profile will be applied. Valid options are:. Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. --- ##### `localhostProfile`^Optional ```typescript public readonly localhostProfile: string; ``` - *Type:* string localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. --- ### SecretEnvSource SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const secretEnvSource: k8s.SecretEnvSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name of the referent. | | optional | boolean | Specify whether the Secret must be defined. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean Specify whether the Secret must be defined. --- ### SecretKeySelector SecretKeySelector selects a key of a Secret. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const secretKeySelector: k8s.SecretKeySelector = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | The key of the secret to select from. | | name | string | Name of the referent. | | optional | boolean | Specify whether the Secret or its key must be defined. | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string The key of the secret to select from. Must be a valid secret key. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean Specify whether the Secret or its key must be defined. --- ### SecretProjection Adapts a secret into a projected volume. The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const secretProjection: k8s.SecretProjection = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | items | cdk8s-plus-32.k8s.KeyToPath[] | items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. | | name | string | Name of the referent. | | optional | boolean | optional field specify whether the Secret or its key must be defined. | --- ##### `items`^Optional ```typescript public readonly items: KeyToPath[]; ``` - *Type:* cdk8s-plus-32.k8s.KeyToPath[] items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean optional field specify whether the Secret or its key must be defined. --- ### SecretProps Options for `Secret`. #### Initializer ```typescript import { SecretProps } from 'cdk8s-plus-32' const secretProps: SecretProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | stringData | {[ key: string ]: string} | stringData allows specifying non-binary secret data in string form. | | type | string | Optional type associated with the secret. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional ```typescript public readonly immutable: boolean; ``` - *Type:* boolean - *Default:* false If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. --- ##### `stringData`^Optional ```typescript public readonly stringData: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API. --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string - *Default:* undefined - Don't set a type. Optional type associated with the secret. Used to facilitate programmatic handling of secret data by various controllers. --- ### SecretReference SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const secretReference: k8s.SecretReference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | name is unique within a namespace to reference a secret resource. | | namespace | string | namespace defines the space within which the secret name must be unique. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string name is unique within a namespace to reference a secret resource. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string namespace defines the space within which the secret name must be unique. --- ### SecretValue Represents a specific value in JSON secret. #### Initializer ```typescript import { SecretValue } from 'cdk8s-plus-32' const secretValue: SecretValue = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | The JSON key. | | secret | ISecret | The secret. | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string The JSON key. --- ##### `secret`^Required ```typescript public readonly secret: ISecret; ``` - *Type:* ISecret The secret. --- ### SecretVolumeOptions Options for the Secret-based volume. #### Initializer ```typescript import { SecretVolumeOptions } from 'cdk8s-plus-32' const secretVolumeOptions: SecretVolumeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultMode | number | Mode bits to use on created files by default. | | items | {[ key: string ]: PathMapping} | If unspecified, each key-value pair in the Data field of the referenced secret will be projected into the volume as a file whose name is the key and content is the value. | | name | string | The volume name. | | optional | boolean | Specify whether the secret or its keys must be defined. | --- ##### `defaultMode`^Optional ```typescript public readonly defaultMode: number; ``` - *Type:* number - *Default:* 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. --- ##### `items`^Optional ```typescript public readonly items: {[ key: string ]: PathMapping}; ``` - *Type:* {[ key: string ]: PathMapping} - *Default:* no mapping If unspecified, each key-value pair in the Data field of the referenced secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* auto-generated The volume name. --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean - *Default:* undocumented Specify whether the secret or its keys must be defined. --- ### SecretVolumeSource Adapts a Secret into a volume. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const secretVolumeSource: k8s.SecretVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultMode | number | defaultMode is Optional: mode bits used to set permissions on created files by default. | | items | cdk8s-plus-32.k8s.KeyToPath[] | items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. | | optional | boolean | optional field specify whether the Secret or its keys must be defined. | | secretName | string | secretName is the name of the secret in the pod's namespace to use. | --- ##### `defaultMode`^Optional ```typescript public readonly defaultMode: number; ``` - *Type:* number - *Default:* 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. --- ##### `items`^Optional ```typescript public readonly items: KeyToPath[]; ``` - *Type:* cdk8s-plus-32.k8s.KeyToPath[] items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. --- ##### `optional`^Optional ```typescript public readonly optional: boolean; ``` - *Type:* boolean optional field specify whether the Secret or its keys must be defined. --- ##### `secretName`^Optional ```typescript public readonly secretName: string; ``` - *Type:* string secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret --- ### SecurityContext SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const securityContext: k8s.SecurityContext = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allowPrivilegeEscalation | boolean | AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. | | appArmorProfile | cdk8s-plus-32.k8s.AppArmorProfile | appArmorProfile is the AppArmor options to use by this container. | | capabilities | cdk8s-plus-32.k8s.Capabilities | The capabilities to add/drop when running containers. | | privileged | boolean | Run container in privileged mode. | | procMount | string | procMount denotes the type of proc mount to use for the containers. | | readOnlyRootFilesystem | boolean | Whether this container has a read-only root filesystem. | | runAsGroup | number | The GID to run the entrypoint of the container process. | | runAsNonRoot | boolean | Indicates that the container must run as a non-root user. | | runAsUser | number | The UID to run the entrypoint of the container process. | | seccompProfile | cdk8s-plus-32.k8s.SeccompProfile | The seccomp options to use by this container. | | seLinuxOptions | cdk8s-plus-32.k8s.SeLinuxOptions | The SELinux context to be applied to the container. | | windowsOptions | cdk8s-plus-32.k8s.WindowsSecurityContextOptions | The Windows specific settings applied to all containers. | --- ##### `allowPrivilegeEscalation`^Optional ```typescript public readonly allowPrivilegeEscalation: boolean; ``` - *Type:* boolean AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. --- ##### `appArmorProfile`^Optional ```typescript public readonly appArmorProfile: AppArmorProfile; ``` - *Type:* cdk8s-plus-32.k8s.AppArmorProfile appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows. --- ##### `capabilities`^Optional ```typescript public readonly capabilities: Capabilities; ``` - *Type:* cdk8s-plus-32.k8s.Capabilities - *Default:* the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows. The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows. --- ##### `privileged`^Optional ```typescript public readonly privileged: boolean; ``` - *Type:* boolean - *Default:* false. Note that this field cannot be set when spec.os.name is windows. Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows. --- ##### `procMount`^Optional ```typescript public readonly procMount: string; ``` - *Type:* string procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows. --- ##### `readOnlyRootFilesystem`^Optional ```typescript public readonly readOnlyRootFilesystem: boolean; ``` - *Type:* boolean - *Default:* false. Note that this field cannot be set when spec.os.name is windows. Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows. --- ##### `runAsGroup`^Optional ```typescript public readonly runAsGroup: number; ``` - *Type:* number The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. --- ##### `runAsNonRoot`^Optional ```typescript public readonly runAsNonRoot: boolean; ``` - *Type:* boolean Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. --- ##### `runAsUser`^Optional ```typescript public readonly runAsUser: number; ``` - *Type:* number - *Default:* user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. --- ##### `seccompProfile`^Optional ```typescript public readonly seccompProfile: SeccompProfile; ``` - *Type:* cdk8s-plus-32.k8s.SeccompProfile The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows. --- ##### `seLinuxOptions`^Optional ```typescript public readonly seLinuxOptions: SeLinuxOptions; ``` - *Type:* cdk8s-plus-32.k8s.SeLinuxOptions The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. --- ##### `windowsOptions`^Optional ```typescript public readonly windowsOptions: WindowsSecurityContextOptions; ``` - *Type:* cdk8s-plus-32.k8s.WindowsSecurityContextOptions The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. --- ### SelectableField SelectableField specifies the JSON path of a field that may be used with field selectors. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const selectableField: k8s.SelectableField = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | jsonPath | string | jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. | --- ##### `jsonPath`^Required ```typescript public readonly jsonPath: string; ``` - *Type:* string jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metdata fields. Required. --- ### SelfSubjectAccessReviewSpec SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const selfSubjectAccessReviewSpec: k8s.SelfSubjectAccessReviewSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nonResourceAttributes | cdk8s-plus-32.k8s.NonResourceAttributes | NonResourceAttributes describes information for a non-resource access request. | | resourceAttributes | cdk8s-plus-32.k8s.ResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request. | --- ##### `nonResourceAttributes`^Optional ```typescript public readonly nonResourceAttributes: NonResourceAttributes; ``` - *Type:* cdk8s-plus-32.k8s.NonResourceAttributes NonResourceAttributes describes information for a non-resource access request. --- ##### `resourceAttributes`^Optional ```typescript public readonly resourceAttributes: ResourceAttributes; ``` - *Type:* cdk8s-plus-32.k8s.ResourceAttributes ResourceAuthorizationAttributes describes information for a resource access request. --- ### SelfSubjectRulesReviewSpec SelfSubjectRulesReviewSpec defines the specification for SelfSubjectRulesReview. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const selfSubjectRulesReviewSpec: k8s.SelfSubjectRulesReviewSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | namespace | string | Namespace to evaluate rules for. | --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string Namespace to evaluate rules for. Required. --- ### SeLinuxOptions SELinuxOptions are the labels to be applied to the container. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const seLinuxOptions: k8s.SeLinuxOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | level | string | Level is SELinux level label that applies to the container. | | role | string | Role is a SELinux role label that applies to the container. | | type | string | Type is a SELinux type label that applies to the container. | | user | string | User is a SELinux user label that applies to the container. | --- ##### `level`^Optional ```typescript public readonly level: string; ``` - *Type:* string Level is SELinux level label that applies to the container. --- ##### `role`^Optional ```typescript public readonly role: string; ``` - *Type:* string Role is a SELinux role label that applies to the container. --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string Type is a SELinux type label that applies to the container. --- ##### `user`^Optional ```typescript public readonly user: string; ``` - *Type:* string User is a SELinux user label that applies to the container. --- ### ServiceAccountProps Properties for initialization of `ServiceAccount`. #### Initializer ```typescript import { ServiceAccountProps } from 'cdk8s-plus-32' const serviceAccountProps: ServiceAccountProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountToken | boolean | Indicates whether pods running as this service account should have an API token automatically mounted. | | secrets | ISecret[] | List of secrets allowed to be used by pods running using this ServiceAccount. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountToken`^Optional ```typescript public readonly automountToken: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level. > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server) --- ##### `secrets`^Optional ```typescript public readonly secrets: ISecret[]; ``` - *Type:* ISecret[] List of secrets allowed to be used by pods running using this ServiceAccount. > [https://kubernetes.io/docs/concepts/configuration/secret](https://kubernetes.io/docs/concepts/configuration/secret) --- ### ServiceAccountTokenProjection ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const serviceAccountTokenProjection: k8s.ServiceAccountTokenProjection = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | string | path is the path relative to the mount point of the file to project the token into. | | audience | string | audience is the intended audience of the token. | | expirationSeconds | number | expirationSeconds is the requested duration of validity of the service account token. | --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string path is the path relative to the mount point of the file to project the token into. --- ##### `audience`^Optional ```typescript public readonly audience: string; ``` - *Type:* string audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. --- ##### `expirationSeconds`^Optional ```typescript public readonly expirationSeconds: number; ``` - *Type:* number - *Default:* 1 hour and must be at least 10 minutes. expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. --- ### ServiceAccountTokenSecretProps Options for `ServiceAccountTokenSecret`. #### Initializer ```typescript import { ServiceAccountTokenSecretProps } from 'cdk8s-plus-32' const serviceAccountTokenSecretProps: ServiceAccountTokenSecretProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | serviceAccount | IServiceAccount | The service account to store a secret for. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional ```typescript public readonly immutable: boolean; ``` - *Type:* boolean - *Default:* false If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. --- ##### `serviceAccount`^Required ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount The service account to store a secret for. --- ### ServiceBackendPort ServiceBackendPort is the service port being referenced. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const serviceBackendPort: k8s.ServiceBackendPort = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | name is the name of the port on the Service. | | number | number | number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name". | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string name is the name of the port on the Service. This is a mutually exclusive setting with "Number". --- ##### `number`^Optional ```typescript public readonly number: number; ``` - *Type:* number number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name". --- ### ServiceBindOptions Options for `Service.bind`. #### Initializer ```typescript import { ServiceBindOptions } from 'cdk8s-plus-32' const serviceBindOptions: ServiceBindOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name of this port within the service. | | nodePort | number | The port on each node on which this service is exposed when type=NodePort or LoadBalancer. | | protocol | Protocol | The IP protocol for this port. | | targetPort | number | The port number the service will redirect to. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service. --- ##### `nodePort`^Optional ```typescript public readonly nodePort: number; ``` - *Type:* number - *Default:* auto-allocate a port if the ServiceType of this Service requires one. The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. > [https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport](https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport) --- ##### `protocol`^Optional ```typescript public readonly protocol: Protocol; ``` - *Type:* Protocol - *Default:* Protocol.TCP The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. --- ##### `targetPort`^Optional ```typescript public readonly targetPort: number; ``` - *Type:* number - *Default:* The value of `port` will be used. The port number the service will redirect to. --- ### ServiceCidrSpecV1Beta1 ServiceCIDRSpec define the CIDRs the user wants to use for allocating ClusterIPs for Services. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const serviceCidrSpecV1Beta1: k8s.ServiceCidrSpecV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cidrs | string[] | CIDRs defines the IP blocks in CIDR notation (e.g. "192.168.0.0/24" or "2001:db8::/64") from which to assign service cluster IPs. Max of two CIDRs is allowed, one of each IP family. This field is immutable. | --- ##### `cidrs`^Optional ```typescript public readonly cidrs: string[]; ``` - *Type:* string[] CIDRs defines the IP blocks in CIDR notation (e.g. "192.168.0.0/24" or "2001:db8::/64") from which to assign service cluster IPs. Max of two CIDRs is allowed, one of each IP family. This field is immutable. --- ### ServiceIngressBackendOptions Options for setting up backends for ingress rules. #### Initializer ```typescript import { ServiceIngressBackendOptions } from 'cdk8s-plus-32' const serviceIngressBackendOptions: ServiceIngressBackendOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | port | number | The port to use to access the service. | --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* if the service exposes a single port, this port will be used. The port to use to access the service. This option will fail if the service does not expose any ports. - If the service exposes multiple ports, this option must be specified. - If the service exposes a single port, this option is optional and if specified, it must be the same port exposed by the service. --- ### ServicePort Definition of a service port. #### Initializer ```typescript import { ServicePort } from 'cdk8s-plus-32' const servicePort: ServicePort = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name of this port within the service. | | nodePort | number | The port on each node on which this service is exposed when type=NodePort or LoadBalancer. | | protocol | Protocol | The IP protocol for this port. | | targetPort | number | The port number the service will redirect to. | | port | number | The port number the service will bind to. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service. --- ##### `nodePort`^Optional ```typescript public readonly nodePort: number; ``` - *Type:* number - *Default:* auto-allocate a port if the ServiceType of this Service requires one. The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. > [https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport](https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport) --- ##### `protocol`^Optional ```typescript public readonly protocol: Protocol; ``` - *Type:* Protocol - *Default:* Protocol.TCP The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. --- ##### `targetPort`^Optional ```typescript public readonly targetPort: number; ``` - *Type:* number - *Default:* The value of `port` will be used. The port number the service will redirect to. --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number The port number the service will bind to. --- ### ServicePort ServicePort contains information on service's port. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const servicePort: k8s.ServicePort = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | port | number | The port that will be exposed by this service. | | appProtocol | string | The application protocol for this port. | | name | string | The name of this port within the service. | | nodePort | number | The port on each node on which this service is exposed when type is NodePort or LoadBalancer. | | protocol | string | The IP protocol for this port. | | targetPort | cdk8s-plus-32.k8s.IntOrString | Number or name of the port to access on the pods targeted by the service. | --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number The port that will be exposed by this service. --- ##### `appProtocol`^Optional ```typescript public readonly appProtocol: string; ``` - *Type:* string The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either: * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). * Kubernetes-defined prefixed names: * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. --- ##### `nodePort`^Optional ```typescript public readonly nodePort: number; ``` - *Type:* number The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport --- ##### `protocol`^Optional ```typescript public readonly protocol: string; ``` - *Type:* string - *Default:* TCP. The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. --- ##### `targetPort`^Optional ```typescript public readonly targetPort: IntOrString; ``` - *Type:* cdk8s-plus-32.k8s.IntOrString Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service --- ### ServiceProps Properties for `Service`. #### Initializer ```typescript import { ServiceProps } from 'cdk8s-plus-32' const serviceProps: ServiceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | clusterIP | string | The IP address of the service and is usually assigned randomly by the master. | | externalIPs | string[] | A list of IP addresses for which nodes in the cluster will also accept traffic for this service. | | externalName | string | The externalName to be used when ServiceType.EXTERNAL_NAME is set. | | loadBalancerSourceRanges | string[] | A list of CIDR IP addresses, if specified and supported by the platform, will restrict traffic through the cloud-provider load-balancer to the specified client IPs. | | ports | ServicePort[] | The ports this service binds to. | | publishNotReadyAddresses | boolean | The publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. | | selector | IPodSelector | Which pods should the service select and route to. | | type | ServiceType | Determines how the Service is exposed. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `clusterIP`^Optional ```typescript public readonly clusterIP: string; ``` - *Type:* string - *Default:* Automatically assigned. The IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. > [https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies](https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies) --- ##### `externalIPs`^Optional ```typescript public readonly externalIPs: string[]; ``` - *Type:* string[] - *Default:* No external IPs. A list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. --- ##### `externalName`^Optional ```typescript public readonly externalName: string; ``` - *Type:* string - *Default:* No external name. The externalName to be used when ServiceType.EXTERNAL_NAME is set. --- ##### `loadBalancerSourceRanges`^Optional ```typescript public readonly loadBalancerSourceRanges: string[]; ``` - *Type:* string[] A list of CIDR IP addresses, if specified and supported by the platform, will restrict traffic through the cloud-provider load-balancer to the specified client IPs. More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ --- ##### `ports`^Optional ```typescript public readonly ports: ServicePort[]; ``` - *Type:* ServicePort[] - *Default:* either the selector ports, or none. The ports this service binds to. If the selector of the service is a managed pod / workload, its ports will are automatically extracted and used as the default value. Otherwise, no ports are bound. --- ##### `publishNotReadyAddresses`^Optional ```typescript public readonly publishNotReadyAddresses: boolean; ``` - *Type:* boolean - *Default:* false The publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. More info: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#servicespec-v1-core --- ##### `selector`^Optional ```typescript public readonly selector: IPodSelector; ``` - *Type:* IPodSelector - *Default:* unset, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Which pods should the service select and route to. You can pass one of the following: - An instance of `Pod` or any workload resource (e.g `Deployment`, `StatefulSet`, ...) - Pods selected by the `Pods.select` function. Note that in this case only labels can be specified. --- *Example* ```typescript // select the pods of a specific deployment const backend = new kplus.Deployment(this, 'Backend', ...); new kplus.Service(this, 'Service', { selector: backend }); // select all pods labeled with the `tier=backend` label const backend = kplus.Pod.labeled({ tier: 'backend' }); new kplus.Service(this, 'Service', { selector: backend }); ``` ##### `type`^Optional ```typescript public readonly type: ServiceType; ``` - *Type:* ServiceType - *Default:* ServiceType.ClusterIP Determines how the Service is exposed. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types --- ### ServiceReference ServiceReference holds a reference to Service.legacy.k8s.io. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const serviceReference: k8s.ServiceReference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | `name` is the name of the service. | | namespace | string | `namespace` is the namespace of the service. | | path | string | `path` is an optional URL path which will be sent in any request to this service. | | port | number | If specified, the port on the service that hosting webhook. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string `name` is the name of the service. Required --- ##### `namespace`^Required ```typescript public readonly namespace: string; ``` - *Type:* string `namespace` is the namespace of the service. Required --- ##### `path`^Optional ```typescript public readonly path: string; ``` - *Type:* string `path` is an optional URL path which will be sent in any request to this service. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). --- ### ServiceSpec ServiceSpec describes the attributes that a user creates on a service. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const serviceSpec: k8s.ServiceSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allocateLoadBalancerNodePorts | boolean | allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. | | clusterIp | string | clusterIP is the IP address of the service and is usually assigned randomly. | | clusterIPs | string[] | ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. | | externalIPs | string[] | externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. | | externalName | string | externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName". | | externalTrafficPolicy | string | externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). | | healthCheckNodePort | number | healthCheckNodePort specifies the healthcheck nodePort for the service. | | internalTrafficPolicy | string | InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. | | ipFamilies | string[] | IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. | | ipFamilyPolicy | string | IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. | | loadBalancerClass | string | loadBalancerClass is the class of the load balancer implementation this Service belongs to. | | loadBalancerIp | string | Only applies to Service Type: LoadBalancer. | | loadBalancerSourceRanges | string[] | If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. | | ports | cdk8s-plus-32.k8s.ServicePort[] | The list of ports that are exposed by this service. | | publishNotReadyAddresses | boolean | publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. | | selector | {[ key: string ]: string} | Route service traffic to pods with label keys and values matching this selector. | | sessionAffinity | string | Supports "ClientIP" and "None". | | sessionAffinityConfig | cdk8s-plus-32.k8s.SessionAffinityConfig | sessionAffinityConfig contains the configurations of session affinity. | | trafficDistribution | string | TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints. | | type | string | type determines how the Service is exposed. | --- ##### `allocateLoadBalancerNodePorts`^Optional ```typescript public readonly allocateLoadBalancerNodePorts: boolean; ``` - *Type:* boolean - *Default:* true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. --- ##### `clusterIp`^Optional ```typescript public readonly clusterIp: string; ``` - *Type:* string clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies --- ##### `clusterIPs`^Optional ```typescript public readonly clusterIPs: string[]; ``` - *Type:* string[] ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value. This field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies --- ##### `externalIPs`^Optional ```typescript public readonly externalIPs: string[]; ``` - *Type:* string[] externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. --- ##### `externalName`^Optional ```typescript public readonly externalName: string; ``` - *Type:* string externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName". --- ##### `externalTrafficPolicy`^Optional ```typescript public readonly externalTrafficPolicy: string; ``` - *Type:* string externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node. --- ##### `healthCheckNodePort`^Optional ```typescript public readonly healthCheckNodePort: number; ``` - *Type:* number healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). This field cannot be updated once set. --- ##### `internalTrafficPolicy`^Optional ```typescript public readonly internalTrafficPolicy: string; ``` - *Type:* string InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to "Local", the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). --- ##### `ipFamilies`^Optional ```typescript public readonly ipFamilies: string[]; ``` - *Type:* string[] IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. --- ##### `ipFamilyPolicy`^Optional ```typescript public readonly ipFamilyPolicy: string; ``` - *Type:* string IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. --- ##### `loadBalancerClass`^Optional ```typescript public readonly loadBalancerClass: string; ``` - *Type:* string loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. --- ##### `loadBalancerIp`^Optional ```typescript public readonly loadBalancerIp: string; ``` - *Type:* string Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. Deprecated: This field was under-specified and its meaning varies across implementations. Using it is non-portable and it may not support dual-stack. Users are encouraged to use implementation-specific annotations when available. --- ##### `loadBalancerSourceRanges`^Optional ```typescript public readonly loadBalancerSourceRanges: string[]; ``` - *Type:* string[] If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ --- ##### `ports`^Optional ```typescript public readonly ports: ServicePort[]; ``` - *Type:* cdk8s-plus-32.k8s.ServicePort[] The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies --- ##### `publishNotReadyAddresses`^Optional ```typescript public readonly publishNotReadyAddresses: boolean; ``` - *Type:* boolean publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior. --- ##### `selector`^Optional ```typescript public readonly selector: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ --- ##### `sessionAffinity`^Optional ```typescript public readonly sessionAffinity: string; ``` - *Type:* string - *Default:* None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies --- ##### `sessionAffinityConfig`^Optional ```typescript public readonly sessionAffinityConfig: SessionAffinityConfig; ``` - *Type:* cdk8s-plus-32.k8s.SessionAffinityConfig sessionAffinityConfig contains the configurations of session affinity. --- ##### `trafficDistribution`^Optional ```typescript public readonly trafficDistribution: string; ``` - *Type:* string TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints. Implementations can use this field as a hint, but are not required to guarantee strict adherence. If the field is not set, the implementation will apply its default routing strategy. If set to "PreferClose", implementations should prioritize endpoints that are topologically close (e.g., same zone). This is a beta field and requires enabling ServiceTrafficDistribution feature. --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string - *Default:* ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types --- ### SessionAffinityConfig SessionAffinityConfig represents the configurations of session affinity. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const sessionAffinityConfig: k8s.SessionAffinityConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clientIp | cdk8s-plus-32.k8s.ClientIpConfig | clientIP contains the configurations of Client IP based session affinity. | --- ##### `clientIp`^Optional ```typescript public readonly clientIp: ClientIpConfig; ``` - *Type:* cdk8s-plus-32.k8s.ClientIpConfig clientIP contains the configurations of Client IP based session affinity. --- ### SleepAction SleepAction describes a "sleep" action. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const sleepAction: k8s.SleepAction = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | seconds | number | Seconds is the number of seconds to sleep. | --- ##### `seconds`^Required ```typescript public readonly seconds: number; ``` - *Type:* number Seconds is the number of seconds to sleep. --- ### SshAuthSecretProps Options for `SshAuthSecret`. #### Initializer ```typescript import { SshAuthSecretProps } from 'cdk8s-plus-32' const sshAuthSecretProps: SshAuthSecretProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | sshPrivateKey | string | The SSH private key to use. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional ```typescript public readonly immutable: boolean; ``` - *Type:* boolean - *Default:* false If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. --- ##### `sshPrivateKey`^Required ```typescript public readonly sshPrivateKey: string; ``` - *Type:* string The SSH private key to use. --- ### StatefulSetOrdinals StatefulSetOrdinals describes the policy used for replica ordinal assignment in this StatefulSet. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const statefulSetOrdinals: k8s.StatefulSetOrdinals = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | start | number | start is the number representing the first replica's index. | --- ##### `start`^Optional ```typescript public readonly start: number; ``` - *Type:* number start is the number representing the first replica's index. It may be used to number replicas from an alternate index (eg: 1-indexed) over the default 0-indexed names, or to orchestrate progressive movement of replicas from one StatefulSet to another. If set, replica indices will be in the range: [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas). If unset, defaults to 0. Replica indices will be in the range: [0, .spec.replicas). --- ### StatefulSetPersistentVolumeClaimRetentionPolicy StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const statefulSetPersistentVolumeClaimRetentionPolicy: k8s.StatefulSetPersistentVolumeClaimRetentionPolicy = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | whenDeleted | string | WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. | | whenScaled | string | WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. | --- ##### `whenDeleted`^Optional ```typescript public readonly whenDeleted: string; ``` - *Type:* string WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of `Retain` causes PVCs to not be affected by StatefulSet deletion. The `Delete` policy causes those PVCs to be deleted. --- ##### `whenScaled`^Optional ```typescript public readonly whenScaled: string; ``` - *Type:* string WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of `Retain` causes PVCs to not be affected by a scaledown. The `Delete` policy causes the associated PVCs for any excess pods above the replica count to be deleted. --- ### StatefulSetProps Properties for initialization of `StatefulSet`. #### Initializer ```typescript import { StatefulSetProps } from 'cdk8s-plus-32' const statefulSetProps: StatefulSetProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | boolean | Indicates whether a service account token should be automatically mounted. | | containers | ContainerProps[] | List of containers belonging to the pod. | | dns | PodDnsProps | DNS settings for the pod. | | dockerRegistryAuth | ISecret | A secret containing docker credentials for authenticating to a registry. | | enableServiceLinks | boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | HostAlias[] | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | boolean | Host network for the pod. | | initContainers | ContainerProps[] | List of initialization containers belonging to the pod. | | isolate | boolean | Isolates the pod. | | restartPolicy | RestartPolicy | Restart policy for all containers within the pod. | | securityContext | PodSecurityContextProps | SecurityContext holds pod-level security attributes and common container settings. | | serviceAccount | IServiceAccount | A service account provides an identity for processes that run in a Pod. | | shareProcessNamespace | boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | cdk8s.Duration | Grace period until the pod is terminated. | | volumes | Volume[] | List of volumes that can be mounted by containers belonging to the pod. | | podMetadata | cdk8s.ApiObjectMetadata | The pod metadata of this workload. | | select | boolean | Automatically allocates a pod label selector for this workload and add it to the pod metadata. | | spread | boolean | Automatically spread pods across hostname and zones. | | 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. | | podManagementPolicy | PodManagementPolicy | Pod management policy to use for this statefulset. | | replicas | number | Number of desired pods. | | service | Service | Service to associate with the statefulset. | | strategy | StatefulSetUpdateStrategy | Indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. | | volumeClaimTemplates | PersistentVolumeClaimTemplateProps[] | A list of PersistentVolumeClaim templates that will be created for each pod in the StatefulSet. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether a service account token should be automatically mounted. > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server) --- ##### `containers`^Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No containers. Note that a pod spec must include at least one container. List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. You can add additionnal containers using `podSpec.addContainer()` --- ##### `dns`^Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* PodDnsProps - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > [https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/) --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean - *Default:* true Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. > [https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) --- ##### `hostAliases`^Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No init containers. List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added ,removed or updated. > [https://kubernetes.io/docs/concepts/workloads/pods/init-containers/](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) --- ##### `isolate`^Optional ```typescript public readonly isolate: boolean; ``` - *Type:* boolean - *Default:* false Isolates the pod. This will prevent any ingress or egress connections to / from this pod. You can however allow explicit connections post instantiation by using the `.connections` property. --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy) --- ##### `securityContext`^Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount - *Default:* No service account. A service account provides an identity for processes that run in a Pod. When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default). > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) --- ##### `shareProcessNamespace`^Optional ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean - *Default:* false When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. > [https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/](https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/) --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] - *Default:* No volumes. List of volumes that can be mounted by containers belonging to the pod. You can also add volumes later using `podSpec.addVolume()` > [https://kubernetes.io/docs/concepts/storage/volumes](https://kubernetes.io/docs/concepts/storage/volumes) --- ##### `podMetadata`^Optional ```typescript public readonly podMetadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata The pod metadata of this workload. --- ##### `select`^Optional ```typescript public readonly select: boolean; ``` - *Type:* boolean - *Default:* true Automatically allocates a pod label selector for this workload and add it to the pod metadata. This ensures this workload manages pods created by its pod template. --- ##### `spread`^Optional ```typescript public readonly spread: boolean; ``` - *Type:* boolean - *Default:* false Automatically spread pods across hostname and zones. > [https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints) --- ##### `minReady`^Optional ```typescript public readonly minReady: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(0) Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Zero means the pod will be considered available as soon as it is ready. This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate. > [https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#min-ready-seconds](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#min-ready-seconds) --- ##### `podManagementPolicy`^Optional ```typescript public readonly podManagementPolicy: PodManagementPolicy; ``` - *Type:* PodManagementPolicy - *Default:* PodManagementPolicy.ORDERED_READY Pod management policy to use for this statefulset. --- ##### `replicas`^Optional ```typescript public readonly replicas: number; ``` - *Type:* number - *Default:* 1 Number of desired pods. --- ##### `service`^Optional ```typescript public readonly service: Service; ``` - *Type:* Service - *Default:* A new headless service will be created. Service to associate with the statefulset. --- ##### `strategy`^Optional ```typescript public readonly strategy: StatefulSetUpdateStrategy; ``` - *Type:* StatefulSetUpdateStrategy - *Default:* RollingUpdate with partition set to 0 Indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. --- ##### `volumeClaimTemplates`^Optional ```typescript public readonly volumeClaimTemplates: PersistentVolumeClaimTemplateProps[]; ``` - *Type:* PersistentVolumeClaimTemplateProps[] - *Default:* No volume claim templates will be created. A list of PersistentVolumeClaim templates that will be created for each pod in the StatefulSet. The StatefulSet controller creates a PVC and a PV for each template based on the pod's ordinal index, ensuring stable storage across pod restarts and rescheduling. Each claim in this list must have at least one matching (by name) volumeMount in one of the containers. --- ### StatefulSetSpec A StatefulSetSpec is the specification of a StatefulSet. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const statefulSetSpec: k8s.StatefulSetSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | selector | cdk8s-plus-32.k8s.LabelSelector | selector is a label query over pods that should match the replica count. | | serviceName | string | serviceName is the name of the service that governs this StatefulSet. | | template | cdk8s-plus-32.k8s.PodTemplateSpec | template is the object that describes the pod that will be created if insufficient replicas are detected. | | minReadySeconds | number | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. | | ordinals | cdk8s-plus-32.k8s.StatefulSetOrdinals | ordinals controls the numbering of replica indices in a StatefulSet. | | persistentVolumeClaimRetentionPolicy | cdk8s-plus-32.k8s.StatefulSetPersistentVolumeClaimRetentionPolicy | persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. | | podManagementPolicy | string | podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. | | replicas | number | replicas is the desired number of replicas of the given Template. | | revisionHistoryLimit | number | revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. | | updateStrategy | cdk8s-plus-32.k8s.StatefulSetUpdateStrategy | updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. | | volumeClaimTemplates | cdk8s-plus-32.k8s.KubePersistentVolumeClaimProps[] | volumeClaimTemplates is a list of claims that pods are allowed to reference. | --- ##### `selector`^Required ```typescript public readonly selector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors --- ##### `serviceName`^Required ```typescript public readonly serviceName: string; ``` - *Type:* string serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller. --- ##### `template`^Required ```typescript public readonly template: PodTemplateSpec; ``` - *Type:* cdk8s-plus-32.k8s.PodTemplateSpec template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. Each pod will be named with the format -. For example, a pod in a StatefulSet named "web" with index number "3" would be named "web-3". The only allowed template.spec.restartPolicy value is "Always". --- ##### `minReadySeconds`^Optional ```typescript public readonly minReadySeconds: number; ``` - *Type:* number - *Default:* 0 (pod will be considered available as soon as it is ready) Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) --- ##### `ordinals`^Optional ```typescript public readonly ordinals: StatefulSetOrdinals; ``` - *Type:* cdk8s-plus-32.k8s.StatefulSetOrdinals ordinals controls the numbering of replica indices in a StatefulSet. The default ordinals behavior assigns a "0" index to the first replica and increments the index by one for each additional replica requested. --- ##### `persistentVolumeClaimRetentionPolicy`^Optional ```typescript public readonly persistentVolumeClaimRetentionPolicy: StatefulSetPersistentVolumeClaimRetentionPolicy; ``` - *Type:* cdk8s-plus-32.k8s.StatefulSetPersistentVolumeClaimRetentionPolicy persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down. --- ##### `podManagementPolicy`^Optional ```typescript public readonly podManagementPolicy: string; ``` - *Type:* string podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. --- ##### `replicas`^Optional ```typescript public readonly replicas: number; ``` - *Type:* number replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1. --- ##### `revisionHistoryLimit`^Optional ```typescript public readonly revisionHistoryLimit: number; ``` - *Type:* number revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10. --- ##### `updateStrategy`^Optional ```typescript public readonly updateStrategy: StatefulSetUpdateStrategy; ``` - *Type:* cdk8s-plus-32.k8s.StatefulSetUpdateStrategy updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. --- ##### `volumeClaimTemplates`^Optional ```typescript public readonly volumeClaimTemplates: KubePersistentVolumeClaimProps[]; ``` - *Type:* cdk8s-plus-32.k8s.KubePersistentVolumeClaimProps[] volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. --- ### StatefulSetUpdateStrategy StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const statefulSetUpdateStrategy: k8s.StatefulSetUpdateStrategy = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | rollingUpdate | cdk8s-plus-32.k8s.RollingUpdateStatefulSetStrategy | RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. | | type | string | Type indicates the type of the StatefulSetUpdateStrategy. | --- ##### `rollingUpdate`^Optional ```typescript public readonly rollingUpdate: RollingUpdateStatefulSetStrategy; ``` - *Type:* cdk8s-plus-32.k8s.RollingUpdateStatefulSetStrategy RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string - *Default:* RollingUpdate. Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate. --- ### StatefulSetUpdateStrategyRollingUpdateOptions Options for `StatefulSetUpdateStrategy.rollingUpdate`. #### Initializer ```typescript import { StatefulSetUpdateStrategyRollingUpdateOptions } from 'cdk8s-plus-32' const statefulSetUpdateStrategyRollingUpdateOptions: StatefulSetUpdateStrategyRollingUpdateOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | partition | number | If specified, all Pods with an ordinal that is greater than or equal to the partition will be updated when the StatefulSet's .spec.template is updated. All Pods with an ordinal that is less than the partition will not be updated, and, even if they are deleted, they will be recreated at the previous version. | --- ##### `partition`^Optional ```typescript public readonly partition: number; ``` - *Type:* number - *Default:* 0 If specified, all Pods with an ordinal that is greater than or equal to the partition will be updated when the StatefulSet's .spec.template is updated. All Pods with an ordinal that is less than the partition will not be updated, and, even if they are deleted, they will be recreated at the previous version. If the partition is greater than replicas, updates to the pod template will not be propagated to Pods. In most cases you will not need to use a partition, but they are useful if you want to stage an update, roll out a canary, or perform a phased roll out. > [https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#partitions](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#partitions) --- ### StatusCause StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const statusCause: k8s.StatusCause = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | field | string | The field of the resource that has caused this error, as named by its JSON serialization. | | message | string | A human-readable description of the cause of the error. | | reason | string | A machine-readable description of the cause of the error. | --- ##### `field`^Optional ```typescript public readonly field: string; ``` - *Type:* string The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items" --- ##### `message`^Optional ```typescript public readonly message: string; ``` - *Type:* string A human-readable description of the cause of the error. This field may be presented as-is to a reader. --- ##### `reason`^Optional ```typescript public readonly reason: string; ``` - *Type:* string A machine-readable description of the cause of the error. If this value is empty there is no information available. --- ### StatusDetails StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const statusDetails: k8s.StatusDetails = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | causes | cdk8s-plus-32.k8s.StatusCause[] | The Causes array includes more details associated with the StatusReason failure. | | group | string | The group attribute of the resource associated with the status StatusReason. | | kind | string | The kind attribute of the resource associated with the status StatusReason. | | name | string | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). | | retryAfterSeconds | number | If specified, the time in seconds before the operation should be retried. | | uid | string | UID of the resource. | --- ##### `causes`^Optional ```typescript public readonly causes: StatusCause[]; ``` - *Type:* cdk8s-plus-32.k8s.StatusCause[] The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. --- ##### `group`^Optional ```typescript public readonly group: string; ``` - *Type:* string The group attribute of the resource associated with the status StatusReason. --- ##### `kind`^Optional ```typescript public readonly kind: string; ``` - *Type:* string The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). --- ##### `retryAfterSeconds`^Optional ```typescript public readonly retryAfterSeconds: number; ``` - *Type:* number If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. --- ##### `uid`^Optional ```typescript public readonly uid: string; ``` - *Type:* string UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids --- ### StorageOsPersistentVolumeSource Represents a StorageOS persistent volume resource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const storageOsPersistentVolumeSource: k8s.StorageOsPersistentVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fsType | string | fsType is the filesystem type to mount. | | readOnly | boolean | readOnly defaults to false (read/write). | | secretRef | cdk8s-plus-32.k8s.ObjectReference | secretRef specifies the secret to use for obtaining the StorageOS API credentials. | | volumeName | string | volumeName is the human-readable name of the StorageOS volume. | | volumeNamespace | string | volumeNamespace specifies the scope of the volume within StorageOS. | --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ##### `secretRef`^Optional ```typescript public readonly secretRef: ObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.ObjectReference secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. --- ##### `volumeName`^Optional ```typescript public readonly volumeName: string; ``` - *Type:* string volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. --- ##### `volumeNamespace`^Optional ```typescript public readonly volumeNamespace: string; ``` - *Type:* string volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. --- ### StorageOsVolumeSource Represents a StorageOS persistent volume resource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const storageOsVolumeSource: k8s.StorageOsVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fsType | string | fsType is the filesystem type to mount. | | readOnly | boolean | readOnly defaults to false (read/write). | | secretRef | cdk8s-plus-32.k8s.LocalObjectReference | secretRef specifies the secret to use for obtaining the StorageOS API credentials. | | volumeName | string | volumeName is the human-readable name of the StorageOS volume. | | volumeNamespace | string | volumeNamespace specifies the scope of the volume within StorageOS. | --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ##### `secretRef`^Optional ```typescript public readonly secretRef: LocalObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.LocalObjectReference secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. --- ##### `volumeName`^Optional ```typescript public readonly volumeName: string; ``` - *Type:* string volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. --- ##### `volumeNamespace`^Optional ```typescript public readonly volumeNamespace: string; ``` - *Type:* string volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. --- ### StorageVersionMigrationSpecV1Alpha1 Spec of the storage version migration. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const storageVersionMigrationSpecV1Alpha1: k8s.StorageVersionMigrationSpecV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | resource | cdk8s-plus-32.k8s.GroupVersionResourceV1Alpha1 | The resource that is being migrated. | | continueToken | string | The token used in the list options to get the next chunk of objects to migrate. | --- ##### `resource`^Required ```typescript public readonly resource: GroupVersionResourceV1Alpha1; ``` - *Type:* cdk8s-plus-32.k8s.GroupVersionResourceV1Alpha1 The resource that is being migrated. The migrator sends requests to the endpoint serving the resource. Immutable. --- ##### `continueToken`^Optional ```typescript public readonly continueToken: string; ``` - *Type:* string The token used in the list options to get the next chunk of objects to migrate. When the .status.conditions indicates the migration is "Running", users can use this token to check the progress of the migration. --- ### Subject Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const subject: k8s.Subject = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | kind | string | Kind of object being referenced. | | name | string | Name of the object being referenced. | | apiGroup | string | APIGroup holds the API group of the referenced subject. | | namespace | string | Namespace of the referenced object. | --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of the object being referenced. --- ##### `apiGroup`^Optional ```typescript public readonly apiGroup: string; ``` - *Type:* string - *Default:* for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. --- ### SubjectAccessReviewSpec SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const subjectAccessReviewSpec: k8s.SubjectAccessReviewSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | extra | {[ key: string ]: string[]} | Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. | | groups | string[] | Groups is the groups you're testing for. | | nonResourceAttributes | cdk8s-plus-32.k8s.NonResourceAttributes | NonResourceAttributes describes information for a non-resource access request. | | resourceAttributes | cdk8s-plus-32.k8s.ResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request. | | uid | string | UID information about the requesting user. | | user | string | User is the user you're testing for. | --- ##### `extra`^Optional ```typescript public readonly extra: {[ key: string ]: string[]}; ``` - *Type:* {[ key: string ]: string[]} Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. --- ##### `groups`^Optional ```typescript public readonly groups: string[]; ``` - *Type:* string[] Groups is the groups you're testing for. --- ##### `nonResourceAttributes`^Optional ```typescript public readonly nonResourceAttributes: NonResourceAttributes; ``` - *Type:* cdk8s-plus-32.k8s.NonResourceAttributes NonResourceAttributes describes information for a non-resource access request. --- ##### `resourceAttributes`^Optional ```typescript public readonly resourceAttributes: ResourceAttributes; ``` - *Type:* cdk8s-plus-32.k8s.ResourceAttributes ResourceAuthorizationAttributes describes information for a resource access request. --- ##### `uid`^Optional ```typescript public readonly uid: string; ``` - *Type:* string UID information about the requesting user. --- ##### `user`^Optional ```typescript public readonly user: string; ``` - *Type:* string User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups --- ### SubjectConfiguration Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names. #### Initializer ```typescript import { SubjectConfiguration } from 'cdk8s-plus-32' const subjectConfiguration: SubjectConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | kind | string | Kind of object being referenced. | | name | string | Name of the object being referenced. | | apiGroup | string | APIGroup holds the API group of the referenced subject. | | namespace | string | Namespace of the referenced object. | --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of the object being referenced. --- ##### `apiGroup`^Optional ```typescript public readonly apiGroup: string; ``` - *Type:* string APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. --- ### SuccessPolicy SuccessPolicy describes when a Job can be declared as succeeded based on the success of some indexes. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const successPolicy: k8s.SuccessPolicy = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | rules | cdk8s-plus-32.k8s.SuccessPolicyRule[] | rules represents the list of alternative rules for the declaring the Jobs as successful before `.status.succeeded >= .spec.completions`. Once any of the rules are met, the "SucceededCriteriaMet" condition is added, and the lingering pods are removed. The terminal state for such a Job has the "Complete" condition. Additionally, these rules are evaluated in order; Once the Job meets one of the rules, other rules are ignored. At most 20 elements are allowed. | --- ##### `rules`^Required ```typescript public readonly rules: SuccessPolicyRule[]; ``` - *Type:* cdk8s-plus-32.k8s.SuccessPolicyRule[] rules represents the list of alternative rules for the declaring the Jobs as successful before `.status.succeeded >= .spec.completions`. Once any of the rules are met, the "SucceededCriteriaMet" condition is added, and the lingering pods are removed. The terminal state for such a Job has the "Complete" condition. Additionally, these rules are evaluated in order; Once the Job meets one of the rules, other rules are ignored. At most 20 elements are allowed. --- ### SuccessPolicyRule SuccessPolicyRule describes rule for declaring a Job as succeeded. Each rule must have at least one of the "succeededIndexes" or "succeededCount" specified. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const successPolicyRule: k8s.SuccessPolicyRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | succeededCount | number | succeededCount specifies the minimal required size of the actual set of the succeeded indexes for the Job. | | succeededIndexes | string | succeededIndexes specifies the set of indexes which need to be contained in the actual set of the succeeded indexes for the Job. | --- ##### `succeededCount`^Optional ```typescript public readonly succeededCount: number; ``` - *Type:* number succeededCount specifies the minimal required size of the actual set of the succeeded indexes for the Job. When succeededCount is used along with succeededIndexes, the check is constrained only to the set of indexes specified by succeededIndexes. For example, given that succeededIndexes is "1-4", succeededCount is "3", and completed indexes are "1", "3", and "5", the Job isn't declared as succeeded because only "1" and "3" indexes are considered in that rules. When this field is null, this doesn't default to any value and is never evaluated at any time. When specified it needs to be a positive integer. --- ##### `succeededIndexes`^Optional ```typescript public readonly succeededIndexes: string; ``` - *Type:* string succeededIndexes specifies the set of indexes which need to be contained in the actual set of the succeeded indexes for the Job. The list of indexes must be within 0 to ".spec.completions-1" and must not contain duplicates. At least one element is required. The indexes are represented as intervals separated by commas. The intervals can be a decimal integer or a pair of decimal integers separated by a hyphen. The number are listed in represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". When this field is null, this field doesn't default to any value and is never evaluated at any time. --- ### Sysctl Sysctl defines a kernel parameter to be set. #### Initializer ```typescript import { Sysctl } from 'cdk8s-plus-32' const sysctl: Sysctl = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name of a property to set. | | value | string | Value of a property to set. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of a property to set. --- ##### `value`^Required ```typescript public readonly value: string; ``` - *Type:* string Value of a property to set. --- ### Sysctl Sysctl defines a kernel parameter to be set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const sysctl: k8s.Sysctl = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name of a property to set. | | value | string | Value of a property to set. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of a property to set. --- ##### `value`^Required ```typescript public readonly value: string; ``` - *Type:* string Value of a property to set. --- ### Taint The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const taint: k8s.Taint = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | effect | string | Required. | | key | string | Required. | | timeAdded | Date | TimeAdded represents the time at which the taint was added. | | value | string | The taint value corresponding to the taint key. | --- ##### `effect`^Required ```typescript public readonly effect: string; ``` - *Type:* string Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string Required. The taint key to be applied to a node. --- ##### `timeAdded`^Optional ```typescript public readonly timeAdded: Date; ``` - *Type:* Date TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. --- ##### `value`^Optional ```typescript public readonly value: string; ``` - *Type:* string The taint value corresponding to the taint key. --- ### TcpSocketAction TCPSocketAction describes an action based on opening a socket. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const tcpSocketAction: k8s.TcpSocketAction = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | port | cdk8s-plus-32.k8s.IntOrString | Number or name of the port to access on the container. | | host | string | Optional: Host name to connect to, defaults to the pod IP. | --- ##### `port`^Required ```typescript public readonly port: IntOrString; ``` - *Type:* cdk8s-plus-32.k8s.IntOrString Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. --- ##### `host`^Optional ```typescript public readonly host: string; ``` - *Type:* string Optional: Host name to connect to, defaults to the pod IP. --- ### TcpSocketProbeOptions Options for `Probe.fromTcpSocket()`. #### Initializer ```typescript import { TcpSocketProbeOptions } from 'cdk8s-plus-32' const tcpSocketProbeOptions: TcpSocketProbeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | failureThreshold | number | Minimum consecutive failures for the probe to be considered failed after having succeeded. | | initialDelaySeconds | cdk8s.Duration | Number of seconds after the container has started before liveness probes are initiated. | | periodSeconds | cdk8s.Duration | How often (in seconds) to perform the probe. | | successThreshold | number | Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. | | timeoutSeconds | cdk8s.Duration | Number of seconds after which the probe times out. | | host | string | The host name to connect to on the container. | | port | number | The TCP port to connect to on the container. | --- ##### `failureThreshold`^Optional ```typescript public readonly failureThreshold: number; ``` - *Type:* number - *Default:* 3 Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. --- ##### `initialDelaySeconds`^Optional ```typescript public readonly initialDelaySeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* immediate Number of seconds after the container has started before liveness probes are initiated. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes) --- ##### `periodSeconds`^Optional ```typescript public readonly periodSeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(10) Minimum value is 1. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. --- ##### `successThreshold`^Optional ```typescript public readonly successThreshold: number; ``` - *Type:* number - *Default:* 1 Must be 1 for liveness and startup. Minimum value is 1. Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. --- ##### `timeoutSeconds`^Optional ```typescript public readonly timeoutSeconds: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(1) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes) --- ##### `host`^Optional ```typescript public readonly host: string; ``` - *Type:* string - *Default:* defaults to the pod IP The host name to connect to on the container. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* defaults to `container.port`. The TCP port to connect to on the container. --- ### TlsSecretProps Options for `TlsSecret`. #### Initializer ```typescript import { TlsSecretProps } from 'cdk8s-plus-32' const tlsSecretProps: TlsSecretProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | tlsCert | string | The TLS cert. | | tlsKey | string | The TLS key. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional ```typescript public readonly immutable: boolean; ``` - *Type:* boolean - *Default:* false If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. --- ##### `tlsCert`^Required ```typescript public readonly tlsCert: string; ``` - *Type:* string The TLS cert. --- ##### `tlsKey`^Required ```typescript public readonly tlsKey: string; ``` - *Type:* string The TLS key. --- ### TokenRequest TokenRequest contains parameters of a service account token. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const tokenRequest: k8s.TokenRequest = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | audience | string | audience is the intended audience of the token in "TokenRequestSpec". | | expirationSeconds | number | expirationSeconds is the duration of validity of the token in "TokenRequestSpec". | --- ##### `audience`^Required ```typescript public readonly audience: string; ``` - *Type:* string audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver. --- ##### `expirationSeconds`^Optional ```typescript public readonly expirationSeconds: number; ``` - *Type:* number expirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec". --- ### TokenRequestSpec TokenRequestSpec contains client provided parameters of a token request. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const tokenRequestSpec: k8s.TokenRequestSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | audiences | string[] | Audiences are the intendend audiences of the token. | | boundObjectRef | cdk8s-plus-32.k8s.BoundObjectReference | BoundObjectRef is a reference to an object that the token will be bound to. | | expirationSeconds | number | ExpirationSeconds is the requested duration of validity of the request. | --- ##### `audiences`^Required ```typescript public readonly audiences: string[]; ``` - *Type:* string[] Audiences are the intendend audiences of the token. A recipient of a token must identify themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences. --- ##### `boundObjectRef`^Optional ```typescript public readonly boundObjectRef: BoundObjectReference; ``` - *Type:* cdk8s-plus-32.k8s.BoundObjectReference BoundObjectRef is a reference to an object that the token will be bound to. The token will only be valid for as long as the bound object exists. NOTE: The API server's TokenReview endpoint will validate the BoundObjectRef, but other audiences may not. Keep ExpirationSeconds small if you want prompt revocation. --- ##### `expirationSeconds`^Optional ```typescript public readonly expirationSeconds: number; ``` - *Type:* number ExpirationSeconds is the requested duration of validity of the request. The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response. --- ### TokenReviewSpec TokenReviewSpec is a description of the token authentication request. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const tokenReviewSpec: k8s.TokenReviewSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | audiences | string[] | Audiences is a list of the identifiers that the resource server presented with the token identifies as. | | token | string | Token is the opaque bearer token. | --- ##### `audiences`^Optional ```typescript public readonly audiences: string[]; ``` - *Type:* string[] Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver. --- ##### `token`^Optional ```typescript public readonly token: string; ``` - *Type:* string Token is the opaque bearer token. --- ### Toleration The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const toleration: k8s.Toleration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | effect | string | Effect indicates the taint effect to match. | | key | string | Key is the taint key that the toleration applies to. | | operator | string | Operator represents a key's relationship to the value. | | tolerationSeconds | number | TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. | | value | string | Value is the taint value the toleration matches to. | --- ##### `effect`^Optional ```typescript public readonly effect: string; ``` - *Type:* string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. --- ##### `key`^Optional ```typescript public readonly key: string; ``` - *Type:* string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. --- ##### `operator`^Optional ```typescript public readonly operator: string; ``` - *Type:* string - *Default:* Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. --- ##### `tolerationSeconds`^Optional ```typescript public readonly tolerationSeconds: number; ``` - *Type:* number TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. --- ##### `value`^Optional ```typescript public readonly value: string; ``` - *Type:* string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. --- ### TopologySelectorLabelRequirement A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const topologySelectorLabelRequirement: k8s.TopologySelectorLabelRequirement = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | The label key that the selector applies to. | | values | string[] | An array of string values. | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string The label key that the selector applies to. --- ##### `values`^Required ```typescript public readonly values: string[]; ``` - *Type:* string[] An array of string values. One value must match the label to be selected. Each entry in Values is ORed. --- ### TopologySelectorTerm A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const topologySelectorTerm: k8s.TopologySelectorTerm = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | matchLabelExpressions | cdk8s-plus-32.k8s.TopologySelectorLabelRequirement[] | A list of topology selector requirements by labels. | --- ##### `matchLabelExpressions`^Optional ```typescript public readonly matchLabelExpressions: TopologySelectorLabelRequirement[]; ``` - *Type:* cdk8s-plus-32.k8s.TopologySelectorLabelRequirement[] A list of topology selector requirements by labels. --- ### TopologySpreadConstraint TopologySpreadConstraint specifies how to spread matching pods among the given topology. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const topologySpreadConstraint: k8s.TopologySpreadConstraint = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maxSkew | number | MaxSkew describes the degree to which pods may be unevenly distributed. | | topologyKey | string | TopologyKey is the key of node labels. | | whenUnsatisfiable | string | WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. | | labelSelector | cdk8s-plus-32.k8s.LabelSelector | LabelSelector is used to find matching pods. | | matchLabelKeys | string[] | MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. | | minDomains | number | MinDomains indicates a minimum number of eligible domains. | | nodeAffinityPolicy | string | NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. | | nodeTaintsPolicy | string | NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. | --- ##### `maxSkew`^Required ```typescript public readonly maxSkew: number; ``` - *Type:* number MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. --- ##### `topologyKey`^Required ```typescript public readonly topologyKey: string; ``` - *Type:* string TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field. --- ##### `whenUnsatisfiable`^Required ```typescript public readonly whenUnsatisfiable: string; ``` - *Type:* string WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. --- ##### `labelSelector`^Optional ```typescript public readonly labelSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. --- ##### `matchLabelKeys`^Optional ```typescript public readonly matchLabelKeys: string[]; ``` - *Type:* string[] MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default). --- ##### `minDomains`^Optional ```typescript public readonly minDomains: number; ``` - *Type:* number MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. --- ##### `nodeAffinityPolicy`^Optional ```typescript public readonly nodeAffinityPolicy: string; ``` - *Type:* string NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. --- ##### `nodeTaintsPolicy`^Optional ```typescript public readonly nodeTaintsPolicy: string; ``` - *Type:* string NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. --- ### TypedLocalObjectReference TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const typedLocalObjectReference: k8s.TypedLocalObjectReference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | kind | string | Kind is the type of resource being referenced. | | name | string | Name is the name of resource being referenced. | | apiGroup | string | APIGroup is the group for the resource being referenced. | --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string Kind is the type of resource being referenced. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is the name of resource being referenced. --- ##### `apiGroup`^Optional ```typescript public readonly apiGroup: string; ``` - *Type:* string APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. --- ### TypedObjectReference TypedObjectReference contains enough information to let you locate the typed referenced object. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const typedObjectReference: k8s.TypedObjectReference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | kind | string | Kind is the type of resource being referenced. | | name | string | Name is the name of resource being referenced. | | apiGroup | string | APIGroup is the group for the resource being referenced. | | namespace | string | Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. | --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string Kind is the type of resource being referenced. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is the name of resource being referenced. --- ##### `apiGroup`^Optional ```typescript public readonly apiGroup: string; ``` - *Type:* string APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. --- ### ValidatingAdmissionPolicyBindingSpec ValidatingAdmissionPolicyBindingSpec is the specification of the ValidatingAdmissionPolicyBinding. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const validatingAdmissionPolicyBindingSpec: k8s.ValidatingAdmissionPolicyBindingSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | matchResources | cdk8s-plus-32.k8s.MatchResources | MatchResources declares what resources match this binding and will be validated by it. | | paramRef | cdk8s-plus-32.k8s.ParamRef | paramRef specifies the parameter resource used to configure the admission control policy. | | policyName | string | PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to. | | validationActions | string[] | validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced. | --- ##### `matchResources`^Optional ```typescript public readonly matchResources: MatchResources; ``` - *Type:* cdk8s-plus-32.k8s.MatchResources MatchResources declares what resources match this binding and will be validated by it. Note that this is intersected with the policy's matchConstraints, so only requests that are matched by the policy can be selected by this. If this is unset, all resources matched by the policy are validated by this binding When resourceRules is unset, it does not constrain resource matching. If a resource is matched by the other fields of this object, it will be validated. Note that this is differs from ValidatingAdmissionPolicy matchConstraints, where resourceRules are required. --- ##### `paramRef`^Optional ```typescript public readonly paramRef: ParamRef; ``` - *Type:* cdk8s-plus-32.k8s.ParamRef paramRef specifies the parameter resource used to configure the admission control policy. It should point to a resource of the type specified in ParamKind of the bound ValidatingAdmissionPolicy. If the policy specifies a ParamKind and the resource referred to by ParamRef does not exist, this binding is considered mis-configured and the FailurePolicy of the ValidatingAdmissionPolicy applied. If the policy does not specify a ParamKind then this field is ignored, and the rules are evaluated without a param. --- ##### `policyName`^Optional ```typescript public readonly policyName: string; ``` - *Type:* string PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to. If the referenced resource does not exist, this binding is considered invalid and will be ignored Required. --- ##### `validationActions`^Optional ```typescript public readonly validationActions: string[]; ``` - *Type:* string[] validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced. If a validation evaluates to false it is always enforced according to these actions. Failures defined by the ValidatingAdmissionPolicy's FailurePolicy are enforced according to these actions only if the FailurePolicy is set to Fail, otherwise the failures are ignored. This includes compilation errors, runtime errors and misconfigurations of the policy. validationActions is declared as a set of action values. Order does not matter. validationActions may not contain duplicates of the same action. The supported actions values are: "Deny" specifies that a validation failure results in a denied request. "Warn" specifies that a validation failure is reported to the request client in HTTP Warning headers, with a warning code of 299. Warnings can be sent both for allowed or denied admission responses. "Audit" specifies that a validation failure is included in the published audit event for the request. The audit event will contain a `validation.policy.admission.k8s.io/validation_failure` audit annotation with a value containing the details of the validation failures, formatted as a JSON list of objects, each with the following fields: - message: The validation failure message string - policy: The resource name of the ValidatingAdmissionPolicy - binding: The resource name of the ValidatingAdmissionPolicyBinding - expressionIndex: The index of the failed validations in the ValidatingAdmissionPolicy - validationActions: The enforcement actions enacted for the validation failure Example audit annotation: `"validation.policy.admission.k8s.io/validation_failure": "[{\"message\": \"Invalid value\", {\"policy\": \"policy.example.com\", {\"binding\": \"policybinding.example.com\", {\"expressionIndex\": \"1\", {\"validationActions\": [\"Audit\"]}]"` Clients should expect to handle additional values by ignoring any values not recognized. "Deny" and "Warn" may not be used together since this combination needlessly duplicates the validation failure both in the API response body and the HTTP warning headers. Required. --- ### ValidatingAdmissionPolicyBindingSpecV1Beta1 ValidatingAdmissionPolicyBindingSpec is the specification of the ValidatingAdmissionPolicyBinding. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const validatingAdmissionPolicyBindingSpecV1Beta1: k8s.ValidatingAdmissionPolicyBindingSpecV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | matchResources | cdk8s-plus-32.k8s.MatchResourcesV1Beta1 | MatchResources declares what resources match this binding and will be validated by it. | | paramRef | cdk8s-plus-32.k8s.ParamRefV1Beta1 | paramRef specifies the parameter resource used to configure the admission control policy. | | policyName | string | PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to. | | validationActions | string[] | validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced. | --- ##### `matchResources`^Optional ```typescript public readonly matchResources: MatchResourcesV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.MatchResourcesV1Beta1 MatchResources declares what resources match this binding and will be validated by it. Note that this is intersected with the policy's matchConstraints, so only requests that are matched by the policy can be selected by this. If this is unset, all resources matched by the policy are validated by this binding When resourceRules is unset, it does not constrain resource matching. If a resource is matched by the other fields of this object, it will be validated. Note that this is differs from ValidatingAdmissionPolicy matchConstraints, where resourceRules are required. --- ##### `paramRef`^Optional ```typescript public readonly paramRef: ParamRefV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.ParamRefV1Beta1 paramRef specifies the parameter resource used to configure the admission control policy. It should point to a resource of the type specified in ParamKind of the bound ValidatingAdmissionPolicy. If the policy specifies a ParamKind and the resource referred to by ParamRef does not exist, this binding is considered mis-configured and the FailurePolicy of the ValidatingAdmissionPolicy applied. If the policy does not specify a ParamKind then this field is ignored, and the rules are evaluated without a param. --- ##### `policyName`^Optional ```typescript public readonly policyName: string; ``` - *Type:* string PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to. If the referenced resource does not exist, this binding is considered invalid and will be ignored Required. --- ##### `validationActions`^Optional ```typescript public readonly validationActions: string[]; ``` - *Type:* string[] validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced. If a validation evaluates to false it is always enforced according to these actions. Failures defined by the ValidatingAdmissionPolicy's FailurePolicy are enforced according to these actions only if the FailurePolicy is set to Fail, otherwise the failures are ignored. This includes compilation errors, runtime errors and misconfigurations of the policy. validationActions is declared as a set of action values. Order does not matter. validationActions may not contain duplicates of the same action. The supported actions values are: "Deny" specifies that a validation failure results in a denied request. "Warn" specifies that a validation failure is reported to the request client in HTTP Warning headers, with a warning code of 299. Warnings can be sent both for allowed or denied admission responses. "Audit" specifies that a validation failure is included in the published audit event for the request. The audit event will contain a `validation.policy.admission.k8s.io/validation_failure` audit annotation with a value containing the details of the validation failures, formatted as a JSON list of objects, each with the following fields: - message: The validation failure message string - policy: The resource name of the ValidatingAdmissionPolicy - binding: The resource name of the ValidatingAdmissionPolicyBinding - expressionIndex: The index of the failed validations in the ValidatingAdmissionPolicy - validationActions: The enforcement actions enacted for the validation failure Example audit annotation: `"validation.policy.admission.k8s.io/validation_failure": "[{\"message\": \"Invalid value\", {\"policy\": \"policy.example.com\", {\"binding\": \"policybinding.example.com\", {\"expressionIndex\": \"1\", {\"validationActions\": [\"Audit\"]}]"` Clients should expect to handle additional values by ignoring any values not recognized. "Deny" and "Warn" may not be used together since this combination needlessly duplicates the validation failure both in the API response body and the HTTP warning headers. Required. --- ### ValidatingAdmissionPolicySpec ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const validatingAdmissionPolicySpec: k8s.ValidatingAdmissionPolicySpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | auditAnnotations | cdk8s-plus-32.k8s.AuditAnnotation[] | auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request. | | failurePolicy | string | failurePolicy defines how to handle failures for the admission policy. | | matchConditions | cdk8s-plus-32.k8s.MatchCondition[] | MatchConditions is a list of conditions that must be met for a request to be validated. | | matchConstraints | cdk8s-plus-32.k8s.MatchResources | MatchConstraints specifies what resources this policy is designed to validate. | | paramKind | cdk8s-plus-32.k8s.ParamKind | ParamKind specifies the kind of resources used to parameterize this policy. | | validations | cdk8s-plus-32.k8s.Validation[] | Validations contain CEL expressions which is used to apply the validation. | | variables | cdk8s-plus-32.k8s.Variable[] | Variables contain definitions of variables that can be used in composition of other expressions. | --- ##### `auditAnnotations`^Optional ```typescript public readonly auditAnnotations: AuditAnnotation[]; ``` - *Type:* cdk8s-plus-32.k8s.AuditAnnotation[] auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is required. --- ##### `failurePolicy`^Optional ```typescript public readonly failurePolicy: string; ``` - *Type:* string - *Default:* Fail. failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions or bindings. A policy is invalid if spec.paramKind refers to a non-existent Kind. A binding is invalid if spec.paramRef.name refers to a non-existent resource. failurePolicy does not define how validations that evaluate to false are handled. When failurePolicy is set to Fail, ValidatingAdmissionPolicyBinding validationActions define how failures are enforced. Allowed values are Ignore or Fail. Defaults to Fail. --- ##### `matchConditions`^Optional ```typescript public readonly matchConditions: MatchCondition[]; ``` - *Type:* cdk8s-plus-32.k8s.MatchCondition[] MatchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed. If a parameter object is provided, it can be accessed via the `params` handle in the same manner as validation expressions. The exact matching logic is (in order): 1. If ANY matchCondition evaluates to FALSE, the policy is skipped. 2. If ALL matchConditions evaluate to TRUE, the policy is evaluated. 3. If any matchCondition evaluates to an error (but none are FALSE): - If failurePolicy=Fail, reject the request - If failurePolicy=Ignore, the policy is skipped --- ##### `matchConstraints`^Optional ```typescript public readonly matchConstraints: MatchResources; ``` - *Type:* cdk8s-plus-32.k8s.MatchResources MatchConstraints specifies what resources this policy is designed to validate. The AdmissionPolicy cares about a request if it matches _all_ Constraints. However, in order to prevent clusters from being put into an unstable state that cannot be recovered from via the API ValidatingAdmissionPolicy cannot match ValidatingAdmissionPolicy and ValidatingAdmissionPolicyBinding. Required. --- ##### `paramKind`^Optional ```typescript public readonly paramKind: ParamKind; ``` - *Type:* cdk8s-plus-32.k8s.ParamKind ParamKind specifies the kind of resources used to parameterize this policy. If absent, there are no parameters for this policy and the param CEL variable will not be provided to validation expressions. If ParamKind refers to a non-existent kind, this policy definition is mis-configured and the FailurePolicy is applied. If paramKind is specified but paramRef is unset in ValidatingAdmissionPolicyBinding, the params variable will be null. --- ##### `validations`^Optional ```typescript public readonly validations: Validation[]; ``` - *Type:* cdk8s-plus-32.k8s.Validation[] Validations contain CEL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required. --- ##### `variables`^Optional ```typescript public readonly variables: Variable[]; ``` - *Type:* cdk8s-plus-32.k8s.Variable[] Variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under `variables` in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy. The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, Variables must be sorted by the order of first appearance and acyclic. --- ### ValidatingAdmissionPolicySpecV1Beta1 ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const validatingAdmissionPolicySpecV1Beta1: k8s.ValidatingAdmissionPolicySpecV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | auditAnnotations | cdk8s-plus-32.k8s.AuditAnnotationV1Beta1[] | auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request. | | failurePolicy | string | failurePolicy defines how to handle failures for the admission policy. | | matchConditions | cdk8s-plus-32.k8s.MatchConditionV1Beta1[] | MatchConditions is a list of conditions that must be met for a request to be validated. | | matchConstraints | cdk8s-plus-32.k8s.MatchResourcesV1Beta1 | MatchConstraints specifies what resources this policy is designed to validate. | | paramKind | cdk8s-plus-32.k8s.ParamKindV1Beta1 | ParamKind specifies the kind of resources used to parameterize this policy. | | validations | cdk8s-plus-32.k8s.ValidationV1Beta1[] | Validations contain CEL expressions which is used to apply the validation. | | variables | cdk8s-plus-32.k8s.VariableV1Beta1[] | Variables contain definitions of variables that can be used in composition of other expressions. | --- ##### `auditAnnotations`^Optional ```typescript public readonly auditAnnotations: AuditAnnotationV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.AuditAnnotationV1Beta1[] auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is required. --- ##### `failurePolicy`^Optional ```typescript public readonly failurePolicy: string; ``` - *Type:* string - *Default:* Fail. failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions or bindings. A policy is invalid if spec.paramKind refers to a non-existent Kind. A binding is invalid if spec.paramRef.name refers to a non-existent resource. failurePolicy does not define how validations that evaluate to false are handled. When failurePolicy is set to Fail, ValidatingAdmissionPolicyBinding validationActions define how failures are enforced. Allowed values are Ignore or Fail. Defaults to Fail. --- ##### `matchConditions`^Optional ```typescript public readonly matchConditions: MatchConditionV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.MatchConditionV1Beta1[] MatchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed. If a parameter object is provided, it can be accessed via the `params` handle in the same manner as validation expressions. The exact matching logic is (in order): 1. If ANY matchCondition evaluates to FALSE, the policy is skipped. 2. If ALL matchConditions evaluate to TRUE, the policy is evaluated. 3. If any matchCondition evaluates to an error (but none are FALSE): - If failurePolicy=Fail, reject the request - If failurePolicy=Ignore, the policy is skipped --- ##### `matchConstraints`^Optional ```typescript public readonly matchConstraints: MatchResourcesV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.MatchResourcesV1Beta1 MatchConstraints specifies what resources this policy is designed to validate. The AdmissionPolicy cares about a request if it matches _all_ Constraints. However, in order to prevent clusters from being put into an unstable state that cannot be recovered from via the API ValidatingAdmissionPolicy cannot match ValidatingAdmissionPolicy and ValidatingAdmissionPolicyBinding. Required. --- ##### `paramKind`^Optional ```typescript public readonly paramKind: ParamKindV1Beta1; ``` - *Type:* cdk8s-plus-32.k8s.ParamKindV1Beta1 ParamKind specifies the kind of resources used to parameterize this policy. If absent, there are no parameters for this policy and the param CEL variable will not be provided to validation expressions. If ParamKind refers to a non-existent kind, this policy definition is mis-configured and the FailurePolicy is applied. If paramKind is specified but paramRef is unset in ValidatingAdmissionPolicyBinding, the params variable will be null. --- ##### `validations`^Optional ```typescript public readonly validations: ValidationV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.ValidationV1Beta1[] Validations contain CEL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required. --- ##### `variables`^Optional ```typescript public readonly variables: VariableV1Beta1[]; ``` - *Type:* cdk8s-plus-32.k8s.VariableV1Beta1[] Variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under `variables` in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy. The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, Variables must be sorted by the order of first appearance and acyclic. --- ### ValidatingWebhook ValidatingWebhook describes an admission webhook and the resources and operations it applies to. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const validatingWebhook: k8s.ValidatingWebhook = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | admissionReviewVersions | string[] | AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. | | clientConfig | cdk8s-plus-32.k8s.WebhookClientConfig | ClientConfig defines how to communicate with the hook. | | name | string | The name of the admission webhook. | | sideEffects | string | SideEffects states whether this webhook has side effects. | | failurePolicy | string | FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. | | matchConditions | cdk8s-plus-32.k8s.MatchCondition[] | MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. | | matchPolicy | string | matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". | | namespaceSelector | cdk8s-plus-32.k8s.LabelSelector | NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. | | objectSelector | cdk8s-plus-32.k8s.LabelSelector | ObjectSelector decides whether to run the webhook based on if the object has matching labels. | | rules | cdk8s-plus-32.k8s.RuleWithOperations[] | Rules describes what operations on what resources/subresources the webhook cares about. | | timeoutSeconds | number | TimeoutSeconds specifies the timeout for this webhook. | --- ##### `admissionReviewVersions`^Required ```typescript public readonly admissionReviewVersions: string[]; ``` - *Type:* string[] AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. --- ##### `clientConfig`^Required ```typescript public readonly clientConfig: WebhookClientConfig; ``` - *Type:* cdk8s-plus-32.k8s.WebhookClientConfig ClientConfig defines how to communicate with the hook. Required --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. --- ##### `sideEffects`^Required ```typescript public readonly sideEffects: string; ``` - *Type:* string SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. --- ##### `failurePolicy`^Optional ```typescript public readonly failurePolicy: string; ``` - *Type:* string - *Default:* Fail. FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail. --- ##### `matchConditions`^Optional ```typescript public readonly matchConditions: MatchCondition[]; ``` - *Type:* cdk8s-plus-32.k8s.MatchCondition[] MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed. The exact matching logic is (in order): 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped. 2. If ALL matchConditions evaluate to TRUE, the webhook is called. 3. If any matchCondition evaluates to an error (but none are FALSE): - If failurePolicy=Fail, reject the request - If failurePolicy=Ignore, the error is ignored and the webhook is skipped --- ##### `matchPolicy`^Optional ```typescript public readonly matchPolicy: string; ``` - *Type:* string - *Default:* Equivalent" matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Equivalent" --- ##### `namespaceSelector`^Optional ```typescript public readonly namespaceSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector - *Default:* the empty LabelSelector, which matches everything. NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors. Default to the empty LabelSelector, which matches everything. --- ##### `objectSelector`^Optional ```typescript public readonly objectSelector: LabelSelector; ``` - *Type:* cdk8s-plus-32.k8s.LabelSelector - *Default:* the empty LabelSelector, which matches everything. ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. --- ##### `rules`^Optional ```typescript public readonly rules: RuleWithOperations[]; ``` - *Type:* cdk8s-plus-32.k8s.RuleWithOperations[] Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. --- ##### `timeoutSeconds`^Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* 10 seconds. TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. --- ### Validation Validation specifies the CEL expression which is used to apply the validation. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const validation: k8s.Validation = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | Expression represents the expression which will be evaluated by CEL. | | message | string | Message represents the message displayed when validation fails. | | messageExpression | string | messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. | | reason | string | Reason represents a machine-readable description of why this validation failed. | --- ##### `expression`^Required ```typescript public readonly expression: string; ``` - *Type:* string Expression represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the API request/response, organized into CEL variables as well as some other useful variables: - 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value. For example, a variable named 'foo' can be accessed as 'variables.foo'. - 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz - 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the request resource. The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object. No other metadata properties are accessible. Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples: - Expression accessing a property named "namespace": {"Expression": "object.__namespace__ > 0"} - Expression accessing a property named "x-prop": {"Expression": "object.x__dash__prop > 0"} - Expression accessing a property named "redact__d": {"Expression": "object.redact__underscores__d > 0"} Equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type: - 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and non-intersecting elements in `Y` are appended, retaining their partial order. - 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with non-intersecting keys are appended, retaining their partial order. Required. --- ##### `message`^Optional ```typescript public readonly message: string; ``` - *Type:* string Message represents the message displayed when validation fails. The message is required if the Expression contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" If the Expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is "failed Expression: {Expression}". --- ##### `messageExpression`^Optional ```typescript public readonly messageExpression: string; ``` - *Type:* string messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a validation, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the `expression` except for 'authorizer' and 'authorizer.requestResource'. Example: "object.x must be less than max ("+string(params.max)+")" --- ##### `reason`^Optional ```typescript public readonly reason: string; ``` - *Type:* string Reason represents a machine-readable description of why this validation failed. If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestEntityTooLarge". If not set, StatusReasonInvalid is used in the response to the client. --- ### ValidationRule ValidationRule describes a validation rule written in the CEL expression language. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const validationRule: k8s.ValidationRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | rule | string | Rule represents the expression which will be evaluated by CEL. | | fieldPath | string | fieldPath represents the field path returned when the validation fails. | | message | string | Message represents the message displayed when validation fails. | | messageExpression | string | MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. | | optionalOldSelf | boolean | optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value. | | reason | string | reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. | --- ##### `rule`^Required ```typescript public readonly rule: string; ``` - *Type:* string Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The `self` variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual <= self.spec.maxDesired"} If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via `self.field` and field presence can be checked via `has(self.field)`. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible via `self[mapKey]`, map containment can be checked via `mapKey in self` and all entries of the map are accessible via CEL macros and functions such as `self.all(...)`. If the Rule is scoped to an array, the elements of the array are accessible via `self[i]` and also by macros and functions. If the Rule is scoped to a scalar, `self` is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components['Widget'].priority < 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value >= 0 && value < 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"} The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible. Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as: - A schema with no type and x-kubernetes-preserve-unknown-fields set to true - An array where the items schema is of an "unknown type" - An object where the additionalProperties schema is of an "unknown type" Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples: - Rule accessing a property named "namespace": {"rule": "self.__namespace__ > 0"} - Rule accessing a property named "x-prop": {"rule": "self.x__dash__prop > 0"} - Rule accessing a property named "redact__d": {"rule": "self.redact__underscores__d > 0"} Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type: - 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and non-intersecting elements in `Y` are appended, retaining their partial order. - 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with non-intersecting keys are appended, retaining their partial order. If `rule` makes use of the `oldSelf` variable it is implicitly a `transition rule`. By default, the `oldSelf` variable is the same type as `self`. When `optionalOldSelf` is true, the `oldSelf` variable is a CEL optional variable whose value() is the same type as `self`. See the documentation for the `optionalOldSelf` field for details. Transition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found. You can opt a transition rule into unconditional evaluation by setting `optionalOldSelf` to true. --- ##### `fieldPath`^Optional ```typescript public readonly fieldPath: string; ``` - *Type:* string fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute `foo` under a map `testMap`, the fieldPath could be set to `.testMap.foo` If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. `.testList` It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to [JSONPath support in Kubernetes](https://kubernetes.io/docs/reference/kubectl/jsonpath/) for more info. Numeric index of array is not supported. For field name which contains special characters, use `['specialName']` to refer the field name. e.g. for attribute `foo.34$` appears in a list `testList`, the fieldPath could be set to `.testList['foo.34$']` --- ##### `message`^Optional ```typescript public readonly message: string; ``` - *Type:* string Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" --- ##### `messageExpression`^Optional ```typescript public readonly messageExpression: string; ``` - *Type:* string MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: "x must be less than max ("+string(self.max)+")" --- ##### `optionalOldSelf`^Optional ```typescript public readonly optionalOldSelf: boolean; ``` - *Type:* boolean optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value. When enabled `oldSelf` will be a CEL optional whose value will be `None` if there is no old value, or when the object is initially created. You may check for presence of oldSelf using `oldSelf.hasValue()` and unwrap it after checking using `oldSelf.value()`. Check the CEL documentation for Optional types for more information: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypes May not be set unless `oldSelf` is used in `rule`. --- ##### `reason`^Optional ```typescript public readonly reason: string; ``` - *Type:* string reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid. --- ### ValidationV1Beta1 Validation specifies the CEL expression which is used to apply the validation. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const validationV1Beta1: k8s.ValidationV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | Expression represents the expression which will be evaluated by CEL. | | message | string | Message represents the message displayed when validation fails. | | messageExpression | string | messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. | | reason | string | Reason represents a machine-readable description of why this validation failed. | --- ##### `expression`^Required ```typescript public readonly expression: string; ``` - *Type:* string Expression represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the API request/response, organized into CEL variables as well as some other useful variables: - 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value. For example, a variable named 'foo' can be accessed as 'variables.foo'. - 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz - 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the request resource. The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object. No other metadata properties are accessible. Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples: - Expression accessing a property named "namespace": {"Expression": "object.__namespace__ > 0"} - Expression accessing a property named "x-prop": {"Expression": "object.x__dash__prop > 0"} - Expression accessing a property named "redact__d": {"Expression": "object.redact__underscores__d > 0"} Equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type: - 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and non-intersecting elements in `Y` are appended, retaining their partial order. - 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with non-intersecting keys are appended, retaining their partial order. Required. --- ##### `message`^Optional ```typescript public readonly message: string; ``` - *Type:* string Message represents the message displayed when validation fails. The message is required if the Expression contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" If the Expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is "failed Expression: {Expression}". --- ##### `messageExpression`^Optional ```typescript public readonly messageExpression: string; ``` - *Type:* string messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a validation, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the `expression` except for 'authorizer' and 'authorizer.requestResource'. Example: "object.x must be less than max ("+string(params.max)+")" --- ##### `reason`^Optional ```typescript public readonly reason: string; ``` - *Type:* string Reason represents a machine-readable description of why this validation failed. If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestEntityTooLarge". If not set, StatusReasonInvalid is used in the response to the client. --- ### Variable Variable is the definition of a variable that is used for composition. A variable is defined as a named expression. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const variable: k8s.Variable = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | Expression is the expression that will be evaluated as the value of the variable. | | name | string | Name is the name of the variable. | --- ##### `expression`^Required ```typescript public readonly expression: string; ``` - *Type:* string Expression is the expression that will be evaluated as the value of the variable. The CEL expression has access to the same identifiers as the CEL expressions in Validation. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is the name of the variable. The name must be a valid CEL identifier and unique among all variables. The variable can be accessed in other expressions through `variables` For example, if name is "foo", the variable will be available as `variables.foo` --- ### VariableV1Alpha1 Variable is the definition of a variable that is used for composition. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const variableV1Alpha1: k8s.VariableV1Alpha1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | Expression is the expression that will be evaluated as the value of the variable. | | name | string | Name is the name of the variable. | --- ##### `expression`^Required ```typescript public readonly expression: string; ``` - *Type:* string Expression is the expression that will be evaluated as the value of the variable. The CEL expression has access to the same identifiers as the CEL expressions in Validation. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is the name of the variable. The name must be a valid CEL identifier and unique among all variables. The variable can be accessed in other expressions through `variables` For example, if name is "foo", the variable will be available as `variables.foo` --- ### VariableV1Beta1 Variable is the definition of a variable that is used for composition. A variable is defined as a named expression. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const variableV1Beta1: k8s.VariableV1Beta1 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | Expression is the expression that will be evaluated as the value of the variable. | | name | string | Name is the name of the variable. | --- ##### `expression`^Required ```typescript public readonly expression: string; ``` - *Type:* string Expression is the expression that will be evaluated as the value of the variable. The CEL expression has access to the same identifiers as the CEL expressions in Validation. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name is the name of the variable. The name must be a valid CEL identifier and unique among all variables. The variable can be accessed in other expressions through `variables` For example, if name is "foo", the variable will be available as `variables.foo` --- ### Volume Volume represents a named volume in a pod that may be accessed by any container in the pod. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const volume: k8s.Volume = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | name of the volume. | | awsElasticBlockStore | cdk8s-plus-32.k8s.AwsElasticBlockStoreVolumeSource | awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. | | azureDisk | cdk8s-plus-32.k8s.AzureDiskVolumeSource | azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. | | azureFile | cdk8s-plus-32.k8s.AzureFileVolumeSource | azureFile represents an Azure File Service mount on the host and bind mount to the pod. | | cephfs | cdk8s-plus-32.k8s.CephFsVolumeSource | cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. | | cinder | cdk8s-plus-32.k8s.CinderVolumeSource | cinder represents a cinder volume attached and mounted on kubelets host machine. | | configMap | cdk8s-plus-32.k8s.ConfigMapVolumeSource | configMap represents a configMap that should populate this volume. | | csi | cdk8s-plus-32.k8s.CsiVolumeSource | csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers. | | downwardApi | cdk8s-plus-32.k8s.DownwardApiVolumeSource | downwardAPI represents downward API about the pod that should populate this volume. | | emptyDir | cdk8s-plus-32.k8s.EmptyDirVolumeSource | emptyDir represents a temporary directory that shares a pod's lifetime. | | ephemeral | cdk8s-plus-32.k8s.EphemeralVolumeSource | ephemeral represents a volume that is handled by a cluster storage driver. | | fc | cdk8s-plus-32.k8s.FcVolumeSource | fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. | | flexVolume | cdk8s-plus-32.k8s.FlexVolumeSource | flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. | | flocker | cdk8s-plus-32.k8s.FlockerVolumeSource | flocker represents a Flocker volume attached to a kubelet's host machine. | | gcePersistentDisk | cdk8s-plus-32.k8s.GcePersistentDiskVolumeSource | gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. | | gitRepo | cdk8s-plus-32.k8s.GitRepoVolumeSource | gitRepo represents a git repository at a particular revision. | | glusterfs | cdk8s-plus-32.k8s.GlusterfsVolumeSource | glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. | | hostPath | cdk8s-plus-32.k8s.HostPathVolumeSource | hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. | | image | cdk8s-plus-32.k8s.ImageVolumeSource | image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. | | iscsi | cdk8s-plus-32.k8s.IscsiVolumeSource | iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. | | nfs | cdk8s-plus-32.k8s.NfsVolumeSource | nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs. | | persistentVolumeClaim | cdk8s-plus-32.k8s.PersistentVolumeClaimVolumeSource | persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. | | photonPersistentDisk | cdk8s-plus-32.k8s.PhotonPersistentDiskVolumeSource | photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. | | portworxVolume | cdk8s-plus-32.k8s.PortworxVolumeSource | portworxVolume represents a portworx volume attached and mounted on kubelets host machine. | | projected | cdk8s-plus-32.k8s.ProjectedVolumeSource | projected items for all in one resources secrets, configmaps, and downward API. | | quobyte | cdk8s-plus-32.k8s.QuobyteVolumeSource | quobyte represents a Quobyte mount on the host that shares a pod's lifetime. | | rbd | cdk8s-plus-32.k8s.RbdVolumeSource | rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. | | scaleIo | cdk8s-plus-32.k8s.ScaleIoVolumeSource | scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. | | secret | cdk8s-plus-32.k8s.SecretVolumeSource | secret represents a secret that should populate this volume. | | storageos | cdk8s-plus-32.k8s.StorageOsVolumeSource | storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. | | vsphereVolume | cdk8s-plus-32.k8s.VsphereVirtualDiskVolumeSource | vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names --- ##### `awsElasticBlockStore`^Optional ```typescript public readonly awsElasticBlockStore: AwsElasticBlockStoreVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.AwsElasticBlockStoreVolumeSource awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore --- ##### `azureDisk`^Optional ```typescript public readonly azureDisk: AzureDiskVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.AzureDiskVolumeSource azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver. --- ##### `azureFile`^Optional ```typescript public readonly azureFile: AzureFileVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.AzureFileVolumeSource azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver. --- ##### `cephfs`^Optional ```typescript public readonly cephfs: CephFsVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.CephFsVolumeSource cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported. --- ##### `cinder`^Optional ```typescript public readonly cinder: CinderVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.CinderVolumeSource cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md --- ##### `configMap`^Optional ```typescript public readonly configMap: ConfigMapVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.ConfigMapVolumeSource configMap represents a configMap that should populate this volume. --- ##### `csi`^Optional ```typescript public readonly csi: CsiVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.CsiVolumeSource csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers. --- ##### `downwardApi`^Optional ```typescript public readonly downwardApi: DownwardApiVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.DownwardApiVolumeSource downwardAPI represents downward API about the pod that should populate this volume. --- ##### `emptyDir`^Optional ```typescript public readonly emptyDir: EmptyDirVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.EmptyDirVolumeSource emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir --- ##### `ephemeral`^Optional ```typescript public readonly ephemeral: EphemeralVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.EphemeralVolumeSource ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. --- ##### `fc`^Optional ```typescript public readonly fc: FcVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.FcVolumeSource fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. --- ##### `flexVolume`^Optional ```typescript public readonly flexVolume: FlexVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.FlexVolumeSource flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead. --- ##### `flocker`^Optional ```typescript public readonly flocker: FlockerVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.FlockerVolumeSource flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported. --- ##### `gcePersistentDisk`^Optional ```typescript public readonly gcePersistentDisk: GcePersistentDiskVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.GcePersistentDiskVolumeSource gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk --- ##### `gitRepo`^Optional ```typescript public readonly gitRepo: GitRepoVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.GitRepoVolumeSource gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. --- ##### `glusterfs`^Optional ```typescript public readonly glusterfs: GlusterfsVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.GlusterfsVolumeSource glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.md --- ##### `hostPath`^Optional ```typescript public readonly hostPath: HostPathVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.HostPathVolumeSource hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- ##### `image`^Optional ```typescript public readonly image: ImageVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.ImageVolumeSource image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided: - Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. - Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. - IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath). The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type. --- ##### `iscsi`^Optional ```typescript public readonly iscsi: IscsiVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.IscsiVolumeSource iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md --- ##### `nfs`^Optional ```typescript public readonly nfs: NfsVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.NfsVolumeSource nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs. --- ##### `persistentVolumeClaim`^Optional ```typescript public readonly persistentVolumeClaim: PersistentVolumeClaimVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.PersistentVolumeClaimVolumeSource persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims --- ##### `photonPersistentDisk`^Optional ```typescript public readonly photonPersistentDisk: PhotonPersistentDiskVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.PhotonPersistentDiskVolumeSource photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported. --- ##### `portworxVolume`^Optional ```typescript public readonly portworxVolume: PortworxVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.PortworxVolumeSource portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on. --- ##### `projected`^Optional ```typescript public readonly projected: ProjectedVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.ProjectedVolumeSource projected items for all in one resources secrets, configmaps, and downward API. --- ##### `quobyte`^Optional ```typescript public readonly quobyte: QuobyteVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.QuobyteVolumeSource quobyte represents a Quobyte mount on the host that shares a pod's lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported. --- ##### `rbd`^Optional ```typescript public readonly rbd: RbdVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.RbdVolumeSource rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.md --- ##### `scaleIo`^Optional ```typescript public readonly scaleIo: ScaleIoVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.ScaleIoVolumeSource scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported. --- ##### `secret`^Optional ```typescript public readonly secret: SecretVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.SecretVolumeSource secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret --- ##### `storageos`^Optional ```typescript public readonly storageos: StorageOsVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.StorageOsVolumeSource storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. --- ##### `vsphereVolume`^Optional ```typescript public readonly vsphereVolume: VsphereVirtualDiskVolumeSource; ``` - *Type:* cdk8s-plus-32.k8s.VsphereVirtualDiskVolumeSource vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver. --- ### VolumeAttachmentSource VolumeAttachmentSource represents a volume that should be attached. Right now only PersistentVolumes can be attached via external attacher, in the future we may allow also inline volumes in pods. Exactly one member can be set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const volumeAttachmentSource: k8s.VolumeAttachmentSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | inlineVolumeSpec | cdk8s-plus-32.k8s.PersistentVolumeSpec | inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. | | persistentVolumeName | string | persistentVolumeName represents the name of the persistent volume to attach. | --- ##### `inlineVolumeSpec`^Optional ```typescript public readonly inlineVolumeSpec: PersistentVolumeSpec; ``` - *Type:* cdk8s-plus-32.k8s.PersistentVolumeSpec inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature. --- ##### `persistentVolumeName`^Optional ```typescript public readonly persistentVolumeName: string; ``` - *Type:* string persistentVolumeName represents the name of the persistent volume to attach. --- ### VolumeAttachmentSpec VolumeAttachmentSpec is the specification of a VolumeAttachment request. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const volumeAttachmentSpec: k8s.VolumeAttachmentSpec = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attacher | string | attacher indicates the name of the volume driver that MUST handle this request. | | nodeName | string | nodeName represents the node that the volume should be attached to. | | source | cdk8s-plus-32.k8s.VolumeAttachmentSource | source represents the volume that should be attached. | --- ##### `attacher`^Required ```typescript public readonly attacher: string; ``` - *Type:* string attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). --- ##### `nodeName`^Required ```typescript public readonly nodeName: string; ``` - *Type:* string nodeName represents the node that the volume should be attached to. --- ##### `source`^Required ```typescript public readonly source: VolumeAttachmentSource; ``` - *Type:* cdk8s-plus-32.k8s.VolumeAttachmentSource source represents the volume that should be attached. --- ### VolumeDevice volumeDevice describes a mapping of a raw block device within a container. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const volumeDevice: k8s.VolumeDevice = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | devicePath | string | devicePath is the path inside of the container that the device will be mapped to. | | name | string | name must match the name of a persistentVolumeClaim in the pod. | --- ##### `devicePath`^Required ```typescript public readonly devicePath: string; ``` - *Type:* string devicePath is the path inside of the container that the device will be mapped to. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string name must match the name of a persistentVolumeClaim in the pod. --- ### VolumeMount Mount a volume from the pod to the container. #### Initializer ```typescript import { VolumeMount } from 'cdk8s-plus-32' const volumeMount: VolumeMount = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | propagation | MountPropagation | Determines how mounts are propagated from the host to container and the other way around. | | readOnly | boolean | Mounted read-only if true, read-write otherwise (false or unspecified). | | subPath | string | Path within the volume from which the container's volume should be mounted.). | | subPathExpr | string | Expanded path within the volume from which the container's volume should be mounted. | | path | string | Path within the container at which the volume should be mounted. | | volume | Volume | The volume to mount. | --- ##### `propagation`^Optional ```typescript public readonly propagation: MountPropagation; ``` - *Type:* MountPropagation - *Default:* MountPropagation.NONE Determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. Mount propagation allows for sharing volumes mounted by a Container to other Containers in the same Pod, or even to other Pods on the same node. --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. --- ##### `subPath`^Optional ```typescript public readonly subPath: string; ``` - *Type:* string - *Default:* "" the volume's root Path within the volume from which the container's volume should be mounted.). --- ##### `subPathExpr`^Optional ```typescript public readonly subPathExpr: string; ``` - *Type:* string - *Default:* "" volume's root. Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). `subPathExpr` and `subPath` are mutually exclusive. --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string Path within the container at which the volume should be mounted. Must not contain ':'. --- ##### `volume`^Required ```typescript public readonly volume: Volume; ``` - *Type:* Volume The volume to mount. --- ### VolumeMount VolumeMount describes a mounting of a Volume within a container. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const volumeMount: k8s.VolumeMount = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | mountPath | string | Path within the container at which the volume should be mounted. | | name | string | This must match the Name of a Volume. | | mountPropagation | string | mountPropagation determines how mounts are propagated from the host to container and the other way around. | | readOnly | boolean | Mounted read-only if true, read-write otherwise (false or unspecified). | | recursiveReadOnly | string | RecursiveReadOnly specifies whether read-only mounts should be handled recursively. | | subPath | string | Path within the volume from which the container's volume should be mounted. | | subPathExpr | string | Expanded path within the volume from which the container's volume should be mounted. | --- ##### `mountPath`^Required ```typescript public readonly mountPath: string; ``` - *Type:* string Path within the container at which the volume should be mounted. Must not contain ':'. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string This must match the Name of a Volume. --- ##### `mountPropagation`^Optional ```typescript public readonly mountPropagation: string; ``` - *Type:* string mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None). --- ##### `readOnly`^Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* boolean - *Default:* false. Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. --- ##### `recursiveReadOnly`^Optional ```typescript public readonly recursiveReadOnly: string; ``` - *Type:* string RecursiveReadOnly specifies whether read-only mounts should be handled recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason. If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None). If this field is not specified, it is treated as an equivalent of Disabled. --- ##### `subPath`^Optional ```typescript public readonly subPath: string; ``` - *Type:* string - *Default:* volume's root). Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). --- ##### `subPathExpr`^Optional ```typescript public readonly subPathExpr: string; ``` - *Type:* string - *Default:* volume's root). SubPathExpr and SubPath are mutually exclusive. Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. --- ### VolumeNodeAffinity VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const volumeNodeAffinity: k8s.VolumeNodeAffinity = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | required | cdk8s-plus-32.k8s.NodeSelector | required specifies hard node constraints that must be met. | --- ##### `required`^Optional ```typescript public readonly required: NodeSelector; ``` - *Type:* cdk8s-plus-32.k8s.NodeSelector required specifies hard node constraints that must be met. --- ### VolumeNodeResources VolumeNodeResources is a set of resource limits for scheduling of volumes. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const volumeNodeResources: k8s.VolumeNodeResources = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | count | number | count indicates the maximum number of unique volumes managed by the CSI driver that can be used on a node. | --- ##### `count`^Optional ```typescript public readonly count: number; ``` - *Type:* number count indicates the maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded. --- ### VolumeProjection Projection that may be projected along with other supported volume types. Exactly one of these fields must be set. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const volumeProjection: k8s.VolumeProjection = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterTrustBundle | cdk8s-plus-32.k8s.ClusterTrustBundleProjection | ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. | | configMap | cdk8s-plus-32.k8s.ConfigMapProjection | configMap information about the configMap data to project. | | downwardApi | cdk8s-plus-32.k8s.DownwardApiProjection | downwardAPI information about the downwardAPI data to project. | | secret | cdk8s-plus-32.k8s.SecretProjection | secret information about the secret data to project. | | serviceAccountToken | cdk8s-plus-32.k8s.ServiceAccountTokenProjection | serviceAccountToken is information about the serviceAccountToken data to project. | --- ##### `clusterTrustBundle`^Optional ```typescript public readonly clusterTrustBundle: ClusterTrustBundleProjection; ``` - *Type:* cdk8s-plus-32.k8s.ClusterTrustBundleProjection ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time. --- ##### `configMap`^Optional ```typescript public readonly configMap: ConfigMapProjection; ``` - *Type:* cdk8s-plus-32.k8s.ConfigMapProjection configMap information about the configMap data to project. --- ##### `downwardApi`^Optional ```typescript public readonly downwardApi: DownwardApiProjection; ``` - *Type:* cdk8s-plus-32.k8s.DownwardApiProjection downwardAPI information about the downwardAPI data to project. --- ##### `secret`^Optional ```typescript public readonly secret: SecretProjection; ``` - *Type:* cdk8s-plus-32.k8s.SecretProjection secret information about the secret data to project. --- ##### `serviceAccountToken`^Optional ```typescript public readonly serviceAccountToken: ServiceAccountTokenProjection; ``` - *Type:* cdk8s-plus-32.k8s.ServiceAccountTokenProjection serviceAccountToken is information about the serviceAccountToken data to project. --- ### VolumeResourceRequirements VolumeResourceRequirements describes the storage resource requirements for a volume. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const volumeResourceRequirements: k8s.VolumeResourceRequirements = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | limits | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | Limits describes the maximum amount of compute resources allowed. | | requests | {[ key: string ]: cdk8s-plus-32.k8s.Quantity} | Requests describes the minimum amount of compute resources required. | --- ##### `limits`^Optional ```typescript public readonly limits: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ --- ##### `requests`^Optional ```typescript public readonly requests: {[ key: string ]: Quantity}; ``` - *Type:* {[ key: string ]: cdk8s-plus-32.k8s.Quantity} Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ --- ### VsphereVirtualDiskVolumeSource Represents a vSphere volume resource. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const vsphereVirtualDiskVolumeSource: k8s.VsphereVirtualDiskVolumeSource = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | volumePath | string | volumePath is the path that identifies vSphere volume vmdk. | | fsType | string | fsType is filesystem type to mount. | | storagePolicyId | string | storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. | | storagePolicyName | string | storagePolicyName is the storage Policy Based Management (SPBM) profile name. | --- ##### `volumePath`^Required ```typescript public readonly volumePath: string; ``` - *Type:* string volumePath is the path that identifies vSphere volume vmdk. --- ##### `fsType`^Optional ```typescript public readonly fsType: string; ``` - *Type:* string fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. --- ##### `storagePolicyId`^Optional ```typescript public readonly storagePolicyId: string; ``` - *Type:* string storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. --- ##### `storagePolicyName`^Optional ```typescript public readonly storagePolicyName: string; ``` - *Type:* string storagePolicyName is the storage Policy Based Management (SPBM) profile name. --- ### WebhookClientConfig WebhookClientConfig contains the information to make a TLS connection with the webhook. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const webhookClientConfig: k8s.WebhookClientConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | caBundle | string | `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. | | service | cdk8s-plus-32.k8s.ServiceReference | `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. | | url | string | `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). | --- ##### `caBundle`^Optional ```typescript public readonly caBundle: string; ``` - *Type:* string `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. --- ##### `service`^Optional ```typescript public readonly service: ServiceReference; ``` - *Type:* cdk8s-plus-32.k8s.ServiceReference `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. If the webhook is running within the cluster, then you should use `service`. --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. --- ### WebhookConversion WebhookConversion describes how to call a conversion webhook. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const webhookConversion: k8s.WebhookConversion = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | conversionReviewVersions | string[] | conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. | | clientConfig | cdk8s-plus-32.k8s.WebhookClientConfig | clientConfig is the instructions for how to call the webhook if strategy is `Webhook`. | --- ##### `conversionReviewVersions`^Required ```typescript public readonly conversionReviewVersions: string[]; ``` - *Type:* string[] conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. --- ##### `clientConfig`^Optional ```typescript public readonly clientConfig: WebhookClientConfig; ``` - *Type:* cdk8s-plus-32.k8s.WebhookClientConfig clientConfig is the instructions for how to call the webhook if strategy is `Webhook`. --- ### WeightedPodAffinityTerm The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s). #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const weightedPodAffinityTerm: k8s.WeightedPodAffinityTerm = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | podAffinityTerm | cdk8s-plus-32.k8s.PodAffinityTerm | Required. | | weight | number | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. | --- ##### `podAffinityTerm`^Required ```typescript public readonly podAffinityTerm: PodAffinityTerm; ``` - *Type:* cdk8s-plus-32.k8s.PodAffinityTerm Required. A pod affinity term, associated with the corresponding weight. --- ##### `weight`^Required ```typescript public readonly weight: number; ``` - *Type:* number weight associated with matching the corresponding podAffinityTerm, in the range 1-100. --- ### WindowsSecurityContextOptions WindowsSecurityContextOptions contain Windows-specific options and credentials. #### Initializer ```typescript import { k8s } from 'cdk8s-plus-32' const windowsSecurityContextOptions: k8s.WindowsSecurityContextOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | gmsaCredentialSpec | string | GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. | | gmsaCredentialSpecName | string | GMSACredentialSpecName is the name of the GMSA credential spec to use. | | hostProcess | boolean | HostProcess determines if a container should be run as a 'Host Process' container. | | runAsUserName | string | The UserName in Windows to run the entrypoint of the container process. | --- ##### `gmsaCredentialSpec`^Optional ```typescript public readonly gmsaCredentialSpec: string; ``` - *Type:* string GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. --- ##### `gmsaCredentialSpecName`^Optional ```typescript public readonly gmsaCredentialSpecName: string; ``` - *Type:* string GMSACredentialSpecName is the name of the GMSA credential spec to use. --- ##### `hostProcess`^Optional ```typescript public readonly hostProcess: boolean; ``` - *Type:* boolean HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. --- ##### `runAsUserName`^Optional ```typescript public readonly runAsUserName: string; ``` - *Type:* string - *Default:* the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. --- ### WorkloadProps Properties for `Workload`. #### Initializer ```typescript import { WorkloadProps } from 'cdk8s-plus-32' const workloadProps: WorkloadProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | boolean | Indicates whether a service account token should be automatically mounted. | | containers | ContainerProps[] | List of containers belonging to the pod. | | dns | PodDnsProps | DNS settings for the pod. | | dockerRegistryAuth | ISecret | A secret containing docker credentials for authenticating to a registry. | | enableServiceLinks | boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | HostAlias[] | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | boolean | Host network for the pod. | | initContainers | ContainerProps[] | List of initialization containers belonging to the pod. | | isolate | boolean | Isolates the pod. | | restartPolicy | RestartPolicy | Restart policy for all containers within the pod. | | securityContext | PodSecurityContextProps | SecurityContext holds pod-level security attributes and common container settings. | | serviceAccount | IServiceAccount | A service account provides an identity for processes that run in a Pod. | | shareProcessNamespace | boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | cdk8s.Duration | Grace period until the pod is terminated. | | volumes | Volume[] | List of volumes that can be mounted by containers belonging to the pod. | | podMetadata | cdk8s.ApiObjectMetadata | The pod metadata of this workload. | | select | boolean | Automatically allocates a pod label selector for this workload and add it to the pod metadata. | | spread | boolean | Automatically spread pods across hostname and zones. | --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether a service account token should be automatically mounted. > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server) --- ##### `containers`^Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No containers. Note that a pod spec must include at least one container. List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. You can add additionnal containers using `podSpec.addContainer()` --- ##### `dns`^Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* PodDnsProps - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > [https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/) --- ##### `dockerRegistryAuth`^Optional ```typescript public readonly dockerRegistryAuth: ISecret; ``` - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional ```typescript public readonly enableServiceLinks: boolean; ``` - *Type:* boolean - *Default:* true Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. > [https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) --- ##### `hostAliases`^Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* HostAlias[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional ```typescript public readonly hostNetwork: boolean; ``` - *Type:* boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* ContainerProps[] - *Default:* No init containers. List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added ,removed or updated. > [https://kubernetes.io/docs/concepts/workloads/pods/init-containers/](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) --- ##### `isolate`^Optional ```typescript public readonly isolate: boolean; ``` - *Type:* boolean - *Default:* false Isolates the pod. This will prevent any ingress or egress connections to / from this pod. You can however allow explicit connections post instantiation by using the `.connections` property. --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* RestartPolicy - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > [https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy) --- ##### `securityContext`^Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* IServiceAccount - *Default:* No service account. A service account provides an identity for processes that run in a Pod. When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default). > [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) --- ##### `shareProcessNamespace`^Optional ```typescript public readonly shareProcessNamespace: boolean; ``` - *Type:* boolean - *Default:* false When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. > [https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/](https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/) --- ##### `terminationGracePeriod`^Optional ```typescript public readonly terminationGracePeriod: Duration; ``` - *Type:* cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* Volume[] - *Default:* No volumes. List of volumes that can be mounted by containers belonging to the pod. You can also add volumes later using `podSpec.addVolume()` > [https://kubernetes.io/docs/concepts/storage/volumes](https://kubernetes.io/docs/concepts/storage/volumes) --- ##### `podMetadata`^Optional ```typescript public readonly podMetadata: ApiObjectMetadata; ``` - *Type:* cdk8s.ApiObjectMetadata The pod metadata of this workload. --- ##### `select`^Optional ```typescript public readonly select: boolean; ``` - *Type:* boolean - *Default:* true Automatically allocates a pod label selector for this workload and add it to the pod metadata. This ensures this workload manages pods created by its pod template. --- ##### `spread`^Optional ```typescript public readonly spread: boolean; ``` - *Type:* boolean - *Default:* false Automatically spread pods across hostname and zones. > [https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints) --- ### WorkloadSchedulingSpreadOptions Options for `WorkloadScheduling.spread`. #### Initializer ```typescript import { WorkloadSchedulingSpreadOptions } from 'cdk8s-plus-32' const workloadSchedulingSpreadOptions: WorkloadSchedulingSpreadOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | topology | Topology | Which topology to spread on. | | weight | number | Indicates the spread is optional, with this weight score. | --- ##### `topology`^Optional ```typescript public readonly topology: Topology; ``` - *Type:* Topology - *Default:* Topology.HOSTNAME Which topology to spread on. --- ##### `weight`^Optional ```typescript public readonly weight: number; ``` - *Type:* number - *Default:* no weight. spread is assumed to be required. Indicates the spread is optional, with this weight score. --- ## Classes ### ApiResource - *Implements:* IApiResource, IApiEndpoint Represents information about an API resource type. #### Methods | **Name** | **Description** | | --- | --- | | asApiResource | Return the IApiResource this object represents. | | asNonApiResource | Return the non resource url this object represents. | --- ##### `asApiResource` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. #### Static Functions | **Name** | **Description** | | --- | --- | | custom | API resource information for a custom resource type. | --- ##### `custom` ```typescript import { ApiResource } from 'cdk8s-plus-32' ApiResource.custom(options: ApiResourceOptions) ``` API resource information for a custom resource type. ###### `options`^Required - *Type:* ApiResourceOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | | resourceType | string | The name of the resource type as it appears in the relevant API endpoint. | --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of the resource type as it appears in the relevant API endpoint. > [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources) --- *Example* ```typescript - "pods" or "pods/log" ``` #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | API_SERVICES | ApiResource | API resource information for APIService. | | BINDINGS | ApiResource | API resource information for Binding. | | CERTIFICATE_SIGNING_REQUESTS | ApiResource | API resource information for CertificateSigningRequest. | | CLUSTER_ROLE_BINDINGS | ApiResource | API resource information for ClusterRoleBinding. | | CLUSTER_ROLES | ApiResource | API resource information for ClusterRole. | | COMPONENT_STATUSES | ApiResource | API resource information for ComponentStatus. | | CONFIG_MAPS | ApiResource | API resource information for ConfigMap. | | CONTROLLER_REVISIONS | ApiResource | API resource information for ControllerRevision. | | CRON_JOBS | ApiResource | API resource information for CronJob. | | CSI_DRIVERS | ApiResource | API resource information for CSIDriver. | | CSI_NODES | ApiResource | API resource information for CSINode. | | CSI_STORAGE_CAPACITIES | ApiResource | API resource information for CSIStorageCapacity. | | CUSTOM_RESOURCE_DEFINITIONS | ApiResource | API resource information for CustomResourceDefinition. | | DAEMON_SETS | ApiResource | API resource information for DaemonSet. | | DEPLOYMENTS | ApiResource | API resource information for Deployment. | | ENDPOINT_SLICES | ApiResource | API resource information for EndpointSlice. | | ENDPOINTS | ApiResource | API resource information for Endpoints. | | EVENTS | ApiResource | API resource information for Event. | | FLOW_SCHEMAS | ApiResource | API resource information for FlowSchema. | | HORIZONTAL_POD_AUTOSCALERS | ApiResource | API resource information for HorizontalPodAutoscaler. | | INGRESS_CLASSES | ApiResource | API resource information for IngressClass. | | INGRESSES | ApiResource | API resource information for Ingress. | | JOBS | ApiResource | API resource information for Job. | | LEASES | ApiResource | API resource information for Lease. | | LIMIT_RANGES | ApiResource | API resource information for LimitRange. | | LOCAL_SUBJECT_ACCESS_REVIEWS | ApiResource | API resource information for LocalSubjectAccessReview. | | MUTATING_WEBHOOK_CONFIGURATIONS | ApiResource | API resource information for MutatingWebhookConfiguration. | | NAMESPACES | ApiResource | API resource information for Namespace. | | NETWORK_POLICIES | ApiResource | API resource information for NetworkPolicy. | | NODES | ApiResource | API resource information for Node. | | PERSISTENT_VOLUME_CLAIMS | ApiResource | API resource information for PersistentVolumeClaim. | | PERSISTENT_VOLUMES | ApiResource | API resource information for PersistentVolume. | | POD_DISRUPTION_BUDGETS | ApiResource | API resource information for PodDisruptionBudget. | | POD_TEMPLATES | ApiResource | API resource information for PodTemplate. | | PODS | ApiResource | API resource information for Pod. | | PRIORITY_CLASSES | ApiResource | API resource information for PriorityClass. | | PRIORITY_LEVEL_CONFIGURATIONS | ApiResource | API resource information for PriorityLevelConfiguration. | | REPLICA_SETS | ApiResource | API resource information for ReplicaSet. | | REPLICATION_CONTROLLERS | ApiResource | API resource information for ReplicationController. | | RESOURCE_QUOTAS | ApiResource | API resource information for ResourceQuota. | | ROLE_BINDINGS | ApiResource | API resource information for RoleBinding. | | ROLES | ApiResource | API resource information for Role. | | RUNTIME_CLASSES | ApiResource | API resource information for RuntimeClass. | | SECRETS | ApiResource | API resource information for Secret. | | SELF_SUBJECT_ACCESS_REVIEWS | ApiResource | API resource information for SelfSubjectAccessReview. | | SELF_SUBJECT_RULES_REVIEWS | ApiResource | API resource information for SelfSubjectRulesReview. | | SERVICE_ACCOUNTS | ApiResource | API resource information for ServiceAccount. | | SERVICES | ApiResource | API resource information for Service. | | STATEFUL_SETS | ApiResource | API resource information for StatefulSet. | | STORAGE_CLASSES | ApiResource | API resource information for StorageClass. | | SUBJECT_ACCESS_REVIEWS | ApiResource | API resource information for SubjectAccessReview. | | TOKEN_REVIEWS | ApiResource | API resource information for TokenReview. | | VALIDATING_WEBHOOK_CONFIGURATIONS | ApiResource | API resource information for ValidatingWebhookConfiguration. | | VOLUME_ATTACHMENTS | ApiResource | API resource information for VolumeAttachment. | --- ##### `API_SERVICES`^Required ```typescript public readonly API_SERVICES: ApiResource; ``` - *Type:* ApiResource API resource information for APIService. --- ##### `BINDINGS`^Required ```typescript public readonly BINDINGS: ApiResource; ``` - *Type:* ApiResource API resource information for Binding. --- ##### `CERTIFICATE_SIGNING_REQUESTS`^Required ```typescript public readonly CERTIFICATE_SIGNING_REQUESTS: ApiResource; ``` - *Type:* ApiResource API resource information for CertificateSigningRequest. --- ##### `CLUSTER_ROLE_BINDINGS`^Required ```typescript public readonly CLUSTER_ROLE_BINDINGS: ApiResource; ``` - *Type:* ApiResource API resource information for ClusterRoleBinding. --- ##### `CLUSTER_ROLES`^Required ```typescript public readonly CLUSTER_ROLES: ApiResource; ``` - *Type:* ApiResource API resource information for ClusterRole. --- ##### `COMPONENT_STATUSES`^Required ```typescript public readonly COMPONENT_STATUSES: ApiResource; ``` - *Type:* ApiResource API resource information for ComponentStatus. --- ##### `CONFIG_MAPS`^Required ```typescript public readonly CONFIG_MAPS: ApiResource; ``` - *Type:* ApiResource API resource information for ConfigMap. --- ##### `CONTROLLER_REVISIONS`^Required ```typescript public readonly CONTROLLER_REVISIONS: ApiResource; ``` - *Type:* ApiResource API resource information for ControllerRevision. --- ##### `CRON_JOBS`^Required ```typescript public readonly CRON_JOBS: ApiResource; ``` - *Type:* ApiResource API resource information for CronJob. --- ##### `CSI_DRIVERS`^Required ```typescript public readonly CSI_DRIVERS: ApiResource; ``` - *Type:* ApiResource API resource information for CSIDriver. --- ##### `CSI_NODES`^Required ```typescript public readonly CSI_NODES: ApiResource; ``` - *Type:* ApiResource API resource information for CSINode. --- ##### `CSI_STORAGE_CAPACITIES`^Required ```typescript public readonly CSI_STORAGE_CAPACITIES: ApiResource; ``` - *Type:* ApiResource API resource information for CSIStorageCapacity. --- ##### `CUSTOM_RESOURCE_DEFINITIONS`^Required ```typescript public readonly CUSTOM_RESOURCE_DEFINITIONS: ApiResource; ``` - *Type:* ApiResource API resource information for CustomResourceDefinition. --- ##### `DAEMON_SETS`^Required ```typescript public readonly DAEMON_SETS: ApiResource; ``` - *Type:* ApiResource API resource information for DaemonSet. --- ##### `DEPLOYMENTS`^Required ```typescript public readonly DEPLOYMENTS: ApiResource; ``` - *Type:* ApiResource API resource information for Deployment. --- ##### `ENDPOINT_SLICES`^Required ```typescript public readonly ENDPOINT_SLICES: ApiResource; ``` - *Type:* ApiResource API resource information for EndpointSlice. --- ##### `ENDPOINTS`^Required ```typescript public readonly ENDPOINTS: ApiResource; ``` - *Type:* ApiResource API resource information for Endpoints. --- ##### `EVENTS`^Required ```typescript public readonly EVENTS: ApiResource; ``` - *Type:* ApiResource API resource information for Event. --- ##### `FLOW_SCHEMAS`^Required ```typescript public readonly FLOW_SCHEMAS: ApiResource; ``` - *Type:* ApiResource API resource information for FlowSchema. --- ##### `HORIZONTAL_POD_AUTOSCALERS`^Required ```typescript public readonly HORIZONTAL_POD_AUTOSCALERS: ApiResource; ``` - *Type:* ApiResource API resource information for HorizontalPodAutoscaler. --- ##### `INGRESS_CLASSES`^Required ```typescript public readonly INGRESS_CLASSES: ApiResource; ``` - *Type:* ApiResource API resource information for IngressClass. --- ##### `INGRESSES`^Required ```typescript public readonly INGRESSES: ApiResource; ``` - *Type:* ApiResource API resource information for Ingress. --- ##### `JOBS`^Required ```typescript public readonly JOBS: ApiResource; ``` - *Type:* ApiResource API resource information for Job. --- ##### `LEASES`^Required ```typescript public readonly LEASES: ApiResource; ``` - *Type:* ApiResource API resource information for Lease. --- ##### `LIMIT_RANGES`^Required ```typescript public readonly LIMIT_RANGES: ApiResource; ``` - *Type:* ApiResource API resource information for LimitRange. --- ##### `LOCAL_SUBJECT_ACCESS_REVIEWS`^Required ```typescript public readonly LOCAL_SUBJECT_ACCESS_REVIEWS: ApiResource; ``` - *Type:* ApiResource API resource information for LocalSubjectAccessReview. --- ##### `MUTATING_WEBHOOK_CONFIGURATIONS`^Required ```typescript public readonly MUTATING_WEBHOOK_CONFIGURATIONS: ApiResource; ``` - *Type:* ApiResource API resource information for MutatingWebhookConfiguration. --- ##### `NAMESPACES`^Required ```typescript public readonly NAMESPACES: ApiResource; ``` - *Type:* ApiResource API resource information for Namespace. --- ##### `NETWORK_POLICIES`^Required ```typescript public readonly NETWORK_POLICIES: ApiResource; ``` - *Type:* ApiResource API resource information for NetworkPolicy. --- ##### `NODES`^Required ```typescript public readonly NODES: ApiResource; ``` - *Type:* ApiResource API resource information for Node. --- ##### `PERSISTENT_VOLUME_CLAIMS`^Required ```typescript public readonly PERSISTENT_VOLUME_CLAIMS: ApiResource; ``` - *Type:* ApiResource API resource information for PersistentVolumeClaim. --- ##### `PERSISTENT_VOLUMES`^Required ```typescript public readonly PERSISTENT_VOLUMES: ApiResource; ``` - *Type:* ApiResource API resource information for PersistentVolume. --- ##### `POD_DISRUPTION_BUDGETS`^Required ```typescript public readonly POD_DISRUPTION_BUDGETS: ApiResource; ``` - *Type:* ApiResource API resource information for PodDisruptionBudget. --- ##### `POD_TEMPLATES`^Required ```typescript public readonly POD_TEMPLATES: ApiResource; ``` - *Type:* ApiResource API resource information for PodTemplate. --- ##### `PODS`^Required ```typescript public readonly PODS: ApiResource; ``` - *Type:* ApiResource API resource information for Pod. --- ##### `PRIORITY_CLASSES`^Required ```typescript public readonly PRIORITY_CLASSES: ApiResource; ``` - *Type:* ApiResource API resource information for PriorityClass. --- ##### `PRIORITY_LEVEL_CONFIGURATIONS`^Required ```typescript public readonly PRIORITY_LEVEL_CONFIGURATIONS: ApiResource; ``` - *Type:* ApiResource API resource information for PriorityLevelConfiguration. --- ##### `REPLICA_SETS`^Required ```typescript public readonly REPLICA_SETS: ApiResource; ``` - *Type:* ApiResource API resource information for ReplicaSet. --- ##### `REPLICATION_CONTROLLERS`^Required ```typescript public readonly REPLICATION_CONTROLLERS: ApiResource; ``` - *Type:* ApiResource API resource information for ReplicationController. --- ##### `RESOURCE_QUOTAS`^Required ```typescript public readonly RESOURCE_QUOTAS: ApiResource; ``` - *Type:* ApiResource API resource information for ResourceQuota. --- ##### `ROLE_BINDINGS`^Required ```typescript public readonly ROLE_BINDINGS: ApiResource; ``` - *Type:* ApiResource API resource information for RoleBinding. --- ##### `ROLES`^Required ```typescript public readonly ROLES: ApiResource; ``` - *Type:* ApiResource API resource information for Role. --- ##### `RUNTIME_CLASSES`^Required ```typescript public readonly RUNTIME_CLASSES: ApiResource; ``` - *Type:* ApiResource API resource information for RuntimeClass. --- ##### `SECRETS`^Required ```typescript public readonly SECRETS: ApiResource; ``` - *Type:* ApiResource API resource information for Secret. --- ##### `SELF_SUBJECT_ACCESS_REVIEWS`^Required ```typescript public readonly SELF_SUBJECT_ACCESS_REVIEWS: ApiResource; ``` - *Type:* ApiResource API resource information for SelfSubjectAccessReview. --- ##### `SELF_SUBJECT_RULES_REVIEWS`^Required ```typescript public readonly SELF_SUBJECT_RULES_REVIEWS: ApiResource; ``` - *Type:* ApiResource API resource information for SelfSubjectRulesReview. --- ##### `SERVICE_ACCOUNTS`^Required ```typescript public readonly SERVICE_ACCOUNTS: ApiResource; ``` - *Type:* ApiResource API resource information for ServiceAccount. --- ##### `SERVICES`^Required ```typescript public readonly SERVICES: ApiResource; ``` - *Type:* ApiResource API resource information for Service. --- ##### `STATEFUL_SETS`^Required ```typescript public readonly STATEFUL_SETS: ApiResource; ``` - *Type:* ApiResource API resource information for StatefulSet. --- ##### `STORAGE_CLASSES`^Required ```typescript public readonly STORAGE_CLASSES: ApiResource; ``` - *Type:* ApiResource API resource information for StorageClass. --- ##### `SUBJECT_ACCESS_REVIEWS`^Required ```typescript public readonly SUBJECT_ACCESS_REVIEWS: ApiResource; ``` - *Type:* ApiResource API resource information for SubjectAccessReview. --- ##### `TOKEN_REVIEWS`^Required ```typescript public readonly TOKEN_REVIEWS: ApiResource; ``` - *Type:* ApiResource API resource information for TokenReview. --- ##### `VALIDATING_WEBHOOK_CONFIGURATIONS`^Required ```typescript public readonly VALIDATING_WEBHOOK_CONFIGURATIONS: ApiResource; ``` - *Type:* ApiResource API resource information for ValidatingWebhookConfiguration. --- ##### `VOLUME_ATTACHMENTS`^Required ```typescript public readonly VOLUME_ATTACHMENTS: ApiResource; ``` - *Type:* ApiResource API resource information for VolumeAttachment. --- ### Container A single application container that you want to run within a pod. #### Initializers ```typescript import { Container } from 'cdk8s-plus-32' new Container(props: ContainerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ContainerProps | *No description.* | --- ##### `props`^Required - *Type:* ContainerProps --- #### Methods | **Name** | **Description** | | --- | --- | | addPort | Add a port to expose from this container. | | mount | Mount a volume to a specific path so that it is accessible by the container. | --- ##### `addPort` ```typescript public addPort(port: ContainerPort): void ``` Add a port to expose from this container. ###### `port`^Required - *Type:* ContainerPort --- ##### `mount` ```typescript public mount(path: string, storage: IStorage, options?: MountOptions): void ``` Mount a volume to a specific path so that it is accessible by the container. Every pod that is configured to use this container will autmoatically have access to the volume. ###### `path`^Required - *Type:* string The desired path in the container. --- ###### `storage`^Required - *Type:* IStorage The storage to mount. --- ###### `options`^Optional - *Type:* MountOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | env | Env | The environment of the container. | | image | string | The container image. | | imagePullPolicy | ImagePullPolicy | Image pull policy for this container. | | mounts | VolumeMount[] | Volume mounts configured for this container. | | name | string | The name of the container. | | ports | ContainerPort[] | Ports exposed by this containers. | | securityContext | ContainerSecurityContext | The security context of the container. | | args | string[] | Arguments to the entrypoint. | | command | string[] | Entrypoint array (the command to execute when the container starts). | | port | number | *No description.* | | portNumber | number | The port number that was configured for this container. | | resources | ContainerResources | Compute resources (CPU and memory requests and limits) required by the container. | | restartPolicy | ContainerRestartPolicy | The restart policy of the container. | | workingDir | string | The working directory inside the container. | --- ##### `env`^Required ```typescript public readonly env: Env; ``` - *Type:* Env The environment of the container. --- ##### `image`^Required ```typescript public readonly image: string; ``` - *Type:* string The container image. --- ##### `imagePullPolicy`^Required ```typescript public readonly imagePullPolicy: ImagePullPolicy; ``` - *Type:* ImagePullPolicy Image pull policy for this container. --- ##### `mounts`^Required ```typescript public readonly mounts: VolumeMount[]; ``` - *Type:* VolumeMount[] Volume mounts configured for this container. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the container. --- ##### `ports`^Required ```typescript public readonly ports: ContainerPort[]; ``` - *Type:* ContainerPort[] Ports exposed by this containers. Returns a copy, use `addPort` to modify. --- ##### `securityContext`^Required ```typescript public readonly securityContext: ContainerSecurityContext; ``` - *Type:* ContainerSecurityContext The security context of the container. --- ##### `args`^Optional ```typescript public readonly args: string[]; ``` - *Type:* string[] Arguments to the entrypoint. --- ##### `command`^Optional ```typescript public readonly command: string[]; ``` - *Type:* string[] Entrypoint array (the command to execute when the container starts). --- ##### ~~`port`~~^Optional - *Deprecated:* - use `portNumber`. ```typescript public readonly port: number; ``` - *Type:* number --- ##### `portNumber`^Optional ```typescript public readonly portNumber: number; ``` - *Type:* number The port number that was configured for this container. If undefined, either the container doesn't expose a port, or its port configuration is stored in the `ports` field. --- ##### `resources`^Optional ```typescript public readonly resources: ContainerResources; ``` - *Type:* ContainerResources Compute resources (CPU and memory requests and limits) required by the container. > [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) --- ##### `restartPolicy`^Optional ```typescript public readonly restartPolicy: ContainerRestartPolicy; ``` - *Type:* ContainerRestartPolicy The restart policy of the container. --- ##### `workingDir`^Optional ```typescript public readonly workingDir: string; ``` - *Type:* string The working directory inside the container. --- ### ContainerSecurityContext Container security attributes and settings. #### Initializers ```typescript import { ContainerSecurityContext } from 'cdk8s-plus-32' new ContainerSecurityContext(props?: ContainerSecurityContextProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ContainerSecurityContextProps | *No description.* | --- ##### `props`^Optional - *Type:* ContainerSecurityContextProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ensureNonRoot | boolean | *No description.* | | privileged | boolean | *No description.* | | readOnlyRootFilesystem | boolean | *No description.* | | allowPrivilegeEscalation | boolean | *No description.* | | capabilities | ContainerSecutiryContextCapabilities | *No description.* | | group | number | *No description.* | | seccompProfile | SeccompProfile | *No description.* | | user | number | *No description.* | --- ##### `ensureNonRoot`^Required ```typescript public readonly ensureNonRoot: boolean; ``` - *Type:* boolean --- ##### `privileged`^Required ```typescript public readonly privileged: boolean; ``` - *Type:* boolean --- ##### `readOnlyRootFilesystem`^Required ```typescript public readonly readOnlyRootFilesystem: boolean; ``` - *Type:* boolean --- ##### `allowPrivilegeEscalation`^Optional ```typescript public readonly allowPrivilegeEscalation: boolean; ``` - *Type:* boolean --- ##### `capabilities`^Optional ```typescript public readonly capabilities: ContainerSecutiryContextCapabilities; ``` - *Type:* ContainerSecutiryContextCapabilities --- ##### `group`^Optional ```typescript public readonly group: number; ``` - *Type:* number --- ##### `seccompProfile`^Optional ```typescript public readonly seccompProfile: SeccompProfile; ``` - *Type:* SeccompProfile --- ##### `user`^Optional ```typescript public readonly user: number; ``` - *Type:* number --- ### Cpu Represents the amount of CPU. The amount can be passed as millis or units. #### Static Functions | **Name** | **Description** | | --- | --- | | millis | *No description.* | | units | *No description.* | --- ##### `millis` ```typescript import { Cpu } from 'cdk8s-plus-32' Cpu.millis(amount: number) ``` ###### `amount`^Required - *Type:* number --- ##### `units` ```typescript import { Cpu } from 'cdk8s-plus-32' Cpu.units(amount: number) ``` ###### `amount`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | amount | string | *No description.* | --- ##### `amount`^Required ```typescript public readonly amount: string; ``` - *Type:* string --- ### DeploymentStrategy Deployment strategies. #### Static Functions | **Name** | **Description** | | --- | --- | | recreate | All existing Pods are killed before new ones are created. | | rollingUpdate | *No description.* | --- ##### `recreate` ```typescript import { DeploymentStrategy } from 'cdk8s-plus-32' DeploymentStrategy.recreate() ``` All existing Pods are killed before new ones are created. > [https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#recreate-deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#recreate-deployment) ##### `rollingUpdate` ```typescript import { DeploymentStrategy } from 'cdk8s-plus-32' DeploymentStrategy.rollingUpdate(options?: DeploymentStrategyRollingUpdateOptions) ``` ###### `options`^Optional - *Type:* DeploymentStrategyRollingUpdateOptions --- ### Env Container environment variables. #### Initializers ```typescript import { Env } from 'cdk8s-plus-32' new Env(sources: EnvFrom[], variables: {[ key: string ]: EnvValue}) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | sources | EnvFrom[] | *No description.* | | variables | {[ key: string ]: EnvValue} | *No description.* | --- ##### `sources`^Required - *Type:* EnvFrom[] --- ##### `variables`^Required - *Type:* {[ key: string ]: EnvValue} --- #### Methods | **Name** | **Description** | | --- | --- | | addVariable | Add a single variable by name and value. | | copyFrom | Add a collection of variables by copying from another source. | --- ##### `addVariable` ```typescript public addVariable(name: string, value: EnvValue): void ``` Add a single variable by name and value. The variable value can come from various dynamic sources such a secrets of config maps. Use `EnvValue.fromXXX` to select sources. ###### `name`^Required - *Type:* string --- ###### `value`^Required - *Type:* EnvValue --- ##### `copyFrom` ```typescript public copyFrom(from: EnvFrom): void ``` Add a collection of variables by copying from another source. Use `Env.fromXXX` functions to select sources. ###### `from`^Required - *Type:* EnvFrom --- #### Static Functions | **Name** | **Description** | | --- | --- | | fromConfigMap | Selects a ConfigMap to populate the environment variables with. | | fromSecret | Selects a Secret to populate the environment variables with. | --- ##### `fromConfigMap` ```typescript import { Env } from 'cdk8s-plus-32' Env.fromConfigMap(configMap: IConfigMap, prefix?: string) ``` Selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. ###### `configMap`^Required - *Type:* IConfigMap --- ###### `prefix`^Optional - *Type:* string --- ##### `fromSecret` ```typescript import { Env } from 'cdk8s-plus-32' Env.fromSecret(secr: ISecret) ``` Selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables. ###### `secr`^Required - *Type:* ISecret --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | sources | EnvFrom[] | The list of sources used to populate the container environment, in addition to the `variables`. | | variables | {[ key: string ]: EnvValue} | The environment variables for this container. | --- ##### `sources`^Required ```typescript public readonly sources: EnvFrom[]; ``` - *Type:* EnvFrom[] The list of sources used to populate the container environment, in addition to the `variables`. Returns a copy. To add a source use `container.env.copyFrom()`. --- ##### `variables`^Required ```typescript public readonly variables: {[ key: string ]: EnvValue}; ``` - *Type:* {[ key: string ]: EnvValue} The environment variables for this container. Returns a copy. To add environment variables use `container.env.addVariable()`. --- ### EnvFrom A collection of env variables defined in other resources. #### Initializers ```typescript import { EnvFrom } from 'cdk8s-plus-32' new EnvFrom(configMap?: IConfigMap, prefix?: string, sec?: ISecret) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | configMap | IConfigMap | *No description.* | | prefix | string | *No description.* | | sec | ISecret | *No description.* | --- ##### `configMap`^Optional - *Type:* IConfigMap --- ##### `prefix`^Optional - *Type:* string --- ##### `sec`^Optional - *Type:* ISecret --- ### EnvValue Utility class for creating reading env values from various sources. #### Static Functions | **Name** | **Description** | | --- | --- | | fromConfigMap | Create a value by reading a specific key inside a config map. | | fromFieldRef | Create a value from a field reference. | | fromProcess | Create a value from a key in the current process environment. | | fromResource | Create a value from a resource. | | fromSecretValue | Defines an environment value from a secret JSON value. | | fromValue | Create a value from the given argument. | --- ##### `fromConfigMap` ```typescript import { EnvValue } from 'cdk8s-plus-32' EnvValue.fromConfigMap(configMap: IConfigMap, key: string, options?: EnvValueFromConfigMapOptions) ``` Create a value by reading a specific key inside a config map. ###### `configMap`^Required - *Type:* IConfigMap The config map. --- ###### `key`^Required - *Type:* string The key to extract the value from. --- ###### `options`^Optional - *Type:* EnvValueFromConfigMapOptions Additional options. --- ##### `fromFieldRef` ```typescript import { EnvValue } from 'cdk8s-plus-32' EnvValue.fromFieldRef(fieldPath: EnvFieldPaths, options?: EnvValueFromFieldRefOptions) ``` Create a value from a field reference. ###### `fieldPath`^Required - *Type:* EnvFieldPaths : The field reference. --- ###### `options`^Optional - *Type:* EnvValueFromFieldRefOptions : Additional options. --- ##### `fromProcess` ```typescript import { EnvValue } from 'cdk8s-plus-32' EnvValue.fromProcess(key: string, options?: EnvValueFromProcessOptions) ``` Create a value from a key in the current process environment. ###### `key`^Required - *Type:* string The key to read. --- ###### `options`^Optional - *Type:* EnvValueFromProcessOptions Additional options. --- ##### `fromResource` ```typescript import { EnvValue } from 'cdk8s-plus-32' EnvValue.fromResource(resource: ResourceFieldPaths, options?: EnvValueFromResourceOptions) ``` Create a value from a resource. ###### `resource`^Required - *Type:* ResourceFieldPaths : Resource to select the value from. --- ###### `options`^Optional - *Type:* EnvValueFromResourceOptions : Additional options. --- ##### `fromSecretValue` ```typescript import { EnvValue } from 'cdk8s-plus-32' EnvValue.fromSecretValue(secretValue: SecretValue, options?: EnvValueFromSecretOptions) ``` Defines an environment value from a secret JSON value. ###### `secretValue`^Required - *Type:* SecretValue The secret value (secrent + key). --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions Additional options. --- ##### `fromValue` ```typescript import { EnvValue } from 'cdk8s-plus-32' EnvValue.fromValue(value: string) ``` Create a value from the given argument. ###### `value`^Required - *Type:* string The value. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | value | any | *No description.* | | valueFrom | any | *No description.* | --- ##### `value`^Optional ```typescript public readonly value: any; ``` - *Type:* any --- ##### `valueFrom`^Optional ```typescript public readonly valueFrom: any; ``` - *Type:* any --- ### Handler Defines a specific action that should be taken. #### Static Functions | **Name** | **Description** | | --- | --- | | fromCommand | Defines a handler based on a command which is executed within the container. | | fromHttpGet | Defines a handler based on an HTTP GET request to the IP address of the container. | | fromTcpSocket | Defines a handler based opening a connection to a TCP socket on the container. | --- ##### `fromCommand` ```typescript import { Handler } from 'cdk8s-plus-32' Handler.fromCommand(command: string[]) ``` Defines a handler based on a command which is executed within the container. ###### `command`^Required - *Type:* string[] The command to execute. --- ##### `fromHttpGet` ```typescript import { Handler } from 'cdk8s-plus-32' Handler.fromHttpGet(path: string, options?: HandlerFromHttpGetOptions) ``` Defines a handler based on an HTTP GET request to the IP address of the container. ###### `path`^Required - *Type:* string The URL path to hit. --- ###### `options`^Optional - *Type:* HandlerFromHttpGetOptions Options. --- ##### `fromTcpSocket` ```typescript import { Handler } from 'cdk8s-plus-32' Handler.fromTcpSocket(options?: HandlerFromTcpSocketOptions) ``` Defines a handler based opening a connection to a TCP socket on the container. ###### `options`^Optional - *Type:* HandlerFromTcpSocketOptions Options. --- ### IngressBackend The backend for an ingress path. #### Static Functions | **Name** | **Description** | | --- | --- | | fromResource | A Resource backend is an ObjectRef to another Kubernetes resource within the same namespace as the Ingress object. | | fromService | A Kubernetes `Service` to use as the backend for this path. | --- ##### `fromResource` ```typescript import { IngressBackend } from 'cdk8s-plus-32' IngressBackend.fromResource(resource: IResource) ``` A Resource backend is an ObjectRef to another Kubernetes resource within the same namespace as the Ingress object. A common usage for a Resource backend is to ingress data to an object storage backend with static assets. ###### `resource`^Required - *Type:* IResource --- ##### `fromService` ```typescript import { IngressBackend } from 'cdk8s-plus-32' IngressBackend.fromService(serv: Service, options?: ServiceIngressBackendOptions) ``` A Kubernetes `Service` to use as the backend for this path. ###### `serv`^Required - *Type:* Service The service object. --- ###### `options`^Optional - *Type:* ServiceIngressBackendOptions --- ### IntOrString #### Static Functions | **Name** | **Description** | | --- | --- | | fromNumber | *No description.* | | fromString | *No description.* | --- ##### `fromNumber` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.IntOrString.fromNumber(value: number) ``` ###### `value`^Required - *Type:* number --- ##### `fromString` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.IntOrString.fromString(value: string) ``` ###### `value`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | value | string \| number | *No description.* | --- ##### `value`^Required ```typescript public readonly value: string | number; ``` - *Type:* string | number --- ### LabeledNode A node that is matched by label selectors. #### Initializers ```typescript import { LabeledNode } from 'cdk8s-plus-32' new LabeledNode(labelSelector: NodeLabelQuery[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | labelSelector | NodeLabelQuery[] | *No description.* | --- ##### `labelSelector`^Required - *Type:* NodeLabelQuery[] --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | labelSelector | NodeLabelQuery[] | *No description.* | --- ##### `labelSelector`^Required ```typescript public readonly labelSelector: NodeLabelQuery[]; ``` - *Type:* NodeLabelQuery[] --- ### LabelExpression Represents a query that can be performed against resources with labels. #### Static Functions | **Name** | **Description** | | --- | --- | | doesNotExist | Requires label `key` to not exist. | | exists | Requires label `key` to exist. | | in | Requires value of label `key` to be one of `values`. | | notIn | Requires value of label `key` to be none of `values`. | --- ##### `doesNotExist` ```typescript import { LabelExpression } from 'cdk8s-plus-32' LabelExpression.doesNotExist(key: string) ``` Requires label `key` to not exist. ###### `key`^Required - *Type:* string --- ##### `exists` ```typescript import { LabelExpression } from 'cdk8s-plus-32' LabelExpression.exists(key: string) ``` Requires label `key` to exist. ###### `key`^Required - *Type:* string --- ##### `in` ```typescript import { LabelExpression } from 'cdk8s-plus-32' LabelExpression.in(key: string, values: string[]) ``` Requires value of label `key` to be one of `values`. ###### `key`^Required - *Type:* string --- ###### `values`^Required - *Type:* string[] --- ##### `notIn` ```typescript import { LabelExpression } from 'cdk8s-plus-32' LabelExpression.notIn(key: string, values: string[]) ``` Requires value of label `key` to be none of `values`. ###### `key`^Required - *Type:* string --- ###### `values`^Required - *Type:* string[] --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | *No description.* | | operator | string | *No description.* | | values | string[] | *No description.* | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string --- ##### `operator`^Required ```typescript public readonly operator: string; ``` - *Type:* string --- ##### `values`^Optional ```typescript public readonly values: string[]; ``` - *Type:* string[] --- ### LabelSelector Match a resource by labels. #### Methods | **Name** | **Description** | | --- | --- | | isEmpty | *No description.* | --- ##### `isEmpty` ```typescript public isEmpty(): boolean ``` #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { LabelSelector } from 'cdk8s-plus-32' LabelSelector.of(options?: LabelSelectorOptions) ``` ###### `options`^Optional - *Type:* LabelSelectorOptions --- ### Metric A metric condition that HorizontalPodAutoscaler's scale on. #### Static Functions | **Name** | **Description** | | --- | --- | | containerCpu | Metric that tracks the CPU of a container. | | containerEphemeralStorage | Metric that tracks the local ephemeral storage of a container. | | containerMemory | Metric that tracks the Memory of a container. | | containerStorage | Metric that tracks the volume size of a container. | | external | A global metric that is not associated with any Kubernetes object. | | object | Metric that describes a metric of a kubernetes object. | | pods | A pod metric that will be averaged across all pods of the current scale target. | | resourceCpu | Tracks the available CPU of the pods in a target. | | resourceEphemeralStorage | Tracks the available Ephemeral Storage of the pods in a target. | | resourceMemory | Tracks the available Memory of the pods in a target. | | resourceStorage | Tracks the available Storage of the pods in a target. | --- ##### `containerCpu` ```typescript import { Metric } from 'cdk8s-plus-32' Metric.containerCpu(options: MetricContainerResourceOptions) ``` Metric that tracks the CPU of a container. This metric will be tracked across all pods of the current scale target. ###### `options`^Required - *Type:* MetricContainerResourceOptions --- ##### `containerEphemeralStorage` ```typescript import { Metric } from 'cdk8s-plus-32' Metric.containerEphemeralStorage(options: MetricContainerResourceOptions) ``` Metric that tracks the local ephemeral storage of a container. This metric will be tracked across all pods of the current scale target. ###### `options`^Required - *Type:* MetricContainerResourceOptions --- ##### `containerMemory` ```typescript import { Metric } from 'cdk8s-plus-32' Metric.containerMemory(options: MetricContainerResourceOptions) ``` Metric that tracks the Memory of a container. This metric will be tracked across all pods of the current scale target. ###### `options`^Required - *Type:* MetricContainerResourceOptions --- ##### `containerStorage` ```typescript import { Metric } from 'cdk8s-plus-32' Metric.containerStorage(options: MetricContainerResourceOptions) ``` Metric that tracks the volume size of a container. This metric will be tracked across all pods of the current scale target. ###### `options`^Required - *Type:* MetricContainerResourceOptions --- ##### `external` ```typescript import { Metric } from 'cdk8s-plus-32' Metric.external(options: MetricOptions) ``` A global metric that is not associated with any Kubernetes object. Allows for autoscaling based on information coming from components running outside of the cluster. Use case: * Scale up when the length of an SQS queue is greater than 10 messages. * Scale down when an outside load balancer's queries are less than 10000 per second. ###### `options`^Required - *Type:* MetricOptions --- ##### `object` ```typescript import { Metric } from 'cdk8s-plus-32' Metric.object(options: MetricObjectOptions) ``` Metric that describes a metric of a kubernetes object. Use case: * Scale on a Kubernetes Ingress's hits-per-second metric. ###### `options`^Required - *Type:* MetricObjectOptions --- ##### `pods` ```typescript import { Metric } from 'cdk8s-plus-32' Metric.pods(options: MetricOptions) ``` A pod metric that will be averaged across all pods of the current scale target. Use case: * Average CPU utilization across all pods * Transactions processed per second across all pods ###### `options`^Required - *Type:* MetricOptions --- ##### `resourceCpu` ```typescript import { Metric } from 'cdk8s-plus-32' Metric.resourceCpu(target: MetricTarget) ``` Tracks the available CPU of the pods in a target. Note: Since the resource usages of all the containers are summed up the total pod utilization may not accurately represent the individual container resource usage. This could lead to situations where a single container might be running with high usage and the HPA will not scale out because the overall pod usage is still within acceptable limits. Use case: * Scale up when CPU is above 40%. ###### `target`^Required - *Type:* MetricTarget --- ##### `resourceEphemeralStorage` ```typescript import { Metric } from 'cdk8s-plus-32' Metric.resourceEphemeralStorage(target: MetricTarget) ``` Tracks the available Ephemeral Storage of the pods in a target. Note: Since the resource usages of all the containers are summed up the total pod utilization may not accurately represent the individual container resource usage. This could lead to situations where a single container might be running with high usage and the HPA will not scale out because the overall pod usage is still within acceptable limits. ###### `target`^Required - *Type:* MetricTarget --- ##### `resourceMemory` ```typescript import { Metric } from 'cdk8s-plus-32' Metric.resourceMemory(target: MetricTarget) ``` Tracks the available Memory of the pods in a target. Note: Since the resource usages of all the containers are summed up the total pod utilization may not accurately represent the individual container resource usage. This could lead to situations where a single container might be running with high usage and the HPA will not scale out because the overall pod usage is still within acceptable limits. Use case: * Scale up when Memory is above 512MB. ###### `target`^Required - *Type:* MetricTarget --- ##### `resourceStorage` ```typescript import { Metric } from 'cdk8s-plus-32' Metric.resourceStorage(target: MetricTarget) ``` Tracks the available Storage of the pods in a target. Note: Since the resource usages of all the containers are summed up the total pod utilization may not accurately represent the individual container resource usage. This could lead to situations where a single container might be running with high usage and the HPA will not scale out because the overall pod usage is still within acceptable limits. ###### `target`^Required - *Type:* MetricTarget --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | *No description.* | --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string --- ### MetricTarget A metric condition that will trigger scaling behavior when satisfied. *Example* ```typescript MetricTarget.averageUtilization(70); // 70% average utilization ``` #### Static Functions | **Name** | **Description** | | --- | --- | | averageUtilization | Target a percentage value across all relevant pods. | | averageValue | Target the average value across all relevant pods. | | value | Target a specific target value. | --- ##### `averageUtilization` ```typescript import { MetricTarget } from 'cdk8s-plus-32' MetricTarget.averageUtilization(averageUtilization: number) ``` Target a percentage value across all relevant pods. ###### `averageUtilization`^Required - *Type:* number The percentage of the utilization metric. e.g. `50` for 50%. --- ##### `averageValue` ```typescript import { MetricTarget } from 'cdk8s-plus-32' MetricTarget.averageValue(averageValue: number) ``` Target the average value across all relevant pods. ###### `averageValue`^Required - *Type:* number The average metric value. --- ##### `value` ```typescript import { MetricTarget } from 'cdk8s-plus-32' MetricTarget.value(value: number) ``` Target a specific target value. ###### `value`^Required - *Type:* number The target value. --- ### NamedNode A node that is matched by its name. #### Initializers ```typescript import { NamedNode } from 'cdk8s-plus-32' new NamedNode(name: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | *No description.* | --- ##### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | *No description.* | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ### NetworkPolicyPort Describes a port to allow traffic on. #### Static Functions | **Name** | **Description** | | --- | --- | | allTcp | Any TCP traffic. | | allUdp | Any UDP traffic. | | of | Custom port configuration. | | tcp | Distinct TCP ports. | | tcpRange | A TCP port range. | | udp | Distinct UDP ports. | | udpRange | A UDP port range. | --- ##### `allTcp` ```typescript import { NetworkPolicyPort } from 'cdk8s-plus-32' NetworkPolicyPort.allTcp() ``` Any TCP traffic. ##### `allUdp` ```typescript import { NetworkPolicyPort } from 'cdk8s-plus-32' NetworkPolicyPort.allUdp() ``` Any UDP traffic. ##### `of` ```typescript import { NetworkPolicyPort } from 'cdk8s-plus-32' NetworkPolicyPort.of(props: NetworkPolicyPortProps) ``` Custom port configuration. ###### `props`^Required - *Type:* NetworkPolicyPortProps --- ##### `tcp` ```typescript import { NetworkPolicyPort } from 'cdk8s-plus-32' NetworkPolicyPort.tcp(port: number) ``` Distinct TCP ports. ###### `port`^Required - *Type:* number --- ##### `tcpRange` ```typescript import { NetworkPolicyPort } from 'cdk8s-plus-32' NetworkPolicyPort.tcpRange(startPort: number, endPort: number) ``` A TCP port range. ###### `startPort`^Required - *Type:* number --- ###### `endPort`^Required - *Type:* number --- ##### `udp` ```typescript import { NetworkPolicyPort } from 'cdk8s-plus-32' NetworkPolicyPort.udp(port: number) ``` Distinct UDP ports. ###### `port`^Required - *Type:* number --- ##### `udpRange` ```typescript import { NetworkPolicyPort } from 'cdk8s-plus-32' NetworkPolicyPort.udpRange(startPort: number, endPort: number) ``` A UDP port range. ###### `startPort`^Required - *Type:* number --- ###### `endPort`^Required - *Type:* number --- ### Node Represents a node in the cluster. #### Initializers ```typescript import { Node } from 'cdk8s-plus-32' new Node() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | labeled | Match a node by its labels. | | named | Match a node by its name. | | tainted | Match a node by its taints. | --- ##### `labeled` ```typescript import { Node } from 'cdk8s-plus-32' Node.labeled(labelSelector: ...NodeLabelQuery[]) ``` Match a node by its labels. ###### `labelSelector`^Required - *Type:* ...NodeLabelQuery[] --- ##### `named` ```typescript import { Node } from 'cdk8s-plus-32' Node.named(nodeName: string) ``` Match a node by its name. ###### `nodeName`^Required - *Type:* string --- ##### `tainted` ```typescript import { Node } from 'cdk8s-plus-32' Node.tainted(taintSelector: ...NodeTaintQuery[]) ``` Match a node by its taints. ###### `taintSelector`^Required - *Type:* ...NodeTaintQuery[] --- ### NodeLabelQuery Represents a query that can be performed against nodes with labels. #### Static Functions | **Name** | **Description** | | --- | --- | | doesNotExist | Requires label `key` to not exist. | | exists | Requires label `key` to exist. | | gt | Requires value of label `key` to greater than all elements in `values`. | | in | Requires value of label `key` to be one of `values`. | | is | Requires value of label `key` to equal `value`. | | lt | Requires value of label `key` to less than all elements in `values`. | | notIn | Requires value of label `key` to be none of `values`. | --- ##### `doesNotExist` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-32' NodeLabelQuery.doesNotExist(key: string) ``` Requires label `key` to not exist. ###### `key`^Required - *Type:* string --- ##### `exists` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-32' NodeLabelQuery.exists(key: string) ``` Requires label `key` to exist. ###### `key`^Required - *Type:* string --- ##### `gt` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-32' NodeLabelQuery.gt(key: string, values: string[]) ``` Requires value of label `key` to greater than all elements in `values`. ###### `key`^Required - *Type:* string --- ###### `values`^Required - *Type:* string[] --- ##### `in` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-32' NodeLabelQuery.in(key: string, values: string[]) ``` Requires value of label `key` to be one of `values`. ###### `key`^Required - *Type:* string --- ###### `values`^Required - *Type:* string[] --- ##### `is` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-32' NodeLabelQuery.is(key: string, value: string) ``` Requires value of label `key` to equal `value`. ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* string --- ##### `lt` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-32' NodeLabelQuery.lt(key: string, values: string[]) ``` Requires value of label `key` to less than all elements in `values`. ###### `key`^Required - *Type:* string --- ###### `values`^Required - *Type:* string[] --- ##### `notIn` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-32' NodeLabelQuery.notIn(key: string, values: string[]) ``` Requires value of label `key` to be none of `values`. ###### `key`^Required - *Type:* string --- ###### `values`^Required - *Type:* string[] --- ### NodeTaintQuery Taint queries that can be perfomed against nodes. #### Static Functions | **Name** | **Description** | | --- | --- | | any | Matches any taint. | | exists | Matches a tain with any value of a specific key. | | is | Matches a taint with a specific key and value. | --- ##### `any` ```typescript import { NodeTaintQuery } from 'cdk8s-plus-32' NodeTaintQuery.any() ``` Matches any taint. ##### `exists` ```typescript import { NodeTaintQuery } from 'cdk8s-plus-32' NodeTaintQuery.exists(key: string, options?: NodeTaintQueryOptions) ``` Matches a tain with any value of a specific key. ###### `key`^Required - *Type:* string --- ###### `options`^Optional - *Type:* NodeTaintQueryOptions --- ##### `is` ```typescript import { NodeTaintQuery } from 'cdk8s-plus-32' NodeTaintQuery.is(key: string, value: string, options?: NodeTaintQueryOptions) ``` Matches a taint with a specific key and value. ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* string --- ###### `options`^Optional - *Type:* NodeTaintQueryOptions --- ### NonApiResource - *Implements:* IApiEndpoint Factory for creating non api resources. #### Methods | **Name** | **Description** | | --- | --- | | asApiResource | Return the IApiResource this object represents. | | asNonApiResource | Return the non resource url this object represents. | --- ##### `asApiResource` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { NonApiResource } from 'cdk8s-plus-32' NonApiResource.of(url: string) ``` ###### `url`^Required - *Type:* string --- ### PercentOrAbsolute Union like class repsenting either a ration in percents or an absolute number. #### Methods | **Name** | **Description** | | --- | --- | | isZero | *No description.* | --- ##### `isZero` ```typescript public isZero(): boolean ``` #### Static Functions | **Name** | **Description** | | --- | --- | | absolute | Absolute number. | | percent | Percent ratio. | --- ##### `absolute` ```typescript import { PercentOrAbsolute } from 'cdk8s-plus-32' PercentOrAbsolute.absolute(num: number) ``` Absolute number. ###### `num`^Required - *Type:* number --- ##### `percent` ```typescript import { PercentOrAbsolute } from 'cdk8s-plus-32' PercentOrAbsolute.percent(percent: number) ``` Percent ratio. ###### `percent`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | value | any | *No description.* | --- ##### `value`^Required ```typescript public readonly value: any; ``` - *Type:* any --- ### PodConnections Controls network isolation rules for inter-pod communication. #### Initializers ```typescript import { PodConnections } from 'cdk8s-plus-32' new PodConnections(instance: AbstractPod) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | instance | AbstractPod | *No description.* | --- ##### `instance`^Required - *Type:* AbstractPod --- #### Methods | **Name** | **Description** | | --- | --- | | allowFrom | Allow network traffic from the peer to this pod. | | allowTo | Allow network traffic from this pod to the peer. | | isolate | Sets the default network policy for Pod/Workload to have all egress and ingress connections as disabled. | --- ##### `allowFrom` ```typescript public allowFrom(peer: INetworkPolicyPeer, options?: PodConnectionsAllowFromOptions): void ``` Allow network traffic from the peer to this pod. By default, this will create an ingress network policy for this pod, and an egress network policy for the peer. This is required if both sides are already isolated. Use `options.isolation` to control this behavior. *Example* ```typescript // create only an egress policy that selects the 'web' pod to allow outgoing traffic // to the 'redis' pod. this requires the 'redis' pod to not be isolated for ingress. redis.connections.allowFrom(web, { isolation: Isolation.PEER }) // create only an ingress policy that selects the 'redis' peer to allow incoming traffic // from the 'web' pod. this requires the 'web' pod to not be isolated for egress. redis.connections.allowFrom(web, { isolation: Isolation.POD }) ``` ###### `peer`^Required - *Type:* INetworkPolicyPeer --- ###### `options`^Optional - *Type:* PodConnectionsAllowFromOptions --- ##### `allowTo` ```typescript public allowTo(peer: INetworkPolicyPeer, options?: PodConnectionsAllowToOptions): void ``` Allow network traffic from this pod to the peer. By default, this will create an egress network policy for this pod, and an ingress network policy for the peer. This is required if both sides are already isolated. Use `options.isolation` to control this behavior. *Example* ```typescript // create only an egress policy that selects the 'web' pod to allow outgoing traffic // to the 'redis' pod. this requires the 'redis' pod to not be isolated for ingress. web.connections.allowTo(redis, { isolation: Isolation.POD }) // create only an ingress policy that selects the 'redis' peer to allow incoming traffic // from the 'web' pod. this requires the 'web' pod to not be isolated for egress. web.connections.allowTo(redis, { isolation: Isolation.PEER }) ``` ###### `peer`^Required - *Type:* INetworkPolicyPeer --- ###### `options`^Optional - *Type:* PodConnectionsAllowToOptions --- ##### `isolate` ```typescript public isolate(): void ``` Sets the default network policy for Pod/Workload to have all egress and ingress connections as disabled. ### PodDns Holds dns settings of the pod. #### Initializers ```typescript import { PodDns } from 'cdk8s-plus-32' new PodDns(props?: PodDnsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | PodDnsProps | *No description.* | --- ##### `props`^Optional - *Type:* PodDnsProps --- #### Methods | **Name** | **Description** | | --- | --- | | addNameserver | Add a nameserver. | | addOption | Add a custom option. | | addSearch | Add a search domain. | --- ##### `addNameserver` ```typescript public addNameserver(nameservers: ...string[]): void ``` Add a nameserver. ###### `nameservers`^Required - *Type:* ...string[] --- ##### `addOption` ```typescript public addOption(options: ...DnsOption[]): void ``` Add a custom option. ###### `options`^Required - *Type:* ...DnsOption[] --- ##### `addSearch` ```typescript public addSearch(searches: ...string[]): void ``` Add a search domain. ###### `searches`^Required - *Type:* ...string[] --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | hostnameAsFQDN | boolean | Whether or not the pods hostname is set to its FQDN. | | nameservers | string[] | Nameservers defined for this pod. | | options | DnsOption[] | Custom dns options defined for this pod. | | policy | DnsPolicy | The DNS policy of this pod. | | searches | string[] | Search domains defined for this pod. | | hostname | string | The configured hostname of the pod. | | subdomain | string | The configured subdomain of the pod. | --- ##### `hostnameAsFQDN`^Required ```typescript public readonly hostnameAsFQDN: boolean; ``` - *Type:* boolean Whether or not the pods hostname is set to its FQDN. --- ##### `nameservers`^Required ```typescript public readonly nameservers: string[]; ``` - *Type:* string[] Nameservers defined for this pod. --- ##### `options`^Required ```typescript public readonly options: DnsOption[]; ``` - *Type:* DnsOption[] Custom dns options defined for this pod. --- ##### `policy`^Required ```typescript public readonly policy: DnsPolicy; ``` - *Type:* DnsPolicy The DNS policy of this pod. --- ##### `searches`^Required ```typescript public readonly searches: string[]; ``` - *Type:* string[] Search domains defined for this pod. --- ##### `hostname`^Optional ```typescript public readonly hostname: string; ``` - *Type:* string The configured hostname of the pod. Undefined means its set to a system-defined value. --- ##### `subdomain`^Optional ```typescript public readonly subdomain: string; ``` - *Type:* string The configured subdomain of the pod. --- ### PodScheduling Controls the pod scheduling strategy. #### Initializers ```typescript import { PodScheduling } from 'cdk8s-plus-32' new PodScheduling(instance: AbstractPod) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | instance | AbstractPod | *No description.* | --- ##### `instance`^Required - *Type:* AbstractPod --- #### Methods | **Name** | **Description** | | --- | --- | | assign | Assign this pod a specific node by name. | | attract | Attract this pod to a node matched by selectors. You can select a node by using `Node.labeled()`. | | colocate | Co-locate this pod with a scheduling selection. | | separate | Seperate this pod from a scheduling selection. | | tolerate | Allow this pod to tolerate taints matching these tolerations. | --- ##### `assign` ```typescript public assign(node: NamedNode): void ``` Assign this pod a specific node by name. The scheduler ignores the Pod, and the kubelet on the named node tries to place the Pod on that node. Overrules any affinity rules of the pod. Some limitations of static assignment are: - If the named node does not exist, the Pod will not run, and in some cases may be automatically deleted. - If the named node does not have the resources to accommodate the Pod, the Pod will fail and its reason will indicate why, for example OutOfmemory or OutOfcpu. - Node names in cloud environments are not always predictable or stable. Will throw is the pod is already assigned to named node. Under the hood, this method utilizes the `nodeName` property. ###### `node`^Required - *Type:* NamedNode --- ##### `attract` ```typescript public attract(node: LabeledNode, options?: PodSchedulingAttractOptions): void ``` Attract this pod to a node matched by selectors. You can select a node by using `Node.labeled()`. Attracting to multiple nodes (i.e invoking this method multiple times) acts as an OR condition, meaning the pod will be assigned to either one of the nodes. Under the hood, this method utilizes the `nodeAffinity` property. > [https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity) ###### `node`^Required - *Type:* LabeledNode --- ###### `options`^Optional - *Type:* PodSchedulingAttractOptions --- ##### `colocate` ```typescript public colocate(selector: IPodSelector, options?: PodSchedulingColocateOptions): void ``` Co-locate this pod with a scheduling selection. A selection can be one of: - An instance of a `Pod`. - An instance of a `Workload` (e.g `Deployment`, `StatefulSet`). - An un-managed pod that can be selected via `Pods.select()`. Co-locating with multiple selections ((i.e invoking this method multiple times)) acts as an AND condition. meaning the pod will be assigned to a node that satisfies all selections (i.e runs at least one pod that satisifies each selection). Under the hood, this method utilizes the `podAffinity` property. > [https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity) ###### `selector`^Required - *Type:* IPodSelector --- ###### `options`^Optional - *Type:* PodSchedulingColocateOptions --- ##### `separate` ```typescript public separate(selector: IPodSelector, options?: PodSchedulingSeparateOptions): void ``` Seperate this pod from a scheduling selection. A selection can be one of: - An instance of a `Pod`. - An instance of a `Workload` (e.g `Deployment`, `StatefulSet`). - An un-managed pod that can be selected via `Pods.select()`. Seperating from multiple selections acts as an AND condition. meaning the pod will not be assigned to a node that satisfies all selections (i.e runs at least one pod that satisifies each selection). Under the hood, this method utilizes the `podAntiAffinity` property. > [https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity) ###### `selector`^Required - *Type:* IPodSelector --- ###### `options`^Optional - *Type:* PodSchedulingSeparateOptions --- ##### `tolerate` ```typescript public tolerate(node: TaintedNode): void ``` Allow this pod to tolerate taints matching these tolerations. You can put multiple taints on the same node and multiple tolerations on the same pod. The way Kubernetes processes multiple taints and tolerations is like a filter: start with all of a node's taints, then ignore the ones for which the pod has a matching toleration; the remaining un-ignored taints have the indicated effects on the pod. In particular: - if there is at least one un-ignored taint with effect NoSchedule then Kubernetes will not schedule the pod onto that node - if there is no un-ignored taint with effect NoSchedule but there is at least one un-ignored taint with effect PreferNoSchedule then Kubernetes will try to not schedule the pod onto the node - if there is at least one un-ignored taint with effect NoExecute then the pod will be evicted from the node (if it is already running on the node), and will not be scheduled onto the node (if it is not yet running on the node). Under the hood, this method utilizes the `tolerations` property. > [https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) ###### `node`^Required - *Type:* TaintedNode --- ### PodSecurityContext Holds pod-level security attributes and common container settings. #### Initializers ```typescript import { PodSecurityContext } from 'cdk8s-plus-32' new PodSecurityContext(props?: PodSecurityContextProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | PodSecurityContextProps | *No description.* | --- ##### `props`^Optional - *Type:* PodSecurityContextProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ensureNonRoot | boolean | *No description.* | | fsGroupChangePolicy | FsGroupChangePolicy | *No description.* | | sysctls | Sysctl[] | *No description.* | | fsGroup | number | *No description.* | | group | number | *No description.* | | user | number | *No description.* | --- ##### `ensureNonRoot`^Required ```typescript public readonly ensureNonRoot: boolean; ``` - *Type:* boolean --- ##### `fsGroupChangePolicy`^Required ```typescript public readonly fsGroupChangePolicy: FsGroupChangePolicy; ``` - *Type:* FsGroupChangePolicy --- ##### `sysctls`^Required ```typescript public readonly sysctls: Sysctl[]; ``` - *Type:* Sysctl[] --- ##### `fsGroup`^Optional ```typescript public readonly fsGroup: number; ``` - *Type:* number --- ##### `group`^Optional ```typescript public readonly group: number; ``` - *Type:* number --- ##### `user`^Optional ```typescript public readonly user: number; ``` - *Type:* number --- ### Probe Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. #### Static Functions | **Name** | **Description** | | --- | --- | | fromCommand | Defines a probe based on a command which is executed within the container. | | fromGrpc | Defines a probe based on a gRPC request to the container. | | fromHttpGet | Defines a probe based on an HTTP GET request to the IP address of the container. | | fromTcpSocket | Defines a probe based opening a connection to a TCP socket on the container. | --- ##### `fromCommand` ```typescript import { Probe } from 'cdk8s-plus-32' Probe.fromCommand(command: string[], options?: CommandProbeOptions) ``` Defines a probe based on a command which is executed within the container. ###### `command`^Required - *Type:* string[] The command to execute. --- ###### `options`^Optional - *Type:* CommandProbeOptions Options. --- ##### `fromGrpc` ```typescript import { Probe } from 'cdk8s-plus-32' Probe.fromGrpc(options?: GrpcProbeOptions) ``` Defines a probe based on a gRPC request to the container. ###### `options`^Optional - *Type:* GrpcProbeOptions Options. --- ##### `fromHttpGet` ```typescript import { Probe } from 'cdk8s-plus-32' Probe.fromHttpGet(path: string, options?: HttpGetProbeOptions) ``` Defines a probe based on an HTTP GET request to the IP address of the container. ###### `path`^Required - *Type:* string The URL path to hit. --- ###### `options`^Optional - *Type:* HttpGetProbeOptions Options. --- ##### `fromTcpSocket` ```typescript import { Probe } from 'cdk8s-plus-32' Probe.fromTcpSocket(options?: TcpSocketProbeOptions) ``` Defines a probe based opening a connection to a TCP socket on the container. ###### `options`^Optional - *Type:* TcpSocketProbeOptions Options. --- ### Quantity #### Static Functions | **Name** | **Description** | | --- | --- | | fromNumber | *No description.* | | fromString | *No description.* | --- ##### `fromNumber` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.Quantity.fromNumber(value: number) ``` ###### `value`^Required - *Type:* number --- ##### `fromString` ```typescript import { k8s } from 'cdk8s-plus-32' k8s.Quantity.fromString(value: string) ``` ###### `value`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | value | string \| number | *No description.* | --- ##### `value`^Required ```typescript public readonly value: string | number; ``` - *Type:* string | number --- ### Replicas The amount of replicas that will change. #### Static Functions | **Name** | **Description** | | --- | --- | | absolute | Changes the pods by a percentage of the it's current value. | | percent | Changes the pods by a percentage of the it's current value. | --- ##### `absolute` ```typescript import { Replicas } from 'cdk8s-plus-32' Replicas.absolute(value: number) ``` Changes the pods by a percentage of the it's current value. ###### `value`^Required - *Type:* number The amount of change to apply. Must be greater than 0. --- ##### `percent` ```typescript import { Replicas } from 'cdk8s-plus-32' Replicas.percent(value: number) ``` Changes the pods by a percentage of the it's current value. ###### `value`^Required - *Type:* number The percentage of change to apply. Must be greater than 0. --- ### ResourcePermissions Controls permissions for operations on resources. #### Initializers ```typescript import { ResourcePermissions } from 'cdk8s-plus-32' new ResourcePermissions(instance: Resource) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | instance | Resource | *No description.* | --- ##### `instance`^Required - *Type:* Resource --- #### Methods | **Name** | **Description** | | --- | --- | | grantRead | Grants the list of subjects permissions to read this resource. | | grantReadWrite | Grants the list of subjects permissions to read and write this resource. | --- ##### `grantRead` ```typescript public grantRead(subjects: ...ISubject[]): RoleBinding ``` Grants the list of subjects permissions to read this resource. ###### `subjects`^Required - *Type:* ...ISubject[] --- ##### `grantReadWrite` ```typescript public grantReadWrite(subjects: ...ISubject[]): RoleBinding ``` Grants the list of subjects permissions to read and write this resource. ###### `subjects`^Required - *Type:* ...ISubject[] --- ### StatefulSetUpdateStrategy StatefulSet update strategies. #### Static Functions | **Name** | **Description** | | --- | --- | | onDelete | The controller will not automatically update the Pods in a StatefulSet. | | rollingUpdate | The controller will delete and recreate each Pod in the StatefulSet. | --- ##### `onDelete` ```typescript import { StatefulSetUpdateStrategy } from 'cdk8s-plus-32' StatefulSetUpdateStrategy.onDelete() ``` The controller will not automatically update the Pods in a StatefulSet. Users must manually delete Pods to cause the controller to create new Pods that reflect modifications. ##### `rollingUpdate` ```typescript import { StatefulSetUpdateStrategy } from 'cdk8s-plus-32' StatefulSetUpdateStrategy.rollingUpdate(options?: StatefulSetUpdateStrategyRollingUpdateOptions) ``` The controller will delete and recreate each Pod in the StatefulSet. It will proceed in the same order as Pod termination (from the largest ordinal to the smallest), updating each Pod one at a time. The Kubernetes control plane waits until an updated Pod is Running and Ready prior to updating its predecessor. ###### `options`^Optional - *Type:* StatefulSetUpdateStrategyRollingUpdateOptions --- ### TaintedNode A node that is matched by taint selectors. #### Initializers ```typescript import { TaintedNode } from 'cdk8s-plus-32' new TaintedNode(taintSelector: NodeTaintQuery[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | taintSelector | NodeTaintQuery[] | *No description.* | --- ##### `taintSelector`^Required - *Type:* NodeTaintQuery[] --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | taintSelector | NodeTaintQuery[] | *No description.* | --- ##### `taintSelector`^Required ```typescript public readonly taintSelector: NodeTaintQuery[]; ``` - *Type:* NodeTaintQuery[] --- ### Topology Available topology domains. #### Static Functions | **Name** | **Description** | | --- | --- | | custom | Custom key for the node label that the system uses to denote the topology domain. | --- ##### `custom` ```typescript import { Topology } from 'cdk8s-plus-32' Topology.custom(key: string) ``` Custom key for the node label that the system uses to denote the topology domain. ###### `key`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string | *No description.* | --- ##### `key`^Required ```typescript public readonly key: string; ``` - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | HOSTNAME | Topology | A hostname represents a single node in the cluster. | | REGION | Topology | A region represents a larger domain, made up of one or more zones. | | ZONE | Topology | A zone represents a logical failure domain. | --- ##### `HOSTNAME`^Required ```typescript public readonly HOSTNAME: Topology; ``` - *Type:* Topology A hostname represents a single node in the cluster. > [https://kubernetes.io/docs/reference/labels-annotations-taints/#kubernetesiohostname](https://kubernetes.io/docs/reference/labels-annotations-taints/#kubernetesiohostname) --- ##### `REGION`^Required ```typescript public readonly REGION: Topology; ``` - *Type:* Topology A region represents a larger domain, made up of one or more zones. It is uncommon for Kubernetes clusters to span multiple regions. While the exact definition of a zone or region is left to infrastructure implementations, common properties of a region include higher network latency between them than within them, non-zero cost for network traffic between them, and failure independence from other zones or regions. For example, nodes within a region might share power infrastructure (e.g. a UPS or generator), but nodes in different regions typically would not. > [https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesioregion](https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesioregion) --- ##### `ZONE`^Required ```typescript public readonly ZONE: Topology; ``` - *Type:* Topology A zone represents a logical failure domain. It is common for Kubernetes clusters to span multiple zones for increased availability. While the exact definition of a zone is left to infrastructure implementations, common properties of a zone include very low network latency within a zone, no-cost network traffic within a zone, and failure independence from other zones. For example, nodes within a zone might share a network switch, but nodes in different zones should not. > [https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone](https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone) --- ### WorkloadScheduling Controls the pod scheduling strategy of this workload. It offers some additional API's on top of the core pod scheduling. #### Initializers ```typescript import { WorkloadScheduling } from 'cdk8s-plus-32' new WorkloadScheduling(instance: AbstractPod) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | instance | AbstractPod | *No description.* | --- ##### `instance`^Required - *Type:* AbstractPod --- #### Methods | **Name** | **Description** | | --- | --- | | assign | Assign this pod a specific node by name. | | attract | Attract this pod to a node matched by selectors. You can select a node by using `Node.labeled()`. | | colocate | Co-locate this pod with a scheduling selection. | | separate | Seperate this pod from a scheduling selection. | | tolerate | Allow this pod to tolerate taints matching these tolerations. | | spread | Spread the pods in this workload by the topology key. | --- ##### `assign` ```typescript public assign(node: NamedNode): void ``` Assign this pod a specific node by name. The scheduler ignores the Pod, and the kubelet on the named node tries to place the Pod on that node. Overrules any affinity rules of the pod. Some limitations of static assignment are: - If the named node does not exist, the Pod will not run, and in some cases may be automatically deleted. - If the named node does not have the resources to accommodate the Pod, the Pod will fail and its reason will indicate why, for example OutOfmemory or OutOfcpu. - Node names in cloud environments are not always predictable or stable. Will throw is the pod is already assigned to named node. Under the hood, this method utilizes the `nodeName` property. ###### `node`^Required - *Type:* NamedNode --- ##### `attract` ```typescript public attract(node: LabeledNode, options?: PodSchedulingAttractOptions): void ``` Attract this pod to a node matched by selectors. You can select a node by using `Node.labeled()`. Attracting to multiple nodes (i.e invoking this method multiple times) acts as an OR condition, meaning the pod will be assigned to either one of the nodes. Under the hood, this method utilizes the `nodeAffinity` property. > [https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity) ###### `node`^Required - *Type:* LabeledNode --- ###### `options`^Optional - *Type:* PodSchedulingAttractOptions --- ##### `colocate` ```typescript public colocate(selector: IPodSelector, options?: PodSchedulingColocateOptions): void ``` Co-locate this pod with a scheduling selection. A selection can be one of: - An instance of a `Pod`. - An instance of a `Workload` (e.g `Deployment`, `StatefulSet`). - An un-managed pod that can be selected via `Pods.select()`. Co-locating with multiple selections ((i.e invoking this method multiple times)) acts as an AND condition. meaning the pod will be assigned to a node that satisfies all selections (i.e runs at least one pod that satisifies each selection). Under the hood, this method utilizes the `podAffinity` property. > [https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity) ###### `selector`^Required - *Type:* IPodSelector --- ###### `options`^Optional - *Type:* PodSchedulingColocateOptions --- ##### `separate` ```typescript public separate(selector: IPodSelector, options?: PodSchedulingSeparateOptions): void ``` Seperate this pod from a scheduling selection. A selection can be one of: - An instance of a `Pod`. - An instance of a `Workload` (e.g `Deployment`, `StatefulSet`). - An un-managed pod that can be selected via `Pods.select()`. Seperating from multiple selections acts as an AND condition. meaning the pod will not be assigned to a node that satisfies all selections (i.e runs at least one pod that satisifies each selection). Under the hood, this method utilizes the `podAntiAffinity` property. > [https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity) ###### `selector`^Required - *Type:* IPodSelector --- ###### `options`^Optional - *Type:* PodSchedulingSeparateOptions --- ##### `tolerate` ```typescript public tolerate(node: TaintedNode): void ``` Allow this pod to tolerate taints matching these tolerations. You can put multiple taints on the same node and multiple tolerations on the same pod. The way Kubernetes processes multiple taints and tolerations is like a filter: start with all of a node's taints, then ignore the ones for which the pod has a matching toleration; the remaining un-ignored taints have the indicated effects on the pod. In particular: - if there is at least one un-ignored taint with effect NoSchedule then Kubernetes will not schedule the pod onto that node - if there is no un-ignored taint with effect NoSchedule but there is at least one un-ignored taint with effect PreferNoSchedule then Kubernetes will try to not schedule the pod onto the node - if there is at least one un-ignored taint with effect NoExecute then the pod will be evicted from the node (if it is already running on the node), and will not be scheduled onto the node (if it is not yet running on the node). Under the hood, this method utilizes the `tolerations` property. > [https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) ###### `node`^Required - *Type:* TaintedNode --- ##### `spread` ```typescript public spread(options?: WorkloadSchedulingSpreadOptions): void ``` Spread the pods in this workload by the topology key. A spread is a separation of the pod from itself and is used to balance out pod replicas across a given topology. ###### `options`^Optional - *Type:* WorkloadSchedulingSpreadOptions --- ## Protocols ### IApiEndpoint - *Implemented By:* AbstractPod, ApiResource, AwsElasticBlockStorePersistentVolume, AzureDiskPersistentVolume, BasicAuthSecret, ClusterRole, ClusterRoleBinding, ConfigMap, CronJob, DaemonSet, Deployment, DockerConfigSecret, GCEPersistentDiskPersistentVolume, HorizontalPodAutoscaler, Ingress, Job, Namespace, NetworkPolicy, NonApiResource, PersistentVolume, PersistentVolumeClaim, Pod, Resource, Role, RoleBinding, Secret, Service, ServiceAccount, ServiceAccountTokenSecret, SshAuthSecret, StatefulSet, TlsSecret, Workload, IApiEndpoint An API Endpoint can either be a resource descriptor (e.g /pods) or a non resource url (e.g /healthz). It must be one or the other, and not both. #### Methods | **Name** | **Description** | | --- | --- | | asApiResource | Return the IApiResource this object represents. | | asNonApiResource | Return the non resource url this object represents. | --- ##### `asApiResource` ```typescript public asApiResource(): IApiResource ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```typescript public asNonApiResource(): string ``` Return the non resource url this object represents. ### IApiResource - *Implemented By:* AbstractPod, ApiResource, AwsElasticBlockStorePersistentVolume, AzureDiskPersistentVolume, BasicAuthSecret, ClusterRole, ClusterRoleBinding, ConfigMap, CronJob, DaemonSet, Deployment, DockerConfigSecret, GCEPersistentDiskPersistentVolume, HorizontalPodAutoscaler, Ingress, Job, Namespace, NetworkPolicy, PersistentVolume, PersistentVolumeClaim, Pod, Resource, Role, RoleBinding, Secret, Service, ServiceAccount, ServiceAccountTokenSecret, SshAuthSecret, StatefulSet, TlsSecret, Workload, IApiResource, IClusterRole, IConfigMap, IPersistentVolume, IPersistentVolumeClaim, IResource, IRole, ISecret, IServiceAccount Represents a resource or collection of resources. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | | 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. | --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. > [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources) --- *Example* ```typescript - "pods" or "pods/log" ``` ##### `resourceName`^Optional ```typescript 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. --- ### IClusterRole - *Extends:* IResource - *Implemented By:* ClusterRole, IClusterRole Represents a cluster-level role. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | | 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. | | apiVersion | string | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | string | The object kind (e.g. "Deployment"). | | name | string | The Kubernetes name of this resource. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. > [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources) --- *Example* ```typescript - "pods" or "pods/log" ``` ##### `resourceName`^Optional ```typescript 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. --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The Kubernetes name of this resource. --- ### IConfigMap - *Extends:* IResource - *Implemented By:* ConfigMap, IConfigMap Represents a config map. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | | 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. | | apiVersion | string | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | string | The object kind (e.g. "Deployment"). | | name | string | The Kubernetes name of this resource. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. > [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources) --- *Example* ```typescript - "pods" or "pods/log" ``` ##### `resourceName`^Optional ```typescript 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. --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The Kubernetes name of this resource. --- ### INamespaceSelector - *Extends:* constructs.IConstruct - *Implemented By:* Namespace, Namespaces, INamespaceSelector Represents an object that can select namespaces. #### Methods | **Name** | **Description** | | --- | --- | | toNamespaceSelectorConfig | Return the configuration of this selector. | --- ##### `toNamespaceSelectorConfig` ```typescript public toNamespaceSelectorConfig(): NamespaceSelectorConfig ``` Return the configuration of this selector. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### INetworkPolicyPeer - *Extends:* constructs.IConstruct - *Implemented By:* AbstractPod, CronJob, DaemonSet, Deployment, Job, Namespace, Namespaces, NetworkPolicyIpBlock, Pod, StatefulSet, Workload, INetworkPolicyPeer Describes a peer to allow traffic to/from. #### Methods | **Name** | **Description** | | --- | --- | | toNetworkPolicyPeerConfig | Return the configuration of this peer. | | toPodSelector | Convert the peer into a pod selector, if possible. | --- ##### `toNetworkPolicyPeerConfig` ```typescript public toNetworkPolicyPeerConfig(): NetworkPolicyPeerConfig ``` Return the configuration of this peer. ##### `toPodSelector` ```typescript public toPodSelector(): IPodSelector ``` Convert the peer into a pod selector, if possible. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### IPersistentVolume - *Extends:* IResource - *Implemented By:* AwsElasticBlockStorePersistentVolume, AzureDiskPersistentVolume, GCEPersistentDiskPersistentVolume, PersistentVolume, IPersistentVolume Contract of a `PersistentVolumeClaim`. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | | 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. | | apiVersion | string | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | string | The object kind (e.g. "Deployment"). | | name | string | The Kubernetes name of this resource. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. > [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources) --- *Example* ```typescript - "pods" or "pods/log" ``` ##### `resourceName`^Optional ```typescript 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. --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The Kubernetes name of this resource. --- ### IPersistentVolumeClaim - *Extends:* IResource - *Implemented By:* PersistentVolumeClaim, IPersistentVolumeClaim Contract of a `PersistentVolumeClaim`. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | | 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. | | apiVersion | string | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | string | The object kind (e.g. "Deployment"). | | name | string | The Kubernetes name of this resource. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. > [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources) --- *Example* ```typescript - "pods" or "pods/log" ``` ##### `resourceName`^Optional ```typescript 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. --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The Kubernetes name of this resource. --- ### IPodSelector - *Extends:* constructs.IConstruct - *Implemented By:* AbstractPod, CronJob, DaemonSet, Deployment, Job, Pod, Pods, StatefulSet, Workload, IPodSelector Represents an object that can select pods. #### Methods | **Name** | **Description** | | --- | --- | | toPodSelectorConfig | Return the configuration of this selector. | --- ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig(): PodSelectorConfig ``` Return the configuration of this selector. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### IResource - *Extends:* constructs.IConstruct, IApiResource - *Implemented By:* AbstractPod, AwsElasticBlockStorePersistentVolume, AzureDiskPersistentVolume, BasicAuthSecret, ClusterRole, ClusterRoleBinding, ConfigMap, CronJob, DaemonSet, Deployment, DockerConfigSecret, GCEPersistentDiskPersistentVolume, HorizontalPodAutoscaler, Ingress, Job, Namespace, NetworkPolicy, PersistentVolume, PersistentVolumeClaim, Pod, Resource, Role, RoleBinding, Secret, Service, ServiceAccount, ServiceAccountTokenSecret, SshAuthSecret, StatefulSet, TlsSecret, Workload, IClusterRole, IConfigMap, IPersistentVolume, IPersistentVolumeClaim, IResource, IRole, ISecret, IServiceAccount Represents a resource. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | | 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. | | apiVersion | string | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | string | The object kind (e.g. "Deployment"). | | name | string | The Kubernetes name of this resource. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. > [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources) --- *Example* ```typescript - "pods" or "pods/log" ``` ##### `resourceName`^Optional ```typescript 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. --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The Kubernetes name of this resource. --- ### IRole - *Extends:* IResource - *Implemented By:* ClusterRole, Role, IRole A reference to any Role or ClusterRole. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | | 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. | | apiVersion | string | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | string | The object kind (e.g. "Deployment"). | | name | string | The Kubernetes name of this resource. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. > [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources) --- *Example* ```typescript - "pods" or "pods/log" ``` ##### `resourceName`^Optional ```typescript 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. --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The Kubernetes name of this resource. --- ### IScalable - *Implemented By:* Deployment, StatefulSet, IScalable Represents a scalable workload. #### Methods | **Name** | **Description** | | --- | --- | | markHasAutoscaler | Called on all IScalable targets when they are associated with an autoscaler. | | toScalingTarget | Return the target spec properties of this Scalable. | --- ##### `markHasAutoscaler` ```typescript public markHasAutoscaler(): void ``` Called on all IScalable targets when they are associated with an autoscaler. ##### `toScalingTarget` ```typescript public toScalingTarget(): ScalingTarget ``` Return the target spec properties of this Scalable. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | hasAutoscaler | boolean | If this is a target of an autoscaler. | --- ##### `hasAutoscaler`^Required ```typescript public readonly hasAutoscaler: boolean; ``` - *Type:* boolean If this is a target of an autoscaler. --- ### ISecret - *Extends:* IResource - *Implemented By:* BasicAuthSecret, DockerConfigSecret, Secret, ServiceAccountTokenSecret, SshAuthSecret, TlsSecret, ISecret #### Methods | **Name** | **Description** | | --- | --- | | envValue | Returns EnvValue object from a secret's key. | --- ##### `envValue` ```typescript public envValue(key: string, options?: EnvValueFromSecretOptions): EnvValue ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* string Secret's key. --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions Additional EnvValue options. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | | 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. | | apiVersion | string | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | string | The object kind (e.g. "Deployment"). | | name | string | The Kubernetes name of this resource. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. > [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources) --- *Example* ```typescript - "pods" or "pods/log" ``` ##### `resourceName`^Optional ```typescript 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. --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The Kubernetes name of this resource. --- ### IServiceAccount - *Extends:* IResource, ISubject - *Implemented By:* ServiceAccount, IServiceAccount #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | | 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. | | apiVersion | string | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | string | The object kind (e.g. "Deployment"). | | name | string | The Kubernetes name of this resource. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`^Required ```typescript public readonly resourceType: string; ``` - *Type:* string The name of a resource type as it appears in the relevant API endpoint. > [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources) --- *Example* ```typescript - "pods" or "pods/log" ``` ##### `resourceName`^Optional ```typescript 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. --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind (e.g. "Deployment"). --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The Kubernetes name of this resource. --- ### IStorage - *Extends:* constructs.IConstruct - *Implemented By:* AwsElasticBlockStorePersistentVolume, AzureDiskPersistentVolume, GCEPersistentDiskPersistentVolume, PersistentVolume, Volume, IStorage Represents a piece of storage in the cluster. #### Methods | **Name** | **Description** | | --- | --- | | asVolume | Convert the piece of storage into a concrete volume. | --- ##### `asVolume` ```typescript public asVolume(): Volume ``` Convert the piece of storage into a concrete volume. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### ISubject - *Extends:* constructs.IConstruct - *Implemented By:* AbstractPod, CronJob, DaemonSet, Deployment, Group, Job, Pod, ServiceAccount, StatefulSet, User, Workload, IServiceAccount, ISubject Represents an object that can be used as a role binding subject. #### Methods | **Name** | **Description** | | --- | --- | | toSubjectConfiguration | Return the subject configuration. | --- ##### `toSubjectConfiguration` ```typescript public toSubjectConfiguration(): SubjectConfiguration ``` Return the subject configuration. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ## Enums ### AzureDiskPersistentVolumeCachingMode Azure disk caching modes. #### Members | **Name** | **Description** | | --- | --- | | NONE | None. | | READ_ONLY | ReadOnly. | | READ_WRITE | ReadWrite. | --- ##### `NONE` None. --- ##### `READ_ONLY` ReadOnly. --- ##### `READ_WRITE` ReadWrite. --- ### AzureDiskPersistentVolumeKind Azure Disk kinds. #### Members | **Name** | **Description** | | --- | --- | | SHARED | Multiple blob disks per storage account. | | DEDICATED | Single blob disk per storage account. | | MANAGED | Azure managed data disk. | --- ##### `SHARED` Multiple blob disks per storage account. --- ##### `DEDICATED` Single blob disk per storage account. --- ##### `MANAGED` Azure managed data disk. --- ### Capability Capability - complete list of POSIX capabilities. #### Members | **Name** | **Description** | | --- | --- | | ALL | ALL. | | AUDIT_CONTROL | CAP_AUDIT_CONTROL. | | AUDIT_READ | CAP_AUDIT_READ. | | AUDIT_WRITE | CAP_AUDIT_WRITE. | | BLOCK_SUSPEND | CAP_BLOCK_SUSPEND. | | BPF | CAP_BPF. | | CHECKPOINT_RESTORE | CAP_CHECKPOINT_RESTORE. | | CHOWN | CAP_CHOWN. | | DAC_OVERRIDE | CAP_DAC_OVERRIDE. | | DAC_READ_SEARCH | CAP_DAC_READ_SEARCH. | | FOWNER | CAP_FOWNER. | | FSETID | CAP_FSETID. | | IPC_LOCK | CAP_IPC_LOCK. | | IPC_OWNER | CAP_IPC_OWNER. | | KILL | CAP_KILL. | | LEASE | CAP_LEASE. | | LINUX_IMMUTABLE | CAP_LINUX_IMMUTABLE. | | MAC_ADMIN | CAP_MAC_ADMIN. | | MAC_OVERRIDE | CAP_MAC_OVERRIDE. | | MKNOD | CAP_MKNOD. | | NET_ADMIN | CAP_NET_ADMIN. | | NET_BIND_SERVICE | CAP_NET_BIND_SERVICE. | | NET_BROADCAST | CAP_NET_BROADCAST. | | NET_RAW | CAP_NET_RAW. | | PERFMON | CAP_PERFMON. | | SETGID | CAP_SETGID. | | SETFCAP | CAP_SETFCAP. | | SETPCAP | CAP_SETPCAP. | | SETUID | CAP_SETUID. | | SYS_ADMIN | CAP_SYS_ADMIN. | | SYS_BOOT | CAP_SYS_BOOT. | | SYS_CHROOT | CAP_SYS_CHROOT. | | SYS_MODULE | CAP_SYS_MODULE. | | SYS_NICE | CAP_SYS_NICE. | | SYS_PACCT | CAP_SYS_PACCT. | | SYS_PTRACE | CAP_SYS_PTRACE. | | SYS_RAWIO | CAP_SYS_RAWIO. | | SYS_RESOURCE | CAP_SYS_RESOURCE. | | SYS_TIME | CAP_SYS_TIME. | | SYS_TTY_CONFIG | CAP_SYS_TTY_CONFIG. | | SYSLOG | CAP_SYSLOG. | | WAKE_ALARM | CAP_WAKE_ALARM. | --- ##### `ALL` ALL. --- ##### `AUDIT_CONTROL` CAP_AUDIT_CONTROL. --- ##### `AUDIT_READ` CAP_AUDIT_READ. --- ##### `AUDIT_WRITE` CAP_AUDIT_WRITE. --- ##### `BLOCK_SUSPEND` CAP_BLOCK_SUSPEND. --- ##### `BPF` CAP_BPF. --- ##### `CHECKPOINT_RESTORE` CAP_CHECKPOINT_RESTORE. --- ##### `CHOWN` CAP_CHOWN. --- ##### `DAC_OVERRIDE` CAP_DAC_OVERRIDE. --- ##### `DAC_READ_SEARCH` CAP_DAC_READ_SEARCH. --- ##### `FOWNER` CAP_FOWNER. --- ##### `FSETID` CAP_FSETID. --- ##### `IPC_LOCK` CAP_IPC_LOCK. --- ##### `IPC_OWNER` CAP_IPC_OWNER. --- ##### `KILL` CAP_KILL. --- ##### `LEASE` CAP_LEASE. --- ##### `LINUX_IMMUTABLE` CAP_LINUX_IMMUTABLE. --- ##### `MAC_ADMIN` CAP_MAC_ADMIN. --- ##### `MAC_OVERRIDE` CAP_MAC_OVERRIDE. --- ##### `MKNOD` CAP_MKNOD. --- ##### `NET_ADMIN` CAP_NET_ADMIN. --- ##### `NET_BIND_SERVICE` CAP_NET_BIND_SERVICE. --- ##### `NET_BROADCAST` CAP_NET_BROADCAST. --- ##### `NET_RAW` CAP_NET_RAW. --- ##### `PERFMON` CAP_PERFMON. --- ##### `SETGID` CAP_SETGID. --- ##### `SETFCAP` CAP_SETFCAP. --- ##### `SETPCAP` CAP_SETPCAP. --- ##### `SETUID` CAP_SETUID. --- ##### `SYS_ADMIN` CAP_SYS_ADMIN. --- ##### `SYS_BOOT` CAP_SYS_BOOT. --- ##### `SYS_CHROOT` CAP_SYS_CHROOT. --- ##### `SYS_MODULE` CAP_SYS_MODULE. --- ##### `SYS_NICE` CAP_SYS_NICE. --- ##### `SYS_PACCT` CAP_SYS_PACCT. --- ##### `SYS_PTRACE` CAP_SYS_PTRACE. --- ##### `SYS_RAWIO` CAP_SYS_RAWIO. --- ##### `SYS_RESOURCE` CAP_SYS_RESOURCE. --- ##### `SYS_TIME` CAP_SYS_TIME. --- ##### `SYS_TTY_CONFIG` CAP_SYS_TTY_CONFIG. --- ##### `SYSLOG` CAP_SYSLOG. --- ##### `WAKE_ALARM` CAP_WAKE_ALARM. --- ### ConcurrencyPolicy Concurrency policy for CronJobs. #### Members | **Name** | **Description** | | --- | --- | | ALLOW | This policy allows to run job concurrently. | | FORBID | This policy does not allow to run job concurrently. | | REPLACE | This policy replaces the currently running job if a new job is being scheduled. | --- ##### `ALLOW` This policy allows to run job concurrently. --- ##### `FORBID` This policy does not allow to run job concurrently. It does not let a new job to be scheduled if the previous one is not finished yet. --- ##### `REPLACE` This policy replaces the currently running job if a new job is being scheduled. --- ### ConnectionScheme #### Members | **Name** | **Description** | | --- | --- | | HTTP | Use HTTP request for connecting to host. | | HTTPS | Use HTTPS request for connecting to host. | --- ##### `HTTP` Use HTTP request for connecting to host. --- ##### `HTTPS` Use HTTPS request for connecting to host. --- ### ContainerRestartPolicy RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. > [https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/](https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/) #### Members | **Name** | **Description** | | --- | --- | | ALWAYS | If an init container is created with its restartPolicy set to Always, it will start and remain running during the entire life of the Pod. | --- ##### `ALWAYS` If an init container is created with its restartPolicy set to Always, it will start and remain running during the entire life of the Pod. For regular containers, this is ignored by Kubernetes. --- ### DnsPolicy Pod DNS policies. #### Members | **Name** | **Description** | | --- | --- | | CLUSTER_FIRST | Any DNS query that does not match the configured cluster domain suffix, such as "www.kubernetes.io", is forwarded to the upstream nameserver inherited from the node. Cluster administrators may have extra stub-domain and upstream DNS servers configured. | | CLUSTER_FIRST_WITH_HOST_NET | For Pods running with hostNetwork, you should explicitly set its DNS policy "ClusterFirstWithHostNet". | | DEFAULT | The Pod inherits the name resolution configuration from the node that the pods run on. | | NONE | It allows a Pod to ignore DNS settings from the Kubernetes environment. | --- ##### `CLUSTER_FIRST` Any DNS query that does not match the configured cluster domain suffix, such as "www.kubernetes.io", is forwarded to the upstream nameserver inherited from the node. Cluster administrators may have extra stub-domain and upstream DNS servers configured. --- ##### `CLUSTER_FIRST_WITH_HOST_NET` For Pods running with hostNetwork, you should explicitly set its DNS policy "ClusterFirstWithHostNet". --- ##### `DEFAULT` The Pod inherits the name resolution configuration from the node that the pods run on. --- ##### `NONE` It allows a Pod to ignore DNS settings from the Kubernetes environment. All DNS settings are supposed to be provided using the dnsConfig field in the Pod Spec. --- ### EmptyDirMedium The medium on which to store the volume. #### Members | **Name** | **Description** | | --- | --- | | DEFAULT | The default volume of the backing node. | | MEMORY | Mount a tmpfs (RAM-backed filesystem) for you instead. | --- ##### `DEFAULT` The default volume of the backing node. --- ##### `MEMORY` Mount a tmpfs (RAM-backed filesystem) for you instead. While tmpfs is very fast, be aware that unlike disks, tmpfs is cleared on node reboot and any files you write will count against your Container's memory limit. --- ### EnvFieldPaths #### Members | **Name** | **Description** | | --- | --- | | POD_NAME | The name of the pod. | | POD_NAMESPACE | The namespace of the pod. | | POD_UID | The uid of the pod. | | POD_LABEL | The labels of the pod. | | POD_ANNOTATION | The annotations of the pod. | | POD_IP | The ipAddress of the pod. | | SERVICE_ACCOUNT_NAME | The service account name of the pod. | | NODE_NAME | The name of the node. | | NODE_IP | The ipAddress of the node. | | POD_IPS | The ipAddresess of the pod. | --- ##### `POD_NAME` The name of the pod. --- ##### `POD_NAMESPACE` The namespace of the pod. --- ##### `POD_UID` The uid of the pod. --- ##### `POD_LABEL` The labels of the pod. --- ##### `POD_ANNOTATION` The annotations of the pod. --- ##### `POD_IP` The ipAddress of the pod. --- ##### `SERVICE_ACCOUNT_NAME` The service account name of the pod. --- ##### `NODE_NAME` The name of the node. --- ##### `NODE_IP` The ipAddress of the node. --- ##### `POD_IPS` The ipAddresess of the pod. --- ### FsGroupChangePolicy #### Members | **Name** | **Description** | | --- | --- | | ON_ROOT_MISMATCH | Only change permissions and ownership if permission and ownership of root directory does not match with expected permissions of the volume. | | ALWAYS | Always change permission and ownership of the volume when volume is mounted. | --- ##### `ON_ROOT_MISMATCH` Only change permissions and ownership if permission and ownership of root directory does not match with expected permissions of the volume. This could help shorten the time it takes to change ownership and permission of a volume --- ##### `ALWAYS` Always change permission and ownership of the volume when volume is mounted. --- ### HostPathVolumeType Host path types. #### Members | **Name** | **Description** | | --- | --- | | DEFAULT | Empty string (default) is for backward compatibility, which means that no checks will be performed before mounting the hostPath volume. | | DIRECTORY_OR_CREATE | If nothing exists at the given path, an empty directory will be created there as needed with permission set to 0755, having the same group and ownership with Kubelet. | | DIRECTORY | A directory must exist at the given path. | | FILE_OR_CREATE | If nothing exists at the given path, an empty file will be created there as needed with permission set to 0644, having the same group and ownership with Kubelet. | | FILE | A file must exist at the given path. | | SOCKET | A UNIX socket must exist at the given path. | | CHAR_DEVICE | A character device must exist at the given path. | | BLOCK_DEVICE | A block device must exist at the given path. | --- ##### `DEFAULT` Empty string (default) is for backward compatibility, which means that no checks will be performed before mounting the hostPath volume. --- ##### `DIRECTORY_OR_CREATE` If nothing exists at the given path, an empty directory will be created there as needed with permission set to 0755, having the same group and ownership with Kubelet. --- ##### `DIRECTORY` A directory must exist at the given path. --- ##### `FILE_OR_CREATE` If nothing exists at the given path, an empty file will be created there as needed with permission set to 0644, having the same group and ownership with Kubelet. --- ##### `FILE` A file must exist at the given path. --- ##### `SOCKET` A UNIX socket must exist at the given path. --- ##### `CHAR_DEVICE` A character device must exist at the given path. --- ##### `BLOCK_DEVICE` A block device must exist at the given path. --- ### HttpIngressPathType Specify how the path is matched against request paths. > [https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types](https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types) #### Members | **Name** | **Description** | | --- | --- | | PREFIX | Matches the URL path exactly. | | EXACT | Matches based on a URL path prefix split by '/'. | | IMPLEMENTATION_SPECIFIC | Matching is specified by the underlying IngressClass. | --- ##### `PREFIX` Matches the URL path exactly. --- ##### `EXACT` Matches based on a URL path prefix split by '/'. --- ##### `IMPLEMENTATION_SPECIFIC` Matching is specified by the underlying IngressClass. --- ### ImagePullPolicy #### Members | **Name** | **Description** | | --- | --- | | ALWAYS | Every time the kubelet launches a container, the kubelet queries the container image registry to resolve the name to an image digest. | | IF_NOT_PRESENT | The image is pulled only if it is not already present locally. | | NEVER | The image is assumed to exist locally. | --- ##### `ALWAYS` Every time the kubelet launches a container, the kubelet queries the container image registry to resolve the name to an image digest. If the kubelet has a container image with that exact digest cached locally, the kubelet uses its cached image; otherwise, the kubelet downloads (pulls) the image with the resolved digest, and uses that image to launch the container. Default is Always if ImagePullPolicy is omitted and either the image tag is :latest or the image tag is omitted. --- ##### `IF_NOT_PRESENT` The image is pulled only if it is not already present locally. Default is IfNotPresent if ImagePullPolicy is omitted and the image tag is present but not :latest --- ##### `NEVER` The image is assumed to exist locally. No attempt is made to pull the image. --- ### IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds #### Members | **Name** | **Description** | | --- | --- | | DELETE_OPTIONS | DeleteOptions. | --- ##### `DELETE_OPTIONS` DeleteOptions. --- ### MountPropagation #### Members | **Name** | **Description** | | --- | --- | | NONE | This volume mount will not receive any subsequent mounts that are mounted to this volume or any of its subdirectories by the host. | | HOST_TO_CONTAINER | This volume mount will receive all subsequent mounts that are mounted to this volume or any of its subdirectories. | | BIDIRECTIONAL | This volume mount behaves the same the HostToContainer mount. | --- ##### `NONE` This volume mount will not receive any subsequent mounts that are mounted to this volume or any of its subdirectories by the host. In similar fashion, no mounts created by the Container will be visible on the host. This is the default mode. This mode is equal to `private` mount propagation as described in the Linux kernel documentation --- ##### `HOST_TO_CONTAINER` This volume mount will receive all subsequent mounts that are mounted to this volume or any of its subdirectories. In other words, if the host mounts anything inside the volume mount, the Container will see it mounted there. Similarly, if any Pod with Bidirectional mount propagation to the same volume mounts anything there, the Container with HostToContainer mount propagation will see it. This mode is equal to `rslave` mount propagation as described in the Linux kernel documentation --- ##### `BIDIRECTIONAL` This volume mount behaves the same the HostToContainer mount. In addition, all volume mounts created by the Container will be propagated back to the host and to all Containers of all Pods that use the same volume A typical use case for this mode is a Pod with a FlexVolume or CSI driver or a Pod that needs to mount something on the host using a hostPath volume. This mode is equal to `rshared` mount propagation as described in the Linux kernel documentation Caution: Bidirectional mount propagation can be dangerous. It can damage the host operating system and therefore it is allowed only in privileged Containers. Familiarity with Linux kernel behavior is strongly recommended. In addition, any volume mounts created by Containers in Pods must be destroyed (unmounted) by the Containers on termination. --- ### NetworkPolicyTrafficDefault Default behaviors of network traffic in policies. #### Members | **Name** | **Description** | | --- | --- | | DENY | The policy denies all traffic. | | ALLOW | The policy allows all traffic (either ingress or egress). | --- ##### `DENY` The policy denies all traffic. Since rules are additive, additional rules or policies can allow specific traffic. --- ##### `ALLOW` The policy allows all traffic (either ingress or egress). Since rules are additive, no additional rule or policies can subsequently deny the traffic. --- ### NetworkProtocol Network protocols. #### Members | **Name** | **Description** | | --- | --- | | TCP | TCP. | | UDP | UDP. | | SCTP | SCTP. | --- ##### `TCP` TCP. --- ##### `UDP` UDP. --- ##### `SCTP` SCTP. --- ### PersistentVolumeAccessMode Access Modes. #### Members | **Name** | **Description** | | --- | --- | | READ_WRITE_ONCE | The volume can be mounted as read-write by a single node. | | READ_ONLY_MANY | The volume can be mounted as read-only by many nodes. | | READ_WRITE_MANY | The volume can be mounted as read-write by many nodes. | | READ_WRITE_ONCE_POD | The volume can be mounted as read-write by a single Pod. | --- ##### `READ_WRITE_ONCE` The volume can be mounted as read-write by a single node. ReadWriteOnce access mode still can allow multiple pods to access the volume when the pods are running on the same node. --- ##### `READ_ONLY_MANY` The volume can be mounted as read-only by many nodes. --- ##### `READ_WRITE_MANY` The volume can be mounted as read-write by many nodes. --- ##### `READ_WRITE_ONCE_POD` The volume can be mounted as read-write by a single Pod. Use ReadWriteOncePod access mode if you want to ensure that only one pod across whole cluster can read that PVC or write to it. This is only supported for CSI volumes and Kubernetes version 1.22+. --- ### PersistentVolumeMode Volume Modes. #### Members | **Name** | **Description** | | --- | --- | | FILE_SYSTEM | Volume is ounted into Pods into a directory. | | BLOCK | Use a volume as a raw block device. | --- ##### `FILE_SYSTEM` Volume is ounted into Pods into a directory. If the volume is backed by a block device and the device is empty, Kubernetes creates a filesystem on the device before mounting it for the first time. --- ##### `BLOCK` Use a volume as a raw block device. Such volume is presented into a Pod as a block device, without any filesystem on it. This mode is useful to provide a Pod the fastest possible way to access a volume, without any filesystem layer between the Pod and the volume. On the other hand, the application running in the Pod must know how to handle a raw block device --- ### PersistentVolumeReclaimPolicy Reclaim Policies. #### Members | **Name** | **Description** | | --- | --- | | RETAIN | The Retain reclaim policy allows for manual reclamation of the resource. | | DELETE | For volume plugins that support the Delete reclaim policy, deletion removes both the PersistentVolume object from Kubernetes, as well as the associated storage asset in the external infrastructure, such as an AWS EBS, GCE PD, Azure Disk, or Cinder volume. | --- ##### `RETAIN` The Retain reclaim policy allows for manual reclamation of the resource. When the PersistentVolumeClaim is deleted, the PersistentVolume still exists and the volume is considered "released". But it is not yet available for another claim because the previous claimant's data remains on the volume. An administrator can manually reclaim the volume with the following steps: 1. Delete the PersistentVolume. The associated storage asset in external infrastructure (such as an AWS EBS, GCE PD, Azure Disk, or Cinder volume) still exists after the PV is deleted. 2. Manually clean up the data on the associated storage asset accordingly. 3. Manually delete the associated storage asset. If you want to reuse the same storage asset, create a new PersistentVolume with the same storage asset definition. --- ##### `DELETE` For volume plugins that support the Delete reclaim policy, deletion removes both the PersistentVolume object from Kubernetes, as well as the associated storage asset in the external infrastructure, such as an AWS EBS, GCE PD, Azure Disk, or Cinder volume. Volumes that were dynamically provisioned inherit the reclaim policy of their StorageClass, which defaults to Delete. The administrator should configure the StorageClass according to users' expectations; otherwise, the PV must be edited or patched after it is created --- ### PodConnectionsIsolation Isolation determines which policies are created when allowing connections from a a pod / workload to peers. #### Members | **Name** | **Description** | | --- | --- | | POD | Only creates network policies that select the pod. | | PEER | Only creates network policies that select the peer. | --- ##### `POD` Only creates network policies that select the pod. --- ##### `PEER` Only creates network policies that select the peer. --- ### PodManagementPolicy Controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. #### Members | **Name** | **Description** | | --- | --- | | ORDERED_READY | *No description.* | | PARALLEL | *No description.* | --- ##### `ORDERED_READY` --- ##### `PARALLEL` --- ### Protocol Network protocols. #### Members | **Name** | **Description** | | --- | --- | | TCP | TCP. | | UDP | UDP. | | SCTP | SCTP. | --- ##### `TCP` TCP. --- ##### `UDP` UDP. --- ##### `SCTP` SCTP. --- ### ResourceFieldPaths #### Members | **Name** | **Description** | | --- | --- | | CPU_LIMIT | CPU limit of the container. | | MEMORY_LIMIT | Memory limit of the container. | | CPU_REQUEST | CPU request of the container. | | MEMORY_REQUEST | Memory request of the container. | | STORAGE_LIMIT | Ephemeral storage limit of the container. | | STORAGE_REQUEST | Ephemeral storage request of the container. | --- ##### `CPU_LIMIT` CPU limit of the container. --- ##### `MEMORY_LIMIT` Memory limit of the container. --- ##### `CPU_REQUEST` CPU request of the container. --- ##### `MEMORY_REQUEST` Memory request of the container. --- ##### `STORAGE_LIMIT` Ephemeral storage limit of the container. --- ##### `STORAGE_REQUEST` Ephemeral storage request of the container. --- ### RestartPolicy Restart policy for all containers within the pod. #### Members | **Name** | **Description** | | --- | --- | | ALWAYS | Always restart the pod after it exits. | | ON_FAILURE | Only restart if the pod exits with a non-zero exit code. | | NEVER | Never restart the pod. | --- ##### `ALWAYS` Always restart the pod after it exits. --- ##### `ON_FAILURE` Only restart if the pod exits with a non-zero exit code. --- ##### `NEVER` Never restart the pod. --- ### ScalingStrategy #### Members | **Name** | **Description** | | --- | --- | | MAX_CHANGE | Use the policy that provisions the most changes. | | MIN_CHANGE | Use the policy that provisions the least amount of changes. | | DISABLED | Disables scaling in this direction. | --- ##### `MAX_CHANGE` Use the policy that provisions the most changes. --- ##### `MIN_CHANGE` Use the policy that provisions the least amount of changes. --- ##### ~~`DISABLED`~~ - *Deprecated:* - Omit the ScalingRule instead Disables scaling in this direction. --- ### SeccompProfileType #### Members | **Name** | **Description** | | --- | --- | | LOCALHOST | A profile defined in a file on the node should be used. | | RUNTIME_DEFAULT | The container runtime default profile should be used. | | UNCONFINED | No profile should be applied. | --- ##### `LOCALHOST` A profile defined in a file on the node should be used. --- ##### `RUNTIME_DEFAULT` The container runtime default profile should be used. --- ##### `UNCONFINED` No profile should be applied. --- ### ServiceType For some parts of your application (for example, frontends) you may want to expose a Service onto an external IP address, that's outside of your cluster. Kubernetes ServiceTypes allow you to specify what kind of Service you want. The default is ClusterIP. #### Members | **Name** | **Description** | | --- | --- | | CLUSTER_IP | Exposes the Service on a cluster-internal IP. | | NODE_PORT | Exposes the Service on each Node's IP at a static port (the NodePort). | | LOAD_BALANCER | Exposes the Service externally using a cloud provider's load balancer. | | EXTERNAL_NAME | Maps the Service to the contents of the externalName field (e.g. foo.bar.example.com), by returning a CNAME record with its value. No proxying of any kind is set up. | --- ##### `CLUSTER_IP` Exposes the Service on a cluster-internal IP. Choosing this value makes the Service only reachable from within the cluster. This is the default ServiceType --- ##### `NODE_PORT` Exposes the Service on each Node's IP at a static port (the NodePort). A ClusterIP Service, to which the NodePort Service routes, is automatically created. You'll be able to contact the NodePort Service, from outside the cluster, by requesting :. --- ##### `LOAD_BALANCER` Exposes the Service externally using a cloud provider's load balancer. NodePort and ClusterIP Services, to which the external load balancer routes, are automatically created. --- ##### `EXTERNAL_NAME` Maps the Service to the contents of the externalName field (e.g. foo.bar.example.com), by returning a CNAME record with its value. No proxying of any kind is set up. > Note: You need either kube-dns version 1.7 or CoreDNS version 0.0.8 or higher to use the ExternalName type. --- ### TaintEffect Taint effects. #### Members | **Name** | **Description** | | --- | --- | | NO_SCHEDULE | This means that no pod will be able to schedule onto the node unless it has a matching toleration. | | PREFER_NO_SCHEDULE | This is a "preference" or "soft" version of `NO_SCHEDULE` -- the system will try to avoid placing a pod that does not tolerate the taint on the node, but it is not required. | | NO_EXECUTE | This affects pods that are already running on the node as follows:. | --- ##### `NO_SCHEDULE` This means that no pod will be able to schedule onto the node unless it has a matching toleration. --- ##### `PREFER_NO_SCHEDULE` This is a "preference" or "soft" version of `NO_SCHEDULE` -- the system will try to avoid placing a pod that does not tolerate the taint on the node, but it is not required. --- ##### `NO_EXECUTE` This affects pods that are already running on the node as follows:. Pods that do not tolerate the taint are evicted immediately. - Pods that tolerate the taint without specifying `duration` remain bound forever. - Pods that tolerate the taint with a specified `duration` remain bound for the specified amount of time. ---