# API Reference ## Constructs ### AbstractPod - *Implements:* IPodSelector, INetworkPolicyPeer, ISubject #### Initializers ```java import org.cdk8s.plus32.AbstractPod; AbstractPod.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .automountServiceAccountToken(java.lang.Boolean) // .containers(java.util.List) // .dns(PodDnsProps) // .dockerRegistryAuth(ISecret) // .enableServiceLinks(java.lang.Boolean) // .hostAliases(java.util.List) // .hostNetwork(java.lang.Boolean) // .initContainers(java.util.List) // .isolate(java.lang.Boolean) // .restartPolicy(RestartPolicy) // .securityContext(PodSecurityContextProps) // .serviceAccount(IServiceAccount) // .shareProcessNamespace(java.lang.Boolean) // .terminationGracePeriod(Duration) // .volumes(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | java.lang.Boolean | Indicates whether a service account token should be automatically mounted. | | containers | java.util.List<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 | java.lang.Boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | java.util.List<HostAlias> | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | java.lang.Boolean | Host network for the pod. | | initContainers | java.util.List<ContainerProps> | List of initialization containers belonging to the pod. | | isolate | java.lang.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 | java.lang.Boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | org.cdk8s.Duration | Grace period until the pod is terminated. | | volumes | java.util.List<Volume> | List of volumes that can be mounted by containers belonging to the pod. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<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 - *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 - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<HostAlias> HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional - *Type:* java.lang.Boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional - *Type:* java.util.List<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 - *Type:* java.lang.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 - *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 - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional - *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 - *Type:* java.lang.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 - *Type:* org.cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional - *Type:* java.util.List<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) --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addContainer` ```java public Container addContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```java public void addHostAlias(HostAlias hostAlias) ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```java public Container addInitContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```java public void addVolume(Volume vol) ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```java public void attachContainer(Container cont) ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```java public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig() ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```java public IPodSelector toPodSelector() ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```java public PodSelectorConfig toPodSelectorConfig() ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```java public SubjectConfiguration toSubjectConfiguration() ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.AbstractPod; AbstractPod.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | automountServiceAccountToken | java.lang.Boolean | *No description.* | | containers | java.util.List<Container> | *No description.* | | dns | PodDns | *No description.* | | hostAliases | java.util.List<HostAlias> | *No description.* | | initContainers | java.util.List<Container> | *No description.* | | podMetadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | securityContext | PodSecurityContext | *No description.* | | shareProcessNamespace | java.lang.Boolean | *No description.* | | volumes | java.util.List<Volume> | *No description.* | | dockerRegistryAuth | ISecret | *No description.* | | enableServiceLinks | java.lang.Boolean | *No description.* | | hostNetwork | java.lang.Boolean | *No description.* | | restartPolicy | RestartPolicy | *No description.* | | serviceAccount | IServiceAccount | *No description.* | | terminationGracePeriod | org.cdk8s.Duration | *No description.* | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getAutomountServiceAccountToken(); ``` - *Type:* java.lang.Boolean --- ##### `containers`^Required ```java public java.util.List getContainers(); ``` - *Type:* java.util.List<Container> --- ##### `dns`^Required ```java public PodDns getDns(); ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```java public java.util.List getHostAliases(); ``` - *Type:* java.util.List<HostAlias> --- ##### `initContainers`^Required ```java public java.util.List getInitContainers(); ``` - *Type:* java.util.List<Container> --- ##### `podMetadata`^Required ```java public ApiObjectMetadataDefinition getPodMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `securityContext`^Required ```java public PodSecurityContext getSecurityContext(); ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```java public java.lang.Boolean getShareProcessNamespace(); ``` - *Type:* java.lang.Boolean --- ##### `volumes`^Required ```java public java.util.List getVolumes(); ``` - *Type:* java.util.List<Volume> --- ##### `dockerRegistryAuth`^Optional ```java public ISecret getDockerRegistryAuth(); ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```java public java.lang.Boolean getEnableServiceLinks(); ``` - *Type:* java.lang.Boolean --- ##### `hostNetwork`^Optional ```java public java.lang.Boolean getHostNetwork(); ``` - *Type:* java.lang.Boolean --- ##### `restartPolicy`^Optional ```java public RestartPolicy getRestartPolicy(); ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```java public IServiceAccount getServiceAccount(); ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```java public Duration getTerminationGracePeriod(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.AwsElasticBlockStorePersistentVolume; AwsElasticBlockStorePersistentVolume.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .accessModes(java.util.List) // .claim(IPersistentVolumeClaim) // .mountOptions(java.util.List) // .reclaimPolicy(PersistentVolumeReclaimPolicy) // .storage(Size) // .storageClassName(java.lang.String) // .volumeMode(PersistentVolumeMode) .volumeId(java.lang.String) // .fsType(java.lang.String) // .partition(java.lang.Number) // .readOnly(java.lang.Boolean) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | java.util.List<PersistentVolumeAccessMode> | Contains all ways the volume can be mounted. | | claim | IPersistentVolumeClaim | Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. | | mountOptions | java.util.List | 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 | org.cdk8s.Size | What is the storage capacity of this volume. | | storageClassName | java.lang.String | Name of StorageClass to which this persistent volume belongs. | | volumeMode | PersistentVolumeMode | Defines what type of volume is required by the claim. | | volumeId | java.lang.String | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). | | fsType | java.lang.String | Filesystem type of the volume that you want to mount. | | partition | java.lang.Number | The partition in the volume that you want to mount. | | readOnly | java.lang.Boolean | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional - *Type:* java.util.List<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 - *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 - *Type:* java.util.List - *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 - *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 - *Type:* org.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 - *Type:* java.lang.String - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`^Optional - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ##### `volumeId`^Required - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.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) --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `asVolume` ```java public Volume asVolume() ``` Convert the piece of storage into a concrete volume. ##### `bind` ```java public void bind(IPersistentVolumeClaim claim) ``` 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` ```java public PersistentVolumeClaim reserve() ``` 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` ```java import org.cdk8s.plus32.AwsElasticBlockStorePersistentVolume; AwsElasticBlockStorePersistentVolume.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromPersistentVolumeName` ```java import org.cdk8s.plus32.AwsElasticBlockStorePersistentVolume; AwsElasticBlockStorePersistentVolume.fromPersistentVolumeName(Construct scope, java.lang.String id, java.lang.String volumeName) ``` Imports a pv from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `volumeName`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.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 | java.util.List<PersistentVolumeAccessMode> | Access modes requirement of this claim. | | claim | IPersistentVolumeClaim | PVC this volume is bound to. | | mountOptions | java.util.List | Mount options of this volume. | | storage | org.cdk8s.Size | Storage size of this volume. | | storageClassName | java.lang.String | Storage class this volume belongs to. | | fsType | java.lang.String | File system type of this volume. | | readOnly | java.lang.Boolean | Whether or not it is mounted as a read-only volume. | | volumeId | java.lang.String | Volume id of this volume. | | partition | java.lang.Number | Partition of this volume. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public PersistentVolumeMode getMode(); ``` - *Type:* PersistentVolumeMode Volume mode of this volume. --- ##### `reclaimPolicy`^Required ```java public PersistentVolumeReclaimPolicy getReclaimPolicy(); ``` - *Type:* PersistentVolumeReclaimPolicy Reclaim policy of this volume. --- ##### `accessModes`^Optional ```java public java.util.List getAccessModes(); ``` - *Type:* java.util.List<PersistentVolumeAccessMode> Access modes requirement of this claim. --- ##### `claim`^Optional ```java public IPersistentVolumeClaim getClaim(); ``` - *Type:* IPersistentVolumeClaim PVC this volume is bound to. Undefined means this volume is not yet claimed by any PVC. --- ##### `mountOptions`^Optional ```java public java.util.List getMountOptions(); ``` - *Type:* java.util.List Mount options of this volume. --- ##### `storage`^Optional ```java public Size getStorage(); ``` - *Type:* org.cdk8s.Size Storage size of this volume. --- ##### `storageClassName`^Optional ```java public java.lang.String getStorageClassName(); ``` - *Type:* java.lang.String Storage class this volume belongs to. --- ##### `fsType`^Required ```java public java.lang.String getFsType(); ``` - *Type:* java.lang.String File system type of this volume. --- ##### `readOnly`^Required ```java public java.lang.Boolean getReadOnly(); ``` - *Type:* java.lang.Boolean Whether or not it is mounted as a read-only volume. --- ##### `volumeId`^Required ```java public java.lang.String getVolumeId(); ``` - *Type:* java.lang.String Volume id of this volume. --- ##### `partition`^Optional ```java public java.lang.Number getPartition(); ``` - *Type:* java.lang.Number Partition of this volume. --- ### AzureDiskPersistentVolume AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. #### Initializers ```java import org.cdk8s.plus32.AzureDiskPersistentVolume; AzureDiskPersistentVolume.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .accessModes(java.util.List) // .claim(IPersistentVolumeClaim) // .mountOptions(java.util.List) // .reclaimPolicy(PersistentVolumeReclaimPolicy) // .storage(Size) // .storageClassName(java.lang.String) // .volumeMode(PersistentVolumeMode) .diskName(java.lang.String) .diskUri(java.lang.String) // .cachingMode(AzureDiskPersistentVolumeCachingMode) // .fsType(java.lang.String) // .kind(AzureDiskPersistentVolumeKind) // .readOnly(java.lang.Boolean) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | java.util.List<PersistentVolumeAccessMode> | Contains all ways the volume can be mounted. | | claim | IPersistentVolumeClaim | Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. | | mountOptions | java.util.List | 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 | org.cdk8s.Size | What is the storage capacity of this volume. | | storageClassName | java.lang.String | Name of StorageClass to which this persistent volume belongs. | | volumeMode | PersistentVolumeMode | Defines what type of volume is required by the claim. | | diskName | java.lang.String | The Name of the data disk in the blob storage. | | diskUri | java.lang.String | The URI the data disk in the blob storage. | | cachingMode | AzureDiskPersistentVolumeCachingMode | Host Caching mode. | | fsType | java.lang.String | Filesystem type to mount. | | kind | AzureDiskPersistentVolumeKind | Kind of disk. | | readOnly | java.lang.Boolean | Force the ReadOnly setting in VolumeMounts. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional - *Type:* java.util.List<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 - *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 - *Type:* java.util.List - *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 - *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 - *Type:* org.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 - *Type:* java.lang.String - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`^Optional - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ##### `diskName`^Required - *Type:* java.lang.String The Name of the data disk in the blob storage. --- ##### `diskUri`^Required - *Type:* java.lang.String The URI the data disk in the blob storage. --- ##### `cachingMode`^Optional - *Type:* AzureDiskPersistentVolumeCachingMode - *Default:* AzureDiskPersistentVolumeCachingMode.NONE. Host Caching mode. --- ##### `fsType`^Optional - *Type:* java.lang.String - *Default:* 'ext4' Filesystem type to mount. Must be a filesystem type supported by the host operating system. --- ##### `kind`^Optional - *Type:* AzureDiskPersistentVolumeKind - *Default:* AzureDiskPersistentVolumeKind.SHARED Kind of disk. --- ##### `readOnly`^Optional - *Type:* java.lang.Boolean - *Default:* false Force the ReadOnly setting in VolumeMounts. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `asVolume` ```java public Volume asVolume() ``` Convert the piece of storage into a concrete volume. ##### `bind` ```java public void bind(IPersistentVolumeClaim claim) ``` 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` ```java public PersistentVolumeClaim reserve() ``` 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` ```java import org.cdk8s.plus32.AzureDiskPersistentVolume; AzureDiskPersistentVolume.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromPersistentVolumeName` ```java import org.cdk8s.plus32.AzureDiskPersistentVolume; AzureDiskPersistentVolume.fromPersistentVolumeName(Construct scope, java.lang.String id, java.lang.String volumeName) ``` Imports a pv from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `volumeName`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.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 | java.util.List<PersistentVolumeAccessMode> | Access modes requirement of this claim. | | claim | IPersistentVolumeClaim | PVC this volume is bound to. | | mountOptions | java.util.List | Mount options of this volume. | | storage | org.cdk8s.Size | Storage size of this volume. | | storageClassName | java.lang.String | Storage class this volume belongs to. | | azureKind | AzureDiskPersistentVolumeKind | Azure kind of this volume. | | cachingMode | AzureDiskPersistentVolumeCachingMode | Caching mode of this volume. | | diskName | java.lang.String | Disk name of this volume. | | diskUri | java.lang.String | Disk URI of this volume. | | fsType | java.lang.String | File system type of this volume. | | readOnly | java.lang.Boolean | Whether or not it is mounted as a read-only volume. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public PersistentVolumeMode getMode(); ``` - *Type:* PersistentVolumeMode Volume mode of this volume. --- ##### `reclaimPolicy`^Required ```java public PersistentVolumeReclaimPolicy getReclaimPolicy(); ``` - *Type:* PersistentVolumeReclaimPolicy Reclaim policy of this volume. --- ##### `accessModes`^Optional ```java public java.util.List getAccessModes(); ``` - *Type:* java.util.List<PersistentVolumeAccessMode> Access modes requirement of this claim. --- ##### `claim`^Optional ```java public IPersistentVolumeClaim getClaim(); ``` - *Type:* IPersistentVolumeClaim PVC this volume is bound to. Undefined means this volume is not yet claimed by any PVC. --- ##### `mountOptions`^Optional ```java public java.util.List getMountOptions(); ``` - *Type:* java.util.List Mount options of this volume. --- ##### `storage`^Optional ```java public Size getStorage(); ``` - *Type:* org.cdk8s.Size Storage size of this volume. --- ##### `storageClassName`^Optional ```java public java.lang.String getStorageClassName(); ``` - *Type:* java.lang.String Storage class this volume belongs to. --- ##### `azureKind`^Required ```java public AzureDiskPersistentVolumeKind getAzureKind(); ``` - *Type:* AzureDiskPersistentVolumeKind Azure kind of this volume. --- ##### `cachingMode`^Required ```java public AzureDiskPersistentVolumeCachingMode getCachingMode(); ``` - *Type:* AzureDiskPersistentVolumeCachingMode Caching mode of this volume. --- ##### `diskName`^Required ```java public java.lang.String getDiskName(); ``` - *Type:* java.lang.String Disk name of this volume. --- ##### `diskUri`^Required ```java public java.lang.String getDiskUri(); ``` - *Type:* java.lang.String Disk URI of this volume. --- ##### `fsType`^Required ```java public java.lang.String getFsType(); ``` - *Type:* java.lang.String File system type of this volume. --- ##### `readOnly`^Required ```java public java.lang.Boolean getReadOnly(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.BasicAuthSecret; BasicAuthSecret.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .immutable(java.lang.Boolean) .password(java.lang.String) .username(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | java.lang.Boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | password | java.lang.String | The password or token for authentication. | | username | java.lang.String | The user name for authentication. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional - *Type:* java.lang.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 - *Type:* java.lang.String The password or token for authentication. --- ##### `username`^Required - *Type:* java.lang.String The user name for authentication. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addStringData` ```java public void addStringData(java.lang.String key, java.lang.String value) ``` Adds a string data field to the secret. ###### `key`^Required - *Type:* java.lang.String Key. --- ###### `value`^Required - *Type:* java.lang.String Value. --- ##### `envValue` ```java public EnvValue envValue(java.lang.String key) public EnvValue envValue(java.lang.String key, EnvValueFromSecretOptions options) ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* java.lang.String --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions --- ##### `getStringData` ```java public java.lang.String getStringData(java.lang.String key) ``` Gets a string data by key or undefined. ###### `key`^Required - *Type:* java.lang.String Key. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromSecretName | Imports a secret from the cluster as a reference. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.BasicAuthSecret; BasicAuthSecret.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromSecretName` ```java import org.cdk8s.plus32.BasicAuthSecret; BasicAuthSecret.fromSecretName(Construct scope, java.lang.String id, java.lang.String name) ``` Imports a secret from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | immutable | java.lang.Boolean | Whether or not the secret is immutable. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getImmutable(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.ClusterRole; ClusterRole.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .aggregationLabels(java.util.Map) // .rules(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | aggregationLabels | java.util.Map | Specify labels that should be used to locate ClusterRoles, whose rules will be automatically filled into this ClusterRole's rules. | | rules | java.util.List<ClusterRolePolicyRule> | A list of rules the role should allow. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `aggregationLabels`^Optional - *Type:* java.util.Map Specify labels that should be used to locate ClusterRoles, whose rules will be automatically filled into this ClusterRole's rules. --- ##### `rules`^Optional - *Type:* java.util.List<ClusterRolePolicyRule> - *Default:* [] A list of rules the role should allow. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `aggregate` ```java public void aggregate(java.lang.String key, java.lang.String value) ``` Aggregate rules from roles matching this label selector. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `allow` ```java public void allow(java.util.List verbs, IApiEndpoint... endpoints) ``` 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:* java.util.List --- ###### `endpoints`^Required - *Type:* IApiEndpoint... The endpoints(s) to apply to. --- ##### `allowCreate` ```java public void allowCreate(IApiEndpoint... endpoints) ``` Add "create" permission for the resources. ###### `endpoints`^Required - *Type:* IApiEndpoint... The resource(s) to apply to. --- ##### `allowDelete` ```java public void allowDelete(IApiEndpoint... endpoints) ``` Add "delete" permission for the resources. ###### `endpoints`^Required - *Type:* IApiEndpoint... The resource(s) to apply to. --- ##### `allowDeleteCollection` ```java public void allowDeleteCollection(IApiEndpoint... endpoints) ``` Add "deletecollection" permission for the resources. ###### `endpoints`^Required - *Type:* IApiEndpoint... The resource(s) to apply to. --- ##### `allowGet` ```java public void allowGet(IApiEndpoint... endpoints) ``` Add "get" permission for the resources. ###### `endpoints`^Required - *Type:* IApiEndpoint... The resource(s) to apply to. --- ##### `allowList` ```java public void allowList(IApiEndpoint... endpoints) ``` Add "list" permission for the resources. ###### `endpoints`^Required - *Type:* IApiEndpoint... The resource(s) to apply to. --- ##### `allowPatch` ```java public void allowPatch(IApiEndpoint... endpoints) ``` Add "patch" permission for the resources. ###### `endpoints`^Required - *Type:* IApiEndpoint... The resource(s) to apply to. --- ##### `allowRead` ```java public void allowRead(IApiEndpoint... endpoints) ``` Add "get", "list", and "watch" permissions for the resources. ###### `endpoints`^Required - *Type:* IApiEndpoint... The resource(s) to apply to. --- ##### `allowReadWrite` ```java public void allowReadWrite(IApiEndpoint... endpoints) ``` 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` ```java public void allowUpdate(IApiEndpoint... endpoints) ``` Add "update" permission for the resources. ###### `endpoints`^Required - *Type:* IApiEndpoint... The resource(s) to apply to. --- ##### `allowWatch` ```java public void allowWatch(IApiEndpoint... endpoints) ``` Add "watch" permission for the resources. ###### `endpoints`^Required - *Type:* IApiEndpoint... The resource(s) to apply to. --- ##### `bind` ```java public ClusterRoleBinding bind(ISubject... subjects) ``` 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` ```java public RoleBinding bindInNamespace(java.lang.String namespace, ISubject... subjects) ``` 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:* java.lang.String the namespace to limit permissions to. --- ###### `subjects`^Required - *Type:* ISubject... a list of subjects to bind to. --- ##### `combine` ```java public void combine(ClusterRole rol) ``` 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` ```java import org.cdk8s.plus32.ClusterRole; ClusterRole.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromClusterRoleName` ```java import org.cdk8s.plus32.ClusterRole; ClusterRole.fromClusterRoleName(Construct scope, java.lang.String id, java.lang.String name) ``` Imports a role from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | rules | java.util.List<ClusterRolePolicyRule> | Rules associaated with this Role. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.util.List getRules(); ``` - *Type:* java.util.List<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 ```java import org.cdk8s.plus32.ClusterRoleBinding; ClusterRoleBinding.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) .role(IClusterRole) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | role | IClusterRole | The role to bind to. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `role`^Required - *Type:* IClusterRole The role to bind to. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addSubjects` ```java public void addSubjects(ISubject... subjects) ``` 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` ```java import org.cdk8s.plus32.ClusterRoleBinding; ClusterRoleBinding.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | role | IClusterRole | *No description.* | | subjects | java.util.List<ISubject> | *No description.* | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public IClusterRole getRole(); ``` - *Type:* IClusterRole --- ##### `subjects`^Required ```java public java.util.List getSubjects(); ``` - *Type:* java.util.List<ISubject> --- ### ConfigMap - *Implements:* IConfigMap ConfigMap holds configuration data for pods to consume. #### Initializers ```java import org.cdk8s.plus32.ConfigMap; ConfigMap.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .binaryData(java.util.Map) // .data(java.util.Map) // .immutable(java.lang.Boolean) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | binaryData | java.util.Map | BinaryData contains the binary data. | | data | java.util.Map | Data contains the configuration data. | | immutable | java.lang.Boolean | If set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `binaryData`^Optional - *Type:* java.util.Map 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 - *Type:* java.util.Map 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 - *Type:* java.lang.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. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addBinaryData` ```java public void addBinaryData(java.lang.String key, java.lang.String value) ``` 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:* java.lang.String The key. --- ###### `value`^Required - *Type:* java.lang.String The value. --- ##### `addData` ```java public void addData(java.lang.String key, java.lang.String value) ``` Adds a data entry to the config map. ###### `key`^Required - *Type:* java.lang.String The key. --- ###### `value`^Required - *Type:* java.lang.String The value. --- ##### `addDirectory` ```java public void addDirectory(java.lang.String localDir) public void addDirectory(java.lang.String localDir, AddDirectoryOptions options) ``` Adds a directory to the ConfigMap. ###### `localDir`^Required - *Type:* java.lang.String A path to a local directory. --- ###### `options`^Optional - *Type:* AddDirectoryOptions Options. --- ##### `addFile` ```java public void addFile(java.lang.String localFile) public void addFile(java.lang.String localFile, java.lang.String key) ``` Adds a file to the ConfigMap. ###### `localFile`^Required - *Type:* java.lang.String The path to the local file. --- ###### `key`^Optional - *Type:* java.lang.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` ```java import org.cdk8s.plus32.ConfigMap; ConfigMap.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromConfigMapName` ```java import org.cdk8s.plus32.ConfigMap; ConfigMap.fromConfigMapName(Construct scope, java.lang.String id, java.lang.String name) ``` Represents a ConfigMap created elsewhere. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | binaryData | java.util.Map | The binary data associated with this config map. | | data | java.util.Map | The data associated with this config map. | | immutable | java.lang.Boolean | Whether or not this config map is immutable. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.util.Map getBinaryData(); ``` - *Type:* java.util.Map The binary data associated with this config map. Returns a copy. To add data records, use `addBinaryData()` or `addData()`. --- ##### `data`^Required ```java public java.util.Map getData(); ``` - *Type:* java.util.Map The data associated with this config map. Returns an copy. To add data records, use `addData()` or `addBinaryData()`. --- ##### `immutable`^Required ```java public java.lang.Boolean getImmutable(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.CronJob; CronJob.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .automountServiceAccountToken(java.lang.Boolean) // .containers(java.util.List) // .dns(PodDnsProps) // .dockerRegistryAuth(ISecret) // .enableServiceLinks(java.lang.Boolean) // .hostAliases(java.util.List) // .hostNetwork(java.lang.Boolean) // .initContainers(java.util.List) // .isolate(java.lang.Boolean) // .restartPolicy(RestartPolicy) // .securityContext(PodSecurityContextProps) // .serviceAccount(IServiceAccount) // .shareProcessNamespace(java.lang.Boolean) // .terminationGracePeriod(Duration) // .volumes(java.util.List) // .podMetadata(ApiObjectMetadata) // .select(java.lang.Boolean) // .spread(java.lang.Boolean) // .activeDeadline(Duration) // .backoffLimit(java.lang.Number) // .ttlAfterFinished(Duration) .schedule(Cron) // .concurrencyPolicy(ConcurrencyPolicy) // .failedJobsRetained(java.lang.Number) // .startingDeadline(Duration) // .successfulJobsRetained(java.lang.Number) // .suspend(java.lang.Boolean) // .timeZone(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | java.lang.Boolean | Indicates whether a service account token should be automatically mounted. | | containers | java.util.List<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 | java.lang.Boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | java.util.List<HostAlias> | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | java.lang.Boolean | Host network for the pod. | | initContainers | java.util.List<ContainerProps> | List of initialization containers belonging to the pod. | | isolate | java.lang.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 | java.lang.Boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | org.cdk8s.Duration | Grace period until the pod is terminated. | | volumes | java.util.List<Volume> | List of volumes that can be mounted by containers belonging to the pod. | | podMetadata | org.cdk8s.ApiObjectMetadata | The pod metadata of this workload. | | select | java.lang.Boolean | Automatically allocates a pod label selector for this workload and add it to the pod metadata. | | spread | java.lang.Boolean | Automatically spread pods across hostname and zones. | | activeDeadline | org.cdk8s.Duration | Specifies the duration the job may be active before the system tries to terminate it. | | backoffLimit | java.lang.Number | Specifies the number of retries before marking this job failed. | | ttlAfterFinished | org.cdk8s.Duration | Limits the lifetime of a Job that has finished execution (either Complete or Failed). | | schedule | org.cdk8s.Cron | Specifies the time in which the job would run again. | | concurrencyPolicy | ConcurrencyPolicy | Specifies the concurrency policy for the job. | | failedJobsRetained | java.lang.Number | Specifies the number of failed jobs history retained. | | startingDeadline | org.cdk8s.Duration | Kubernetes attempts to start cron jobs at its schedule time, but this is not guaranteed. | | successfulJobsRetained | java.lang.Number | Specifies the number of successful jobs history retained. | | suspend | java.lang.Boolean | Specifies if the cron job should be suspended. | | timeZone | java.lang.String | Specifies the timezone for the job. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<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 - *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 - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<HostAlias> HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional - *Type:* java.lang.Boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional - *Type:* java.util.List<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 - *Type:* java.lang.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 - *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 - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional - *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 - *Type:* java.lang.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 - *Type:* org.cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional - *Type:* java.util.List<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 - *Type:* org.cdk8s.ApiObjectMetadata The pod metadata of this workload. --- ##### `select`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* org.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 - *Type:* java.lang.Number - *Default:* If not set, system defaults to 6. Specifies the number of retries before marking this job failed. --- ##### `ttlAfterFinished`^Optional - *Type:* org.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 - *Type:* org.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 - *Type:* ConcurrencyPolicy - *Default:* ConcurrencyPolicy.Forbid Specifies the concurrency policy for the job. --- ##### `failedJobsRetained`^Optional - *Type:* java.lang.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 - *Type:* org.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 - *Type:* java.lang.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 - *Type:* java.lang.Boolean - *Default:* false Specifies if the cron job should be suspended. Only applies to future executions, current ones are remained untouched. --- ##### `timeZone`^Optional - *Type:* java.lang.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.) --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addContainer` ```java public Container addContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```java public void addHostAlias(HostAlias hostAlias) ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```java public Container addInitContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```java public void addVolume(Volume vol) ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```java public void attachContainer(Container cont) ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```java public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig() ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```java public IPodSelector toPodSelector() ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```java public PodSelectorConfig toPodSelectorConfig() ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```java public SubjectConfiguration toSubjectConfiguration() ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) ##### `select` ```java public void select(LabelSelector... selectors) ``` Configure selectors for this workload. ###### `selectors`^Required - *Type:* LabelSelector... --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.CronJob; CronJob.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | Represents the resource type. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | automountServiceAccountToken | java.lang.Boolean | *No description.* | | containers | java.util.List<Container> | *No description.* | | dns | PodDns | *No description.* | | hostAliases | java.util.List<HostAlias> | *No description.* | | initContainers | java.util.List<Container> | *No description.* | | podMetadata | org.cdk8s.ApiObjectMetadataDefinition | The metadata of pods in this workload. | | securityContext | PodSecurityContext | *No description.* | | shareProcessNamespace | java.lang.Boolean | *No description.* | | volumes | java.util.List<Volume> | *No description.* | | dockerRegistryAuth | ISecret | *No description.* | | enableServiceLinks | java.lang.Boolean | *No description.* | | hostNetwork | java.lang.Boolean | *No description.* | | restartPolicy | RestartPolicy | *No description.* | | serviceAccount | IServiceAccount | *No description.* | | terminationGracePeriod | org.cdk8s.Duration | *No description.* | | connections | PodConnections | *No description.* | | matchExpressions | java.util.List<LabelSelectorRequirement> | The expression matchers this workload will use in order to select pods. | | matchLabels | java.util.Map | The label matchers this workload will use in order to select pods. | | scheduling | WorkloadScheduling | *No description.* | | concurrencyPolicy | java.lang.String | The policy used by this cron job to determine the concurrency mode in which to schedule jobs. | | failedJobsRetained | java.lang.Number | The number of failed jobs retained by this cron job. | | schedule | org.cdk8s.Cron | The schedule this cron job is scheduled to run in. | | startingDeadline | org.cdk8s.Duration | The time by which the running cron job needs to schedule the next job execution. | | successfulJobsRetained | java.lang.Number | The number of successful jobs retained by this cron job. | | suspend | java.lang.Boolean | Whether or not the cron job is currently suspended or not. | | timeZone | java.lang.String | The timezone which this cron job would follow to schedule jobs. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String Represents the resource type. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getAutomountServiceAccountToken(); ``` - *Type:* java.lang.Boolean --- ##### `containers`^Required ```java public java.util.List getContainers(); ``` - *Type:* java.util.List<Container> --- ##### `dns`^Required ```java public PodDns getDns(); ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```java public java.util.List getHostAliases(); ``` - *Type:* java.util.List<HostAlias> --- ##### `initContainers`^Required ```java public java.util.List getInitContainers(); ``` - *Type:* java.util.List<Container> --- ##### `podMetadata`^Required ```java public ApiObjectMetadataDefinition getPodMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition The metadata of pods in this workload. --- ##### `securityContext`^Required ```java public PodSecurityContext getSecurityContext(); ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```java public java.lang.Boolean getShareProcessNamespace(); ``` - *Type:* java.lang.Boolean --- ##### `volumes`^Required ```java public java.util.List getVolumes(); ``` - *Type:* java.util.List<Volume> --- ##### `dockerRegistryAuth`^Optional ```java public ISecret getDockerRegistryAuth(); ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```java public java.lang.Boolean getEnableServiceLinks(); ``` - *Type:* java.lang.Boolean --- ##### `hostNetwork`^Optional ```java public java.lang.Boolean getHostNetwork(); ``` - *Type:* java.lang.Boolean --- ##### `restartPolicy`^Optional ```java public RestartPolicy getRestartPolicy(); ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```java public IServiceAccount getServiceAccount(); ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```java public Duration getTerminationGracePeriod(); ``` - *Type:* org.cdk8s.Duration --- ##### `connections`^Required ```java public PodConnections getConnections(); ``` - *Type:* PodConnections --- ##### `matchExpressions`^Required ```java public java.util.List getMatchExpressions(); ``` - *Type:* java.util.List<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 ```java public java.util.Map getMatchLabels(); ``` - *Type:* java.util.Map The label matchers this workload will use in order to select pods. Returns a a copy. Use `select()` to add label matchers. --- ##### `scheduling`^Required ```java public WorkloadScheduling getScheduling(); ``` - *Type:* WorkloadScheduling --- ##### `concurrencyPolicy`^Required ```java public java.lang.String getConcurrencyPolicy(); ``` - *Type:* java.lang.String The policy used by this cron job to determine the concurrency mode in which to schedule jobs. --- ##### `failedJobsRetained`^Required ```java public java.lang.Number getFailedJobsRetained(); ``` - *Type:* java.lang.Number The number of failed jobs retained by this cron job. --- ##### `schedule`^Required ```java public Cron getSchedule(); ``` - *Type:* org.cdk8s.Cron The schedule this cron job is scheduled to run in. --- ##### `startingDeadline`^Required ```java public Duration getStartingDeadline(); ``` - *Type:* org.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 ```java public java.lang.Number getSuccessfulJobsRetained(); ``` - *Type:* java.lang.Number The number of successful jobs retained by this cron job. --- ##### `suspend`^Required ```java public java.lang.Boolean getSuspend(); ``` - *Type:* java.lang.Boolean Whether or not the cron job is currently suspended or not. --- ##### `timeZone`^Optional ```java public java.lang.String getTimeZone(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.DaemonSet; DaemonSet.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .automountServiceAccountToken(java.lang.Boolean) // .containers(java.util.List) // .dns(PodDnsProps) // .dockerRegistryAuth(ISecret) // .enableServiceLinks(java.lang.Boolean) // .hostAliases(java.util.List) // .hostNetwork(java.lang.Boolean) // .initContainers(java.util.List) // .isolate(java.lang.Boolean) // .restartPolicy(RestartPolicy) // .securityContext(PodSecurityContextProps) // .serviceAccount(IServiceAccount) // .shareProcessNamespace(java.lang.Boolean) // .terminationGracePeriod(Duration) // .volumes(java.util.List) // .podMetadata(ApiObjectMetadata) // .select(java.lang.Boolean) // .spread(java.lang.Boolean) // .minReadySeconds(java.lang.Number) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | java.lang.Boolean | Indicates whether a service account token should be automatically mounted. | | containers | java.util.List<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 | java.lang.Boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | java.util.List<HostAlias> | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | java.lang.Boolean | Host network for the pod. | | initContainers | java.util.List<ContainerProps> | List of initialization containers belonging to the pod. | | isolate | java.lang.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 | java.lang.Boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | org.cdk8s.Duration | Grace period until the pod is terminated. | | volumes | java.util.List<Volume> | List of volumes that can be mounted by containers belonging to the pod. | | podMetadata | org.cdk8s.ApiObjectMetadata | The pod metadata of this workload. | | select | java.lang.Boolean | Automatically allocates a pod label selector for this workload and add it to the pod metadata. | | spread | java.lang.Boolean | Automatically spread pods across hostname and zones. | | minReadySeconds | java.lang.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. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<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 - *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 - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<HostAlias> HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional - *Type:* java.lang.Boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional - *Type:* java.util.List<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 - *Type:* java.lang.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 - *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 - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional - *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 - *Type:* java.lang.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 - *Type:* org.cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional - *Type:* java.util.List<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 - *Type:* org.cdk8s.ApiObjectMetadata The pod metadata of this workload. --- ##### `select`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.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. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addContainer` ```java public Container addContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```java public void addHostAlias(HostAlias hostAlias) ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```java public Container addInitContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```java public void addVolume(Volume vol) ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```java public void attachContainer(Container cont) ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```java public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig() ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```java public IPodSelector toPodSelector() ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```java public PodSelectorConfig toPodSelectorConfig() ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```java public SubjectConfiguration toSubjectConfiguration() ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) ##### `select` ```java public void select(LabelSelector... selectors) ``` Configure selectors for this workload. ###### `selectors`^Required - *Type:* LabelSelector... --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.DaemonSet; DaemonSet.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | automountServiceAccountToken | java.lang.Boolean | *No description.* | | containers | java.util.List<Container> | *No description.* | | dns | PodDns | *No description.* | | hostAliases | java.util.List<HostAlias> | *No description.* | | initContainers | java.util.List<Container> | *No description.* | | podMetadata | org.cdk8s.ApiObjectMetadataDefinition | The metadata of pods in this workload. | | securityContext | PodSecurityContext | *No description.* | | shareProcessNamespace | java.lang.Boolean | *No description.* | | volumes | java.util.List<Volume> | *No description.* | | dockerRegistryAuth | ISecret | *No description.* | | enableServiceLinks | java.lang.Boolean | *No description.* | | hostNetwork | java.lang.Boolean | *No description.* | | restartPolicy | RestartPolicy | *No description.* | | serviceAccount | IServiceAccount | *No description.* | | terminationGracePeriod | org.cdk8s.Duration | *No description.* | | connections | PodConnections | *No description.* | | matchExpressions | java.util.List<LabelSelectorRequirement> | The expression matchers this workload will use in order to select pods. | | matchLabels | java.util.Map | The label matchers this workload will use in order to select pods. | | scheduling | WorkloadScheduling | *No description.* | | minReadySeconds | java.lang.Number | *No description.* | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getAutomountServiceAccountToken(); ``` - *Type:* java.lang.Boolean --- ##### `containers`^Required ```java public java.util.List getContainers(); ``` - *Type:* java.util.List<Container> --- ##### `dns`^Required ```java public PodDns getDns(); ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```java public java.util.List getHostAliases(); ``` - *Type:* java.util.List<HostAlias> --- ##### `initContainers`^Required ```java public java.util.List getInitContainers(); ``` - *Type:* java.util.List<Container> --- ##### `podMetadata`^Required ```java public ApiObjectMetadataDefinition getPodMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition The metadata of pods in this workload. --- ##### `securityContext`^Required ```java public PodSecurityContext getSecurityContext(); ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```java public java.lang.Boolean getShareProcessNamespace(); ``` - *Type:* java.lang.Boolean --- ##### `volumes`^Required ```java public java.util.List getVolumes(); ``` - *Type:* java.util.List<Volume> --- ##### `dockerRegistryAuth`^Optional ```java public ISecret getDockerRegistryAuth(); ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```java public java.lang.Boolean getEnableServiceLinks(); ``` - *Type:* java.lang.Boolean --- ##### `hostNetwork`^Optional ```java public java.lang.Boolean getHostNetwork(); ``` - *Type:* java.lang.Boolean --- ##### `restartPolicy`^Optional ```java public RestartPolicy getRestartPolicy(); ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```java public IServiceAccount getServiceAccount(); ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```java public Duration getTerminationGracePeriod(); ``` - *Type:* org.cdk8s.Duration --- ##### `connections`^Required ```java public PodConnections getConnections(); ``` - *Type:* PodConnections --- ##### `matchExpressions`^Required ```java public java.util.List getMatchExpressions(); ``` - *Type:* java.util.List<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 ```java public java.util.Map getMatchLabels(); ``` - *Type:* java.util.Map The label matchers this workload will use in order to select pods. Returns a a copy. Use `select()` to add label matchers. --- ##### `scheduling`^Required ```java public WorkloadScheduling getScheduling(); ``` - *Type:* WorkloadScheduling --- ##### `minReadySeconds`^Required ```java public java.lang.Number getMinReadySeconds(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.Deployment; Deployment.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .automountServiceAccountToken(java.lang.Boolean) // .containers(java.util.List) // .dns(PodDnsProps) // .dockerRegistryAuth(ISecret) // .enableServiceLinks(java.lang.Boolean) // .hostAliases(java.util.List) // .hostNetwork(java.lang.Boolean) // .initContainers(java.util.List) // .isolate(java.lang.Boolean) // .restartPolicy(RestartPolicy) // .securityContext(PodSecurityContextProps) // .serviceAccount(IServiceAccount) // .shareProcessNamespace(java.lang.Boolean) // .terminationGracePeriod(Duration) // .volumes(java.util.List) // .podMetadata(ApiObjectMetadata) // .select(java.lang.Boolean) // .spread(java.lang.Boolean) // .minReady(Duration) // .progressDeadline(Duration) // .replicas(java.lang.Number) // .revisionHistoryLimit(java.lang.Number) // .strategy(DeploymentStrategy) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | java.lang.Boolean | Indicates whether a service account token should be automatically mounted. | | containers | java.util.List<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 | java.lang.Boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | java.util.List<HostAlias> | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | java.lang.Boolean | Host network for the pod. | | initContainers | java.util.List<ContainerProps> | List of initialization containers belonging to the pod. | | isolate | java.lang.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 | java.lang.Boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | org.cdk8s.Duration | Grace period until the pod is terminated. | | volumes | java.util.List<Volume> | List of volumes that can be mounted by containers belonging to the pod. | | podMetadata | org.cdk8s.ApiObjectMetadata | The pod metadata of this workload. | | select | java.lang.Boolean | Automatically allocates a pod label selector for this workload and add it to the pod metadata. | | spread | java.lang.Boolean | Automatically spread pods across hostname and zones. | | minReady | org.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 | org.cdk8s.Duration | The maximum duration for a deployment to make progress before it is considered to be failed. | | replicas | java.lang.Number | Number of desired pods. | | revisionHistoryLimit | java.lang.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. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<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 - *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 - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<HostAlias> HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional - *Type:* java.lang.Boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional - *Type:* java.util.List<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 - *Type:* java.lang.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 - *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 - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional - *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 - *Type:* java.lang.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 - *Type:* org.cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional - *Type:* java.util.List<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 - *Type:* org.cdk8s.ApiObjectMetadata The pod metadata of this workload. --- ##### `select`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* org.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 - *Type:* org.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 - *Type:* java.lang.Number - *Default:* 2 Number of desired pods. --- ##### `revisionHistoryLimit`^Optional - *Type:* java.lang.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 - *Type:* DeploymentStrategy - *Default:* RollingUpdate with maxSurge and maxUnavailable set to 25%. Specifies the strategy used to replace old Pods by new ones. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addContainer` ```java public Container addContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```java public void addHostAlias(HostAlias hostAlias) ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```java public Container addInitContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```java public void addVolume(Volume vol) ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```java public void attachContainer(Container cont) ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```java public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig() ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```java public IPodSelector toPodSelector() ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```java public PodSelectorConfig toPodSelectorConfig() ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```java public SubjectConfiguration toSubjectConfiguration() ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) ##### `select` ```java public void select(LabelSelector... selectors) ``` Configure selectors for this workload. ###### `selectors`^Required - *Type:* LabelSelector... --- ##### `exposeViaIngress` ```java public Ingress exposeViaIngress(java.lang.String path) public Ingress exposeViaIngress(java.lang.String path, ExposeDeploymentViaIngressOptions options) ``` 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:* java.lang.String The ingress path to register under. --- ###### `options`^Optional - *Type:* ExposeDeploymentViaIngressOptions Additional options. --- ##### `exposeViaService` ```java public Service exposeViaService() public Service exposeViaService(DeploymentExposeViaServiceOptions options) ``` 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` ```java public void markHasAutoscaler() ``` Called on all IScalable targets when they are associated with an autoscaler. > [IScalable.markHasAutoscaler ()](IScalable.markHasAutoscaler ()) ##### `toScalingTarget` ```java public ScalingTarget toScalingTarget() ``` Return the target spec properties of this Scalable. > [IScalable.toScalingTarget ()](IScalable.toScalingTarget ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.Deployment; Deployment.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | automountServiceAccountToken | java.lang.Boolean | *No description.* | | containers | java.util.List<Container> | *No description.* | | dns | PodDns | *No description.* | | hostAliases | java.util.List<HostAlias> | *No description.* | | initContainers | java.util.List<Container> | *No description.* | | podMetadata | org.cdk8s.ApiObjectMetadataDefinition | The metadata of pods in this workload. | | securityContext | PodSecurityContext | *No description.* | | shareProcessNamespace | java.lang.Boolean | *No description.* | | volumes | java.util.List<Volume> | *No description.* | | dockerRegistryAuth | ISecret | *No description.* | | enableServiceLinks | java.lang.Boolean | *No description.* | | hostNetwork | java.lang.Boolean | *No description.* | | restartPolicy | RestartPolicy | *No description.* | | serviceAccount | IServiceAccount | *No description.* | | terminationGracePeriod | org.cdk8s.Duration | *No description.* | | connections | PodConnections | *No description.* | | matchExpressions | java.util.List<LabelSelectorRequirement> | The expression matchers this workload will use in order to select pods. | | matchLabels | java.util.Map | The label matchers this workload will use in order to select pods. | | scheduling | WorkloadScheduling | *No description.* | | minReady | org.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 | org.cdk8s.Duration | The maximum duration for a deployment to make progress before it is considered to be failed. | | revisionHistoryLimit | java.lang.Number | Number of desired replicasets history. | | strategy | DeploymentStrategy | *No description.* | | replicas | java.lang.Number | Number of desired pods. | | hasAutoscaler | java.lang.Boolean | If this is a target of an autoscaler. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getAutomountServiceAccountToken(); ``` - *Type:* java.lang.Boolean --- ##### `containers`^Required ```java public java.util.List getContainers(); ``` - *Type:* java.util.List<Container> --- ##### `dns`^Required ```java public PodDns getDns(); ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```java public java.util.List getHostAliases(); ``` - *Type:* java.util.List<HostAlias> --- ##### `initContainers`^Required ```java public java.util.List getInitContainers(); ``` - *Type:* java.util.List<Container> --- ##### `podMetadata`^Required ```java public ApiObjectMetadataDefinition getPodMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition The metadata of pods in this workload. --- ##### `securityContext`^Required ```java public PodSecurityContext getSecurityContext(); ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```java public java.lang.Boolean getShareProcessNamespace(); ``` - *Type:* java.lang.Boolean --- ##### `volumes`^Required ```java public java.util.List getVolumes(); ``` - *Type:* java.util.List<Volume> --- ##### `dockerRegistryAuth`^Optional ```java public ISecret getDockerRegistryAuth(); ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```java public java.lang.Boolean getEnableServiceLinks(); ``` - *Type:* java.lang.Boolean --- ##### `hostNetwork`^Optional ```java public java.lang.Boolean getHostNetwork(); ``` - *Type:* java.lang.Boolean --- ##### `restartPolicy`^Optional ```java public RestartPolicy getRestartPolicy(); ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```java public IServiceAccount getServiceAccount(); ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```java public Duration getTerminationGracePeriod(); ``` - *Type:* org.cdk8s.Duration --- ##### `connections`^Required ```java public PodConnections getConnections(); ``` - *Type:* PodConnections --- ##### `matchExpressions`^Required ```java public java.util.List getMatchExpressions(); ``` - *Type:* java.util.List<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 ```java public java.util.Map getMatchLabels(); ``` - *Type:* java.util.Map The label matchers this workload will use in order to select pods. Returns a a copy. Use `select()` to add label matchers. --- ##### `scheduling`^Required ```java public WorkloadScheduling getScheduling(); ``` - *Type:* WorkloadScheduling --- ##### `minReady`^Required ```java public Duration getMinReady(); ``` - *Type:* org.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 ```java public Duration getProgressDeadline(); ``` - *Type:* org.cdk8s.Duration The maximum duration for a deployment to make progress before it is considered to be failed. --- ##### `revisionHistoryLimit`^Required ```java public java.lang.Number getRevisionHistoryLimit(); ``` - *Type:* java.lang.Number - *Default:* 10 Number of desired replicasets history. --- ##### `strategy`^Required ```java public DeploymentStrategy getStrategy(); ``` - *Type:* DeploymentStrategy --- ##### `replicas`^Optional ```java public java.lang.Number getReplicas(); ``` - *Type:* java.lang.Number Number of desired pods. --- ##### `hasAutoscaler`^Required ```java public java.lang.Boolean getHasAutoscaler(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.DockerConfigSecret; DockerConfigSecret.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .immutable(java.lang.Boolean) .data(java.util.Map) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | java.lang.Boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | data | java.util.Map | JSON content to provide for the `~/.docker/config.json` file. This will be stringified and inserted as stringData. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional - *Type:* java.lang.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 - *Type:* java.util.Map 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) --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addStringData` ```java public void addStringData(java.lang.String key, java.lang.String value) ``` Adds a string data field to the secret. ###### `key`^Required - *Type:* java.lang.String Key. --- ###### `value`^Required - *Type:* java.lang.String Value. --- ##### `envValue` ```java public EnvValue envValue(java.lang.String key) public EnvValue envValue(java.lang.String key, EnvValueFromSecretOptions options) ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* java.lang.String --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions --- ##### `getStringData` ```java public java.lang.String getStringData(java.lang.String key) ``` Gets a string data by key or undefined. ###### `key`^Required - *Type:* java.lang.String Key. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromSecretName | Imports a secret from the cluster as a reference. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.DockerConfigSecret; DockerConfigSecret.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromSecretName` ```java import org.cdk8s.plus32.DockerConfigSecret; DockerConfigSecret.fromSecretName(Construct scope, java.lang.String id, java.lang.String name) ``` Imports a secret from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | immutable | java.lang.Boolean | Whether or not the secret is immutable. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getImmutable(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.GCEPersistentDiskPersistentVolume; GCEPersistentDiskPersistentVolume.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .accessModes(java.util.List) // .claim(IPersistentVolumeClaim) // .mountOptions(java.util.List) // .reclaimPolicy(PersistentVolumeReclaimPolicy) // .storage(Size) // .storageClassName(java.lang.String) // .volumeMode(PersistentVolumeMode) .pdName(java.lang.String) // .fsType(java.lang.String) // .partition(java.lang.Number) // .readOnly(java.lang.Boolean) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | java.util.List<PersistentVolumeAccessMode> | Contains all ways the volume can be mounted. | | claim | IPersistentVolumeClaim | Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. | | mountOptions | java.util.List | 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 | org.cdk8s.Size | What is the storage capacity of this volume. | | storageClassName | java.lang.String | Name of StorageClass to which this persistent volume belongs. | | volumeMode | PersistentVolumeMode | Defines what type of volume is required by the claim. | | pdName | java.lang.String | Unique name of the PD resource in GCE. | | fsType | java.lang.String | Filesystem type of the volume that you want to mount. | | partition | java.lang.Number | The partition in the volume that you want to mount. | | readOnly | java.lang.Boolean | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional - *Type:* java.util.List<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 - *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 - *Type:* java.util.List - *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 - *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 - *Type:* org.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 - *Type:* java.lang.String - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`^Optional - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ##### `pdName`^Required - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.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) --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `asVolume` ```java public Volume asVolume() ``` Convert the piece of storage into a concrete volume. ##### `bind` ```java public void bind(IPersistentVolumeClaim claim) ``` 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` ```java public PersistentVolumeClaim reserve() ``` 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` ```java import org.cdk8s.plus32.GCEPersistentDiskPersistentVolume; GCEPersistentDiskPersistentVolume.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromPersistentVolumeName` ```java import org.cdk8s.plus32.GCEPersistentDiskPersistentVolume; GCEPersistentDiskPersistentVolume.fromPersistentVolumeName(Construct scope, java.lang.String id, java.lang.String volumeName) ``` Imports a pv from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `volumeName`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.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 | java.util.List<PersistentVolumeAccessMode> | Access modes requirement of this claim. | | claim | IPersistentVolumeClaim | PVC this volume is bound to. | | mountOptions | java.util.List | Mount options of this volume. | | storage | org.cdk8s.Size | Storage size of this volume. | | storageClassName | java.lang.String | Storage class this volume belongs to. | | fsType | java.lang.String | File system type of this volume. | | pdName | java.lang.String | PD resource in GCE of this volume. | | readOnly | java.lang.Boolean | Whether or not it is mounted as a read-only volume. | | partition | java.lang.Number | Partition of this volume. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public PersistentVolumeMode getMode(); ``` - *Type:* PersistentVolumeMode Volume mode of this volume. --- ##### `reclaimPolicy`^Required ```java public PersistentVolumeReclaimPolicy getReclaimPolicy(); ``` - *Type:* PersistentVolumeReclaimPolicy Reclaim policy of this volume. --- ##### `accessModes`^Optional ```java public java.util.List getAccessModes(); ``` - *Type:* java.util.List<PersistentVolumeAccessMode> Access modes requirement of this claim. --- ##### `claim`^Optional ```java public IPersistentVolumeClaim getClaim(); ``` - *Type:* IPersistentVolumeClaim PVC this volume is bound to. Undefined means this volume is not yet claimed by any PVC. --- ##### `mountOptions`^Optional ```java public java.util.List getMountOptions(); ``` - *Type:* java.util.List Mount options of this volume. --- ##### `storage`^Optional ```java public Size getStorage(); ``` - *Type:* org.cdk8s.Size Storage size of this volume. --- ##### `storageClassName`^Optional ```java public java.lang.String getStorageClassName(); ``` - *Type:* java.lang.String Storage class this volume belongs to. --- ##### `fsType`^Required ```java public java.lang.String getFsType(); ``` - *Type:* java.lang.String File system type of this volume. --- ##### `pdName`^Required ```java public java.lang.String getPdName(); ``` - *Type:* java.lang.String PD resource in GCE of this volume. --- ##### `readOnly`^Required ```java public java.lang.Boolean getReadOnly(); ``` - *Type:* java.lang.Boolean Whether or not it is mounted as a read-only volume. --- ##### `partition`^Optional ```java public java.lang.Number getPartition(); ``` - *Type:* java.lang.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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `toSubjectConfiguration` ```java public SubjectConfiguration toSubjectConfiguration() ``` 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` ```java import org.cdk8s.plus32.Group; Group.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromName` ```java import org.cdk8s.plus32.Group; Group.fromName(Construct scope, java.lang.String id, java.lang.String name) ``` Reference a group by name. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | kind | java.lang.String | *No description.* | | name | java.lang.String | *No description.* | | apiGroup | java.lang.String | *No description.* | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String --- ##### `apiGroup`^Optional ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.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* ```java // Example automatically generated from non-compiling source. May contain errors. Object backend = new Deployment(this, "Backend", ...); Object hpa = HorizontalPodAutoscaler.Builder.create(chart, "Hpa") .target(backend) .maxReplicas(10) .scaleUp(Map.of( "policies", List.of(Map.of( "replicas", kplus.Replicas.absolute(3), "duration", Duration.minutes(5))))) .build(); ``` #### Initializers ```java import org.cdk8s.plus32.HorizontalPodAutoscaler; HorizontalPodAutoscaler.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) .maxReplicas(java.lang.Number) .target(IScalable) // .metrics(java.util.List) // .minReplicas(java.lang.Number) // .scaleDown(ScalingRules) // .scaleUp(ScalingRules) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | maxReplicas | java.lang.Number | The maximum number of replicas that can be scaled up to. | | target | IScalable | The workload to scale up or down. | | metrics | java.util.List<Metric> | The metric conditions that trigger a scale up or scale down. | | minReplicas | java.lang.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. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `maxReplicas`^Required - *Type:* java.lang.Number The maximum number of replicas that can be scaled up to. --- ##### `target`^Required - *Type:* IScalable The workload to scale up or down. Scalable workload types: * Deployment * StatefulSet --- ##### `metrics`^Optional - *Type:* java.util.List<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 - *Type:* java.lang.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 - *Type:* ScalingRules - *Default:* Scale down to minReplica count with a 5 minute stabilization window. The scaling behavior when scaling down. --- ##### `scaleUp`^Optional - *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. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.HorizontalPodAutoscaler; HorizontalPodAutoscaler.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | maxReplicas | java.lang.Number | The maximum number of replicas that can be scaled up to. | | minReplicas | java.lang.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 | java.util.List<Metric> | The metric conditions that trigger a scale up or scale down. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Number getMaxReplicas(); ``` - *Type:* java.lang.Number The maximum number of replicas that can be scaled up to. --- ##### `minReplicas`^Required ```java public java.lang.Number getMinReplicas(); ``` - *Type:* java.lang.Number The minimum number of replicas that can be scaled down to. --- ##### `scaleDown`^Required ```java public ScalingRules getScaleDown(); ``` - *Type:* ScalingRules The scaling behavior when scaling down. --- ##### `scaleUp`^Required ```java public ScalingRules getScaleUp(); ``` - *Type:* ScalingRules The scaling behavior when scaling up. --- ##### `target`^Required ```java public IScalable getTarget(); ``` - *Type:* IScalable The workload to scale up or down. --- ##### `metrics`^Optional ```java public java.util.List getMetrics(); ``` - *Type:* java.util.List<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 ```java import org.cdk8s.plus32.Ingress; Ingress.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .className(java.lang.String) // .defaultBackend(IngressBackend) // .rules(java.util.List) // .tls(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | className | java.lang.String | Class Name for this ingress. | | defaultBackend | IngressBackend | The default backend services requests that do not match any rule. | | rules | java.util.List<IngressRule> | Routing rules for this ingress. | | tls | java.util.List<IngressTls> | TLS settings for this ingress. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `className`^Optional - *Type:* java.lang.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 - *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 - *Type:* java.util.List<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 - *Type:* java.util.List<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. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addDefaultBackend` ```java public void addDefaultBackend(IngressBackend backend) ``` 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` ```java public void addHostDefaultBackend(java.lang.String host, IngressBackend backend) ``` 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:* java.lang.String The host name to match. --- ###### `backend`^Required - *Type:* IngressBackend The backend to route to. --- ##### `addHostRule` ```java public void addHostRule(java.lang.String host, java.lang.String path, IngressBackend backend) public void addHostRule(java.lang.String host, java.lang.String path, IngressBackend backend, HttpIngressPathType pathType) ``` 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:* java.lang.String The host name. --- ###### `path`^Required - *Type:* java.lang.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` ```java public void addRule(java.lang.String path, IngressBackend backend) public void addRule(java.lang.String path, IngressBackend backend, HttpIngressPathType pathType) ``` Adds an ingress rule applied to requests sent to a specific HTTP path. ###### `path`^Required - *Type:* java.lang.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` ```java public void addRules(IngressRule... rules) ``` Adds rules to this ingress. ###### `rules`^Required - *Type:* IngressRule... The rules to add. --- ##### `addTls` ```java public void addTls(java.util.List tls) ``` ###### `tls`^Required - *Type:* java.util.List<IngressTls> --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.Ingress; Ingress.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.Job; Job.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .automountServiceAccountToken(java.lang.Boolean) // .containers(java.util.List) // .dns(PodDnsProps) // .dockerRegistryAuth(ISecret) // .enableServiceLinks(java.lang.Boolean) // .hostAliases(java.util.List) // .hostNetwork(java.lang.Boolean) // .initContainers(java.util.List) // .isolate(java.lang.Boolean) // .restartPolicy(RestartPolicy) // .securityContext(PodSecurityContextProps) // .serviceAccount(IServiceAccount) // .shareProcessNamespace(java.lang.Boolean) // .terminationGracePeriod(Duration) // .volumes(java.util.List) // .podMetadata(ApiObjectMetadata) // .select(java.lang.Boolean) // .spread(java.lang.Boolean) // .activeDeadline(Duration) // .backoffLimit(java.lang.Number) // .ttlAfterFinished(Duration) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | java.lang.Boolean | Indicates whether a service account token should be automatically mounted. | | containers | java.util.List<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 | java.lang.Boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | java.util.List<HostAlias> | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | java.lang.Boolean | Host network for the pod. | | initContainers | java.util.List<ContainerProps> | List of initialization containers belonging to the pod. | | isolate | java.lang.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 | java.lang.Boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | org.cdk8s.Duration | Grace period until the pod is terminated. | | volumes | java.util.List<Volume> | List of volumes that can be mounted by containers belonging to the pod. | | podMetadata | org.cdk8s.ApiObjectMetadata | The pod metadata of this workload. | | select | java.lang.Boolean | Automatically allocates a pod label selector for this workload and add it to the pod metadata. | | spread | java.lang.Boolean | Automatically spread pods across hostname and zones. | | activeDeadline | org.cdk8s.Duration | Specifies the duration the job may be active before the system tries to terminate it. | | backoffLimit | java.lang.Number | Specifies the number of retries before marking this job failed. | | ttlAfterFinished | org.cdk8s.Duration | Limits the lifetime of a Job that has finished execution (either Complete or Failed). | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<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 - *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 - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<HostAlias> HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional - *Type:* java.lang.Boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional - *Type:* java.util.List<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 - *Type:* java.lang.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 - *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 - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional - *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 - *Type:* java.lang.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 - *Type:* org.cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional - *Type:* java.util.List<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 - *Type:* org.cdk8s.ApiObjectMetadata The pod metadata of this workload. --- ##### `select`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* org.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 - *Type:* java.lang.Number - *Default:* If not set, system defaults to 6. Specifies the number of retries before marking this job failed. --- ##### `ttlAfterFinished`^Optional - *Type:* org.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. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addContainer` ```java public Container addContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```java public void addHostAlias(HostAlias hostAlias) ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```java public Container addInitContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```java public void addVolume(Volume vol) ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```java public void attachContainer(Container cont) ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```java public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig() ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```java public IPodSelector toPodSelector() ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```java public PodSelectorConfig toPodSelectorConfig() ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```java public SubjectConfiguration toSubjectConfiguration() ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) ##### `select` ```java public void select(LabelSelector... selectors) ``` Configure selectors for this workload. ###### `selectors`^Required - *Type:* LabelSelector... --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.Job; Job.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | automountServiceAccountToken | java.lang.Boolean | *No description.* | | containers | java.util.List<Container> | *No description.* | | dns | PodDns | *No description.* | | hostAliases | java.util.List<HostAlias> | *No description.* | | initContainers | java.util.List<Container> | *No description.* | | podMetadata | org.cdk8s.ApiObjectMetadataDefinition | The metadata of pods in this workload. | | securityContext | PodSecurityContext | *No description.* | | shareProcessNamespace | java.lang.Boolean | *No description.* | | volumes | java.util.List<Volume> | *No description.* | | dockerRegistryAuth | ISecret | *No description.* | | enableServiceLinks | java.lang.Boolean | *No description.* | | hostNetwork | java.lang.Boolean | *No description.* | | restartPolicy | RestartPolicy | *No description.* | | serviceAccount | IServiceAccount | *No description.* | | terminationGracePeriod | org.cdk8s.Duration | *No description.* | | connections | PodConnections | *No description.* | | matchExpressions | java.util.List<LabelSelectorRequirement> | The expression matchers this workload will use in order to select pods. | | matchLabels | java.util.Map | The label matchers this workload will use in order to select pods. | | scheduling | WorkloadScheduling | *No description.* | | activeDeadline | org.cdk8s.Duration | Duration before job is terminated. | | backoffLimit | java.lang.Number | Number of retries before marking failed. | | ttlAfterFinished | org.cdk8s.Duration | TTL before the job is deleted after it is finished. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getAutomountServiceAccountToken(); ``` - *Type:* java.lang.Boolean --- ##### `containers`^Required ```java public java.util.List getContainers(); ``` - *Type:* java.util.List<Container> --- ##### `dns`^Required ```java public PodDns getDns(); ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```java public java.util.List getHostAliases(); ``` - *Type:* java.util.List<HostAlias> --- ##### `initContainers`^Required ```java public java.util.List getInitContainers(); ``` - *Type:* java.util.List<Container> --- ##### `podMetadata`^Required ```java public ApiObjectMetadataDefinition getPodMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition The metadata of pods in this workload. --- ##### `securityContext`^Required ```java public PodSecurityContext getSecurityContext(); ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```java public java.lang.Boolean getShareProcessNamespace(); ``` - *Type:* java.lang.Boolean --- ##### `volumes`^Required ```java public java.util.List getVolumes(); ``` - *Type:* java.util.List<Volume> --- ##### `dockerRegistryAuth`^Optional ```java public ISecret getDockerRegistryAuth(); ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```java public java.lang.Boolean getEnableServiceLinks(); ``` - *Type:* java.lang.Boolean --- ##### `hostNetwork`^Optional ```java public java.lang.Boolean getHostNetwork(); ``` - *Type:* java.lang.Boolean --- ##### `restartPolicy`^Optional ```java public RestartPolicy getRestartPolicy(); ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```java public IServiceAccount getServiceAccount(); ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```java public Duration getTerminationGracePeriod(); ``` - *Type:* org.cdk8s.Duration --- ##### `connections`^Required ```java public PodConnections getConnections(); ``` - *Type:* PodConnections --- ##### `matchExpressions`^Required ```java public java.util.List getMatchExpressions(); ``` - *Type:* java.util.List<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 ```java public java.util.Map getMatchLabels(); ``` - *Type:* java.util.Map The label matchers this workload will use in order to select pods. Returns a a copy. Use `select()` to add label matchers. --- ##### `scheduling`^Required ```java public WorkloadScheduling getScheduling(); ``` - *Type:* WorkloadScheduling --- ##### `activeDeadline`^Optional ```java public Duration getActiveDeadline(); ``` - *Type:* org.cdk8s.Duration Duration before job is terminated. If undefined, there is no deadline. --- ##### `backoffLimit`^Optional ```java public java.lang.Number getBackoffLimit(); ``` - *Type:* java.lang.Number Number of retries before marking failed. --- ##### `ttlAfterFinished`^Optional ```java public Duration getTtlAfterFinished(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeApiService; KubeApiService.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(ApiServiceSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.ApiServiceSpec | Spec contains information for locating and communicating with a server. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.ApiServiceSpec Spec contains information for locating and communicating with a server. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is 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` ```java import org.cdk8s.plus32.k8s.KubeApiService; KubeApiService.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeApiService; KubeApiService.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeApiService; KubeApiService.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeApiService; KubeApiService.manifest(),KubeApiService.manifest(KubeApiServiceProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeApiServiceProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeApiServiceList; KubeApiServiceList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of APIService. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of APIService. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is 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` ```java import org.cdk8s.plus32.k8s.KubeApiServiceList; KubeApiServiceList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeApiServiceList; KubeApiServiceList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeApiServiceList; KubeApiServiceList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeApiServiceList; KubeApiServiceList.manifest(KubeApiServiceListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeApiServiceListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeBinding; KubeBinding.Builder.create(Construct scope, java.lang.String id) .target(ObjectReference) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | target | org.cdk8s.plus32.k8s.ObjectReference | The target object that you want to bind to the standard object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `target`^Required - *Type:* org.cdk8s.plus32.k8s.ObjectReference The target object that you want to bind to the standard object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeBinding; KubeBinding.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeBinding; KubeBinding.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeBinding; KubeBinding.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeBinding; KubeBinding.manifest(KubeBindingProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeBindingProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Binding". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeCertificateSigningRequest; KubeCertificateSigningRequest.Builder.create(Construct scope, java.lang.String id) .spec(CertificateSigningRequestSpec) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.CertificateSigningRequestSpec | spec contains the certificate request, and is immutable after creation. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | *No description.* | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeCertificateSigningRequest; KubeCertificateSigningRequest.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeCertificateSigningRequest; KubeCertificateSigningRequest.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeCertificateSigningRequest; KubeCertificateSigningRequest.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeCertificateSigningRequest; KubeCertificateSigningRequest.manifest(KubeCertificateSigningRequestProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeCertificateSigningRequestProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.certificates.v1.CertificateSigningRequest". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.certificates.v1.CertificateSigningRequest". --- ### KubeCertificateSigningRequestList CertificateSigningRequestList is a collection of CertificateSigningRequest objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeCertificateSigningRequestList; KubeCertificateSigningRequestList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is a collection of CertificateSigningRequest objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | *No description.* | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is a collection of CertificateSigningRequest objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeCertificateSigningRequestList; KubeCertificateSigningRequestList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeCertificateSigningRequestList; KubeCertificateSigningRequestList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeCertificateSigningRequestList; KubeCertificateSigningRequestList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeCertificateSigningRequestList; KubeCertificateSigningRequestList.manifest(KubeCertificateSigningRequestListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeCertificateSigningRequestListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.certificates.v1.CertificateSigningRequestList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeClusterRole; KubeClusterRole.Builder.create(Construct scope, java.lang.String id) // .aggregationRule(AggregationRule) // .metadata(ObjectMeta) // .rules(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | aggregationRule | org.cdk8s.plus32.k8s.AggregationRule | AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | rules | java.util.List | Rules holds all the PolicyRules for this ClusterRole. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `aggregationRule`^Optional - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. --- ##### `rules`^Optional - *Type:* java.util.List Rules holds all the PolicyRules for this ClusterRole. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeClusterRole; KubeClusterRole.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeClusterRole; KubeClusterRole.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeClusterRole; KubeClusterRole.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeClusterRole; KubeClusterRole.manifest(),KubeClusterRole.manifest(KubeClusterRoleProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeClusterRoleProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRole". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeClusterRoleBinding; KubeClusterRoleBinding.Builder.create(Construct scope, java.lang.String id) .roleRef(RoleRef) // .metadata(ObjectMeta) // .subjects(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | roleRef | org.cdk8s.plus32.k8s.RoleRef | RoleRef can only reference a ClusterRole in the global namespace. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | subjects | java.util.List | Subjects holds references to the objects the role applies to. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `roleRef`^Required - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. --- ##### `subjects`^Optional - *Type:* java.util.List Subjects holds references to the objects the role applies to. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeClusterRoleBinding; KubeClusterRoleBinding.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeClusterRoleBinding; KubeClusterRoleBinding.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeClusterRoleBinding; KubeClusterRoleBinding.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeClusterRoleBinding; KubeClusterRoleBinding.manifest(KubeClusterRoleBindingProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeClusterRoleBindingProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleBinding". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleBinding". --- ### KubeClusterRoleBindingList ClusterRoleBindingList is a collection of ClusterRoleBindings. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeClusterRoleBindingList; KubeClusterRoleBindingList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is a list of ClusterRoleBindings. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is a list of ClusterRoleBindings. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard object's metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeClusterRoleBindingList; KubeClusterRoleBindingList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeClusterRoleBindingList; KubeClusterRoleBindingList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeClusterRoleBindingList; KubeClusterRoleBindingList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeClusterRoleBindingList; KubeClusterRoleBindingList.manifest(KubeClusterRoleBindingListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeClusterRoleBindingListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleBindingList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleBindingList". --- ### KubeClusterRoleList ClusterRoleList is a collection of ClusterRoles. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeClusterRoleList; KubeClusterRoleList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is a list of ClusterRoles. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is a list of ClusterRoles. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard object's metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeClusterRoleList; KubeClusterRoleList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeClusterRoleList; KubeClusterRoleList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeClusterRoleList; KubeClusterRoleList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeClusterRoleList; KubeClusterRoleList.manifest(KubeClusterRoleListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeClusterRoleListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleList". --- ### KubeClusterTrustBundleListV1Alpha1 ClusterTrustBundleList is a collection of ClusterTrustBundle objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeClusterTrustBundleListV1Alpha1; KubeClusterTrustBundleListV1Alpha1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is a collection of ClusterTrustBundle objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | metadata contains the list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is a collection of ClusterTrustBundle objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta metadata contains the list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeClusterTrustBundleListV1Alpha1; KubeClusterTrustBundleListV1Alpha1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeClusterTrustBundleListV1Alpha1; KubeClusterTrustBundleListV1Alpha1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeClusterTrustBundleListV1Alpha1; KubeClusterTrustBundleListV1Alpha1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeClusterTrustBundleListV1Alpha1; KubeClusterTrustBundleListV1Alpha1.manifest(KubeClusterTrustBundleListV1Alpha1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeClusterTrustBundleListV1Alpha1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.certificates.v1alpha1.ClusterTrustBundleList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeClusterTrustBundleV1Alpha1; KubeClusterTrustBundleV1Alpha1.Builder.create(Construct scope, java.lang.String id) .spec(ClusterTrustBundleSpecV1Alpha1) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.ClusterTrustBundleSpecV1Alpha1 | spec contains the signer (if any) and trust anchors. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | metadata contains the object metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.ClusterTrustBundleSpecV1Alpha1 spec contains the signer (if any) and trust anchors. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta metadata contains the object metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeClusterTrustBundleV1Alpha1; KubeClusterTrustBundleV1Alpha1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeClusterTrustBundleV1Alpha1; KubeClusterTrustBundleV1Alpha1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeClusterTrustBundleV1Alpha1; KubeClusterTrustBundleV1Alpha1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeClusterTrustBundleV1Alpha1; KubeClusterTrustBundleV1Alpha1.manifest(KubeClusterTrustBundleV1Alpha1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeClusterTrustBundleV1Alpha1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.certificates.v1alpha1.ClusterTrustBundle". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeComponentStatus; KubeComponentStatus.Builder.create(Construct scope, java.lang.String id) // .conditions(java.util.List) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | conditions | java.util.List | List of component conditions observed. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `conditions`^Optional - *Type:* java.util.List List of component conditions observed. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeComponentStatus; KubeComponentStatus.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeComponentStatus; KubeComponentStatus.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeComponentStatus; KubeComponentStatus.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeComponentStatus; KubeComponentStatus.manifest(),KubeComponentStatus.manifest(KubeComponentStatusProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeComponentStatusProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ComponentStatus". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeComponentStatusList; KubeComponentStatusList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of ComponentStatus objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of ComponentStatus objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeComponentStatusList; KubeComponentStatusList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeComponentStatusList; KubeComponentStatusList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeComponentStatusList; KubeComponentStatusList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeComponentStatusList; KubeComponentStatusList.manifest(KubeComponentStatusListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeComponentStatusListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ComponentStatusList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.ComponentStatusList". --- ### KubeConfigMap ConfigMap holds configuration data for pods to consume. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeConfigMap; KubeConfigMap.Builder.create(Construct scope, java.lang.String id) // .binaryData(java.util.Map) // .data(java.util.Map) // .immutable(java.lang.Boolean) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | binaryData | java.util.Map | BinaryData contains the binary data. | | data | java.util.Map | Data contains the configuration data. | | immutable | java.lang.Boolean | Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `binaryData`^Optional - *Type:* java.util.Map 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 - *Type:* java.util.Map 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 - *Type:* java.lang.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeConfigMap; KubeConfigMap.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeConfigMap; KubeConfigMap.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeConfigMap; KubeConfigMap.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeConfigMap; KubeConfigMap.manifest(),KubeConfigMap.manifest(KubeConfigMapProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeConfigMapProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ConfigMap". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeConfigMapList; KubeConfigMapList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of ConfigMaps. | | metadata | org.cdk8s.plus32.k8s.ListMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of ConfigMaps. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeConfigMapList; KubeConfigMapList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeConfigMapList; KubeConfigMapList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeConfigMapList; KubeConfigMapList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeConfigMapList; KubeConfigMapList.manifest(KubeConfigMapListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeConfigMapListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ConfigMapList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeControllerRevision; KubeControllerRevision.Builder.create(Construct scope, java.lang.String id) .revision(java.lang.Number) // .data(java.lang.Object) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | revision | java.lang.Number | Revision indicates the revision of the state represented by Data. | | data | java.lang.Object | Data is the serialized representation of the state. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `revision`^Required - *Type:* java.lang.Number Revision indicates the revision of the state represented by Data. --- ##### `data`^Optional - *Type:* java.lang.Object Data is the serialized representation of the state. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeControllerRevision; KubeControllerRevision.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeControllerRevision; KubeControllerRevision.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeControllerRevision; KubeControllerRevision.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeControllerRevision; KubeControllerRevision.manifest(KubeControllerRevisionProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeControllerRevisionProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.ControllerRevision". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeControllerRevisionList; KubeControllerRevisionList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of ControllerRevisions. | | metadata | org.cdk8s.plus32.k8s.ListMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of ControllerRevisions. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeControllerRevisionList; KubeControllerRevisionList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeControllerRevisionList; KubeControllerRevisionList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeControllerRevisionList; KubeControllerRevisionList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeControllerRevisionList; KubeControllerRevisionList.manifest(KubeControllerRevisionListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeControllerRevisionListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.ControllerRevisionList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeCronJob; KubeCronJob.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(CronJobSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.CronJobSpec | Specification of the desired behavior of a cron job, including the schedule. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeCronJob; KubeCronJob.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeCronJob; KubeCronJob.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeCronJob; KubeCronJob.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeCronJob; KubeCronJob.manifest(),KubeCronJob.manifest(KubeCronJobProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeCronJobProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.batch.v1.CronJob". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.batch.v1.CronJob". --- ### KubeCronJobList CronJobList is a collection of cron jobs. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeCronJobList; KubeCronJobList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of CronJobs. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of CronJobs. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeCronJobList; KubeCronJobList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeCronJobList; KubeCronJobList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeCronJobList; KubeCronJobList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeCronJobList; KubeCronJobList.manifest(KubeCronJobListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeCronJobListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.batch.v1.CronJobList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeCsiDriver; KubeCsiDriver.Builder.create(Construct scope, java.lang.String id) .spec(CsiDriverSpec) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.CsiDriverSpec | spec represents the specification of the CSI Driver. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.CsiDriverSpec spec represents the specification of the CSI Driver. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeCsiDriver; KubeCsiDriver.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeCsiDriver; KubeCsiDriver.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeCsiDriver; KubeCsiDriver.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeCsiDriver; KubeCsiDriver.manifest(KubeCsiDriverProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeCsiDriverProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSIDriver". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSIDriver". --- ### KubeCsiDriverList CSIDriverList is a collection of CSIDriver objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeCsiDriverList; KubeCsiDriverList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of CSIDriver. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of CSIDriver. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeCsiDriverList; KubeCsiDriverList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeCsiDriverList; KubeCsiDriverList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeCsiDriverList; KubeCsiDriverList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeCsiDriverList; KubeCsiDriverList.manifest(KubeCsiDriverListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeCsiDriverListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSIDriverList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeCsiNode; KubeCsiNode.Builder.create(Construct scope, java.lang.String id) .spec(CsiNodeSpec) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.CsiNodeSpec | spec is the specification of CSINode. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.CsiNodeSpec spec is the specification of CSINode. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. metadata.name must be the Kubernetes node name. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeCsiNode; KubeCsiNode.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeCsiNode; KubeCsiNode.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeCsiNode; KubeCsiNode.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeCsiNode; KubeCsiNode.manifest(KubeCsiNodeProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeCsiNodeProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSINode". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSINode". --- ### KubeCsiNodeList CSINodeList is a collection of CSINode objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeCsiNodeList; KubeCsiNodeList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of CSINode. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of CSINode. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeCsiNodeList; KubeCsiNodeList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeCsiNodeList; KubeCsiNodeList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeCsiNodeList; KubeCsiNodeList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeCsiNodeList; KubeCsiNodeList.manifest(KubeCsiNodeListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeCsiNodeListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSINodeList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeCsiStorageCapacity; KubeCsiStorageCapacity.Builder.create(Construct scope, java.lang.String id) .storageClassName(java.lang.String) // .capacity(Quantity) // .maximumVolumeSize(Quantity) // .metadata(ObjectMeta) // .nodeTopology(LabelSelector) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | storageClassName | java.lang.String | storageClassName represents the name of the StorageClass that the reported capacity applies to. | | capacity | org.cdk8s.plus32.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 | org.cdk8s.plus32.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 | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | nodeTopology | org.cdk8s.plus32.k8s.LabelSelector | nodeTopology defines which nodes have access to the storage for which capacity was reported. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `storageClassName`^Required - *Type:* java.lang.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 - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeCsiStorageCapacity; KubeCsiStorageCapacity.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeCsiStorageCapacity; KubeCsiStorageCapacity.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeCsiStorageCapacity; KubeCsiStorageCapacity.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeCsiStorageCapacity; KubeCsiStorageCapacity.manifest(KubeCsiStorageCapacityProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeCsiStorageCapacityProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSIStorageCapacity". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSIStorageCapacity". --- ### KubeCsiStorageCapacityList CSIStorageCapacityList is a collection of CSIStorageCapacity objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeCsiStorageCapacityList; KubeCsiStorageCapacityList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of CSIStorageCapacity objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of CSIStorageCapacity objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeCsiStorageCapacityList; KubeCsiStorageCapacityList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeCsiStorageCapacityList; KubeCsiStorageCapacityList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeCsiStorageCapacityList; KubeCsiStorageCapacityList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeCsiStorageCapacityList; KubeCsiStorageCapacityList.manifest(KubeCsiStorageCapacityListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeCsiStorageCapacityListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSIStorageCapacityList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeCustomResourceDefinition; KubeCustomResourceDefinition.Builder.create(Construct scope, java.lang.String id) .spec(CustomResourceDefinitionSpec) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.CustomResourceDefinitionSpec | spec describes how the user wants the resources to appear. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.CustomResourceDefinitionSpec spec describes how the user wants the resources to appear. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is 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` ```java import org.cdk8s.plus32.k8s.KubeCustomResourceDefinition; KubeCustomResourceDefinition.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeCustomResourceDefinition; KubeCustomResourceDefinition.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeCustomResourceDefinition; KubeCustomResourceDefinition.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeCustomResourceDefinition; KubeCustomResourceDefinition.manifest(KubeCustomResourceDefinitionProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeCustomResourceDefinitionProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeCustomResourceDefinitionList; KubeCustomResourceDefinitionList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items list individual CustomResourceDefinition objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items list individual CustomResourceDefinition objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is 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` ```java import org.cdk8s.plus32.k8s.KubeCustomResourceDefinitionList; KubeCustomResourceDefinitionList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeCustomResourceDefinitionList; KubeCustomResourceDefinitionList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeCustomResourceDefinitionList; KubeCustomResourceDefinitionList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeCustomResourceDefinitionList; KubeCustomResourceDefinitionList.manifest(KubeCustomResourceDefinitionListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeCustomResourceDefinitionListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeDaemonSet; KubeDaemonSet.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(DaemonSetSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.DaemonSetSpec | The desired behavior of this daemon set. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeDaemonSet; KubeDaemonSet.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeDaemonSet; KubeDaemonSet.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeDaemonSet; KubeDaemonSet.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeDaemonSet; KubeDaemonSet.manifest(),KubeDaemonSet.manifest(KubeDaemonSetProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeDaemonSetProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.DaemonSet". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.apps.v1.DaemonSet". --- ### KubeDaemonSetList DaemonSetList is a collection of daemon sets. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeDaemonSetList; KubeDaemonSetList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | A list of daemon sets. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List A list of daemon sets. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeDaemonSetList; KubeDaemonSetList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeDaemonSetList; KubeDaemonSetList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeDaemonSetList; KubeDaemonSetList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeDaemonSetList; KubeDaemonSetList.manifest(KubeDaemonSetListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeDaemonSetListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.DaemonSetList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.apps.v1.DaemonSetList". --- ### KubeDeployment Deployment enables declarative updates for Pods and ReplicaSets. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeDeployment; KubeDeployment.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(DeploymentSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.DeploymentSpec | Specification of the desired behavior of the Deployment. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.DeploymentSpec Specification of the desired behavior of the Deployment. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeDeployment; KubeDeployment.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeDeployment; KubeDeployment.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeDeployment; KubeDeployment.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeDeployment; KubeDeployment.manifest(),KubeDeployment.manifest(KubeDeploymentProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeDeploymentProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.Deployment". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.apps.v1.Deployment". --- ### KubeDeploymentList DeploymentList is a list of Deployments. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeDeploymentList; KubeDeploymentList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of Deployments. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of Deployments. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeDeploymentList; KubeDeploymentList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeDeploymentList; KubeDeploymentList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeDeploymentList; KubeDeploymentList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeDeploymentList; KubeDeploymentList.manifest(KubeDeploymentListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeDeploymentListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.DeploymentList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.apps.v1.DeploymentList". --- ### KubeDeviceClassListV1Alpha3 DeviceClassList is a collection of classes. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeDeviceClassListV1Alpha3; KubeDeviceClassListV1Alpha3.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of resource classes. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of resource classes. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassListV1Alpha3; KubeDeviceClassListV1Alpha3.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassListV1Alpha3; KubeDeviceClassListV1Alpha3.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassListV1Alpha3; KubeDeviceClassListV1Alpha3.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassListV1Alpha3; KubeDeviceClassListV1Alpha3.manifest(KubeDeviceClassListV1Alpha3Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeDeviceClassListV1Alpha3Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.DeviceClassList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.DeviceClassList". --- ### KubeDeviceClassListV1Beta1 DeviceClassList is a collection of classes. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeDeviceClassListV1Beta1; KubeDeviceClassListV1Beta1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of resource classes. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of resource classes. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassListV1Beta1; KubeDeviceClassListV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassListV1Beta1; KubeDeviceClassListV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassListV1Beta1; KubeDeviceClassListV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassListV1Beta1; KubeDeviceClassListV1Beta1.manifest(KubeDeviceClassListV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeDeviceClassListV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.DeviceClassList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeDeviceClassV1Alpha3; KubeDeviceClassV1Alpha3.Builder.create(Construct scope, java.lang.String id) .spec(DeviceClassSpecV1Alpha3) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.DeviceClassSpecV1Alpha3 | Spec defines what can be allocated and how to configure it. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassV1Alpha3; KubeDeviceClassV1Alpha3.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassV1Alpha3; KubeDeviceClassV1Alpha3.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassV1Alpha3; KubeDeviceClassV1Alpha3.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassV1Alpha3; KubeDeviceClassV1Alpha3.manifest(KubeDeviceClassV1Alpha3Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeDeviceClassV1Alpha3Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.DeviceClass". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeDeviceClassV1Beta1; KubeDeviceClassV1Beta1.Builder.create(Construct scope, java.lang.String id) .spec(DeviceClassSpecV1Beta1) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.DeviceClassSpecV1Beta1 | Spec defines what can be allocated and how to configure it. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassV1Beta1; KubeDeviceClassV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassV1Beta1; KubeDeviceClassV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassV1Beta1; KubeDeviceClassV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeDeviceClassV1Beta1; KubeDeviceClassV1Beta1.manifest(KubeDeviceClassV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeDeviceClassV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.DeviceClass". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeEndpoints; KubeEndpoints.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .subsets(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | subsets | java.util.List | The set of all endpoints is the union of all subsets. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `subsets`^Optional - *Type:* java.util.List 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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeEndpoints; KubeEndpoints.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeEndpoints; KubeEndpoints.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeEndpoints; KubeEndpoints.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeEndpoints; KubeEndpoints.manifest(),KubeEndpoints.manifest(KubeEndpointsProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeEndpointsProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Endpoints". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeEndpointSlice; KubeEndpointSlice.Builder.create(Construct scope, java.lang.String id) .addressType(java.lang.String) .endpoints(java.util.List) // .metadata(ObjectMeta) // .ports(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | addressType | java.lang.String | addressType specifies the type of address carried by this EndpointSlice. | | endpoints | java.util.List | endpoints is a list of unique endpoints in this slice. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | ports | java.util.List | ports specifies the list of network ports exposed by each endpoint in this slice. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `addressType`^Required - *Type:* java.lang.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 - *Type:* java.util.List endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. --- ##### `ports`^Optional - *Type:* java.util.List 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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeEndpointSlice; KubeEndpointSlice.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeEndpointSlice; KubeEndpointSlice.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeEndpointSlice; KubeEndpointSlice.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeEndpointSlice; KubeEndpointSlice.manifest(KubeEndpointSliceProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeEndpointSliceProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.discovery.v1.EndpointSlice". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.discovery.v1.EndpointSlice". --- ### KubeEndpointSliceList EndpointSliceList represents a list of endpoint slices. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeEndpointSliceList; KubeEndpointSliceList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of endpoint slices. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of endpoint slices. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeEndpointSliceList; KubeEndpointSliceList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeEndpointSliceList; KubeEndpointSliceList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeEndpointSliceList; KubeEndpointSliceList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeEndpointSliceList; KubeEndpointSliceList.manifest(KubeEndpointSliceListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeEndpointSliceListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.discovery.v1.EndpointSliceList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.discovery.v1.EndpointSliceList". --- ### KubeEndpointsList EndpointsList is a list of endpoints. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeEndpointsList; KubeEndpointsList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of endpoints. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of endpoints. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeEndpointsList; KubeEndpointsList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeEndpointsList; KubeEndpointsList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeEndpointsList; KubeEndpointsList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeEndpointsList; KubeEndpointsList.manifest(KubeEndpointsListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeEndpointsListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.EndpointsList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeEvent; KubeEvent.Builder.create(Construct scope, java.lang.String id) .eventTime(java.time.Instant) // .action(java.lang.String) // .deprecatedCount(java.lang.Number) // .deprecatedFirstTimestamp(java.time.Instant) // .deprecatedLastTimestamp(java.time.Instant) // .deprecatedSource(EventSource) // .metadata(ObjectMeta) // .note(java.lang.String) // .reason(java.lang.String) // .regarding(ObjectReference) // .related(ObjectReference) // .reportingController(java.lang.String) // .reportingInstance(java.lang.String) // .series(EventSeries) // .type(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | eventTime | java.time.Instant | eventTime is the time when this Event was first observed. | | action | java.lang.String | action is what action was taken/failed regarding to the regarding object. | | deprecatedCount | java.lang.Number | deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. | | deprecatedFirstTimestamp | java.time.Instant | deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | | deprecatedLastTimestamp | java.time.Instant | deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | | deprecatedSource | org.cdk8s.plus32.k8s.EventSource | deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | note | java.lang.String | note is a human-readable description of the status of this operation. | | reason | java.lang.String | reason is why the action was taken. | | regarding | org.cdk8s.plus32.k8s.ObjectReference | regarding contains the object this Event is about. | | related | org.cdk8s.plus32.k8s.ObjectReference | related is the optional secondary object for more complex actions. | | reportingController | java.lang.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 | java.lang.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 | org.cdk8s.plus32.k8s.EventSeries | series is data about the Event series this event represents or nil if it's a singleton Event. | | type | java.lang.String | type is the type of this event (Normal, Warning), new types could be added in the future. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `eventTime`^Required - *Type:* java.time.Instant eventTime is the time when this Event was first observed. It is required. --- ##### `action`^Optional - *Type:* java.lang.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 - *Type:* java.lang.Number deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. --- ##### `deprecatedFirstTimestamp`^Optional - *Type:* java.time.Instant deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. --- ##### `deprecatedLastTimestamp`^Optional - *Type:* java.time.Instant deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. --- ##### `deprecatedSource`^Optional - *Type:* org.cdk8s.plus32.k8s.EventSource deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `note`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.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 - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* org.cdk8s.plus32.k8s.EventSeries series is data about the Event series this event represents or nil if it's a singleton Event. --- ##### `type`^Optional - *Type:* java.lang.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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeEvent; KubeEvent.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeEvent; KubeEvent.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeEvent; KubeEvent.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeEvent; KubeEvent.manifest(KubeEventProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeEventProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.events.v1.Event". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.events.v1.Event". --- ### KubeEventList EventList is a list of Event objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeEventList; KubeEventList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is a list of schema objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is a list of schema objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeEventList; KubeEventList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeEventList; KubeEventList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeEventList; KubeEventList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeEventList; KubeEventList.manifest(KubeEventListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeEventListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.events.v1.EventList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeEviction; KubeEviction.Builder.create(Construct scope, java.lang.String id) // .deleteOptions(DeleteOptions) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | deleteOptions | org.cdk8s.plus32.k8s.DeleteOptions | DeleteOptions may be provided. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | ObjectMeta describes the pod that is being evicted. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `deleteOptions`^Optional - *Type:* org.cdk8s.plus32.k8s.DeleteOptions DeleteOptions may be provided. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta ObjectMeta describes the pod that is being evicted. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeEviction; KubeEviction.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeEviction; KubeEviction.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeEviction; KubeEviction.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeEviction; KubeEviction.manifest(),KubeEviction.manifest(KubeEvictionProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeEvictionProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.policy.v1.Eviction". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeFlowSchema; KubeFlowSchema.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(FlowSchemaSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | `metadata` is the standard object's metadata. | | spec | org.cdk8s.plus32.k8s.FlowSchemaSpec | `spec` is the specification of the desired behavior of a FlowSchema. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeFlowSchema; KubeFlowSchema.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeFlowSchema; KubeFlowSchema.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeFlowSchema; KubeFlowSchema.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeFlowSchema; KubeFlowSchema.manifest(),KubeFlowSchema.manifest(KubeFlowSchemaProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeFlowSchemaProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1.FlowSchema". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1.FlowSchema". --- ### KubeFlowSchemaList FlowSchemaList is a list of FlowSchema objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeFlowSchemaList; KubeFlowSchemaList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | `items` is a list of FlowSchemas. | | metadata | org.cdk8s.plus32.k8s.ListMeta | `metadata` is the standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List `items` is a list of FlowSchemas. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeFlowSchemaList; KubeFlowSchemaList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeFlowSchemaList; KubeFlowSchemaList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeFlowSchemaList; KubeFlowSchemaList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeFlowSchemaList; KubeFlowSchemaList.manifest(KubeFlowSchemaListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeFlowSchemaListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1.FlowSchemaList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1.FlowSchemaList". --- ### KubeHorizontalPodAutoscaler configuration of a horizontal pod autoscaler. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscaler; KubeHorizontalPodAutoscaler.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(HorizontalPodAutoscalerSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata. | | spec | org.cdk8s.plus32.k8s.HorizontalPodAutoscalerSpec | spec defines the behaviour of autoscaler. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscaler; KubeHorizontalPodAutoscaler.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscaler; KubeHorizontalPodAutoscaler.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscaler; KubeHorizontalPodAutoscaler.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscaler; KubeHorizontalPodAutoscaler.manifest(),KubeHorizontalPodAutoscaler.manifest(KubeHorizontalPodAutoscalerProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler". --- ### KubeHorizontalPodAutoscalerList list of horizontal pod autoscaler objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerList; KubeHorizontalPodAutoscalerList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of horizontal pod autoscaler objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of horizontal pod autoscaler objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerList; KubeHorizontalPodAutoscalerList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerList; KubeHorizontalPodAutoscalerList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerList; KubeHorizontalPodAutoscalerList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerList; KubeHorizontalPodAutoscalerList.manifest(KubeHorizontalPodAutoscalerListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerListV2; KubeHorizontalPodAutoscalerListV2.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of horizontal pod autoscaler objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | metadata is the standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of horizontal pod autoscaler objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta metadata is the standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerListV2; KubeHorizontalPodAutoscalerListV2.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerListV2; KubeHorizontalPodAutoscalerListV2.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerListV2; KubeHorizontalPodAutoscalerListV2.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerListV2; KubeHorizontalPodAutoscalerListV2.manifest(KubeHorizontalPodAutoscalerListV2Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerListV2Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerV2; KubeHorizontalPodAutoscalerV2.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(HorizontalPodAutoscalerSpecV2) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | metadata is the standard object metadata. | | spec | org.cdk8s.plus32.k8s.HorizontalPodAutoscalerSpecV2 | spec is the specification for the behaviour of the autoscaler. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerV2; KubeHorizontalPodAutoscalerV2.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerV2; KubeHorizontalPodAutoscalerV2.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerV2; KubeHorizontalPodAutoscalerV2.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerV2; KubeHorizontalPodAutoscalerV2.manifest(),KubeHorizontalPodAutoscalerV2.manifest(KubeHorizontalPodAutoscalerV2Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeHorizontalPodAutoscalerV2Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2.HorizontalPodAutoscaler". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeIngress; KubeIngress.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(IngressSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.IngressSpec | spec is the desired state of the Ingress. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeIngress; KubeIngress.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeIngress; KubeIngress.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeIngress; KubeIngress.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeIngress; KubeIngress.manifest(),KubeIngress.manifest(KubeIngressProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeIngressProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1.Ingress". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeIngressClass; KubeIngressClass.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(IngressClassSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.IngressClassSpec | spec is the desired state of the IngressClass. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeIngressClass; KubeIngressClass.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeIngressClass; KubeIngressClass.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeIngressClass; KubeIngressClass.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeIngressClass; KubeIngressClass.manifest(),KubeIngressClass.manifest(KubeIngressClassProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeIngressClassProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressClass". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressClass". --- ### KubeIngressClassList IngressClassList is a collection of IngressClasses. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeIngressClassList; KubeIngressClassList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of IngressClasses. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of IngressClasses. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeIngressClassList; KubeIngressClassList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeIngressClassList; KubeIngressClassList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeIngressClassList; KubeIngressClassList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeIngressClassList; KubeIngressClassList.manifest(KubeIngressClassListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeIngressClassListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressClassList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressClassList". --- ### KubeIngressList IngressList is a collection of Ingress. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeIngressList; KubeIngressList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of Ingress. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of Ingress. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeIngressList; KubeIngressList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeIngressList; KubeIngressList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeIngressList; KubeIngressList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeIngressList; KubeIngressList.manifest(KubeIngressListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeIngressListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressList". --- ### KubeIpAddressListV1Beta1 IPAddressList contains a list of IPAddress. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeIpAddressListV1Beta1; KubeIpAddressListV1Beta1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of IPAddresses. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of IPAddresses. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeIpAddressListV1Beta1; KubeIpAddressListV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeIpAddressListV1Beta1; KubeIpAddressListV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeIpAddressListV1Beta1; KubeIpAddressListV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeIpAddressListV1Beta1; KubeIpAddressListV1Beta1.manifest(KubeIpAddressListV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeIpAddressListV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.IPAddressList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeIpAddressV1Beta1; KubeIpAddressV1Beta1.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(IpAddressSpecV1Beta1) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.IpAddressSpecV1Beta1 | spec is the desired state of the IPAddress. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeIpAddressV1Beta1; KubeIpAddressV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeIpAddressV1Beta1; KubeIpAddressV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeIpAddressV1Beta1; KubeIpAddressV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeIpAddressV1Beta1; KubeIpAddressV1Beta1.manifest(),KubeIpAddressV1Beta1.manifest(KubeIpAddressV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeIpAddressV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.IPAddress". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.IPAddress". --- ### KubeJob Job represents the configuration of a single job. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeJob; KubeJob.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(JobSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.JobSpec | Specification of the desired behavior of a job. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeJob; KubeJob.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeJob; KubeJob.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeJob; KubeJob.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeJob; KubeJob.manifest(),KubeJob.manifest(KubeJobProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeJobProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.batch.v1.Job". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.batch.v1.Job". --- ### KubeJobList JobList is a collection of jobs. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeJobList; KubeJobList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of Jobs. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of Jobs. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeJobList; KubeJobList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeJobList; KubeJobList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeJobList; KubeJobList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeJobList; KubeJobList.manifest(KubeJobListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeJobListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.batch.v1.JobList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.batch.v1.JobList". --- ### KubeLease Lease defines a lease concept. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeLease; KubeLease.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(LeaseSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | | spec | org.cdk8s.plus32.k8s.LeaseSpec | spec contains the specification of the Lease. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeLease; KubeLease.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeLease; KubeLease.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeLease; KubeLease.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeLease; KubeLease.manifest(),KubeLease.manifest(KubeLeaseProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeLeaseProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.coordination.v1.Lease". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.coordination.v1.Lease". --- ### KubeLeaseCandidateListV1Alpha2 LeaseCandidateList is a list of Lease objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeLeaseCandidateListV1Alpha2; KubeLeaseCandidateListV1Alpha2.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is a list of schema objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is a list of schema objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeLeaseCandidateListV1Alpha2; KubeLeaseCandidateListV1Alpha2.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeLeaseCandidateListV1Alpha2; KubeLeaseCandidateListV1Alpha2.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeLeaseCandidateListV1Alpha2; KubeLeaseCandidateListV1Alpha2.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeLeaseCandidateListV1Alpha2; KubeLeaseCandidateListV1Alpha2.manifest(KubeLeaseCandidateListV1Alpha2Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeLeaseCandidateListV1Alpha2Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.coordination.v1alpha2.LeaseCandidateList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeLeaseCandidateV1Alpha2; KubeLeaseCandidateV1Alpha2.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(LeaseCandidateSpecV1Alpha2) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | | spec | org.cdk8s.plus32.k8s.LeaseCandidateSpecV1Alpha2 | spec contains the specification of the Lease. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeLeaseCandidateV1Alpha2; KubeLeaseCandidateV1Alpha2.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeLeaseCandidateV1Alpha2; KubeLeaseCandidateV1Alpha2.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeLeaseCandidateV1Alpha2; KubeLeaseCandidateV1Alpha2.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeLeaseCandidateV1Alpha2; KubeLeaseCandidateV1Alpha2.manifest(),KubeLeaseCandidateV1Alpha2.manifest(KubeLeaseCandidateV1Alpha2Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeLeaseCandidateV1Alpha2Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.coordination.v1alpha2.LeaseCandidate". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.coordination.v1alpha2.LeaseCandidate". --- ### KubeLeaseList LeaseList is a list of Lease objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeLeaseList; KubeLeaseList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is a list of schema objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is a list of schema objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeLeaseList; KubeLeaseList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeLeaseList; KubeLeaseList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeLeaseList; KubeLeaseList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeLeaseList; KubeLeaseList.manifest(KubeLeaseListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeLeaseListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.coordination.v1.LeaseList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeLimitRange; KubeLimitRange.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(LimitRangeSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.LimitRangeSpec | Spec defines the limits enforced. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.LimitRangeSpec Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeLimitRange; KubeLimitRange.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeLimitRange; KubeLimitRange.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeLimitRange; KubeLimitRange.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeLimitRange; KubeLimitRange.manifest(),KubeLimitRange.manifest(KubeLimitRangeProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeLimitRangeProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.LimitRange". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.LimitRange". --- ### KubeLimitRangeList LimitRangeList is a list of LimitRange items. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeLimitRangeList; KubeLimitRangeList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is a list of LimitRange objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeLimitRangeList; KubeLimitRangeList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeLimitRangeList; KubeLimitRangeList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeLimitRangeList; KubeLimitRangeList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeLimitRangeList; KubeLimitRangeList.manifest(KubeLimitRangeListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeLimitRangeListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.LimitRangeList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeLocalSubjectAccessReview; KubeLocalSubjectAccessReview.Builder.create(Construct scope, java.lang.String id) .spec(SubjectAccessReviewSpec) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.SubjectAccessReviewSpec | Spec holds information about the request being evaluated. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeLocalSubjectAccessReview; KubeLocalSubjectAccessReview.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeLocalSubjectAccessReview; KubeLocalSubjectAccessReview.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeLocalSubjectAccessReview; KubeLocalSubjectAccessReview.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeLocalSubjectAccessReview; KubeLocalSubjectAccessReview.manifest(KubeLocalSubjectAccessReviewProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeLocalSubjectAccessReviewProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authorization.v1.LocalSubjectAccessReview". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.authorization.v1.LocalSubjectAccessReview". --- ### KubeMutatingAdmissionPolicyBindingListV1Alpha1 MutatingAdmissionPolicyBindingList is a list of MutatingAdmissionPolicyBinding. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1; KubeMutatingAdmissionPolicyBindingListV1Alpha1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of PolicyBinding. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of PolicyBinding. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1; KubeMutatingAdmissionPolicyBindingListV1Alpha1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1; KubeMutatingAdmissionPolicyBindingListV1Alpha1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1; KubeMutatingAdmissionPolicyBindingListV1Alpha1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1; KubeMutatingAdmissionPolicyBindingListV1Alpha1.manifest(KubeMutatingAdmissionPolicyBindingListV1Alpha1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBindingList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1; KubeMutatingAdmissionPolicyBindingV1Alpha1.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(MutatingAdmissionPolicyBindingSpecV1Alpha1) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata; | | spec | org.cdk8s.plus32.k8s.MutatingAdmissionPolicyBindingSpecV1Alpha1 | Specification of the desired behavior of the MutatingAdmissionPolicyBinding. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.MutatingAdmissionPolicyBindingSpecV1Alpha1 Specification of the desired behavior of the MutatingAdmissionPolicyBinding. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1; KubeMutatingAdmissionPolicyBindingV1Alpha1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1; KubeMutatingAdmissionPolicyBindingV1Alpha1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1; KubeMutatingAdmissionPolicyBindingV1Alpha1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1; KubeMutatingAdmissionPolicyBindingV1Alpha1.manifest(),KubeMutatingAdmissionPolicyBindingV1Alpha1.manifest(KubeMutatingAdmissionPolicyBindingV1Alpha1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBinding". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBinding". --- ### KubeMutatingAdmissionPolicyListV1Alpha1 MutatingAdmissionPolicyList is a list of MutatingAdmissionPolicy. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyListV1Alpha1; KubeMutatingAdmissionPolicyListV1Alpha1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of ValidatingAdmissionPolicy. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of ValidatingAdmissionPolicy. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyListV1Alpha1; KubeMutatingAdmissionPolicyListV1Alpha1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyListV1Alpha1; KubeMutatingAdmissionPolicyListV1Alpha1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyListV1Alpha1; KubeMutatingAdmissionPolicyListV1Alpha1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyListV1Alpha1; KubeMutatingAdmissionPolicyListV1Alpha1.manifest(KubeMutatingAdmissionPolicyListV1Alpha1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyListV1Alpha1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyV1Alpha1; KubeMutatingAdmissionPolicyV1Alpha1.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(MutatingAdmissionPolicySpecV1Alpha1) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata; | | spec | org.cdk8s.plus32.k8s.MutatingAdmissionPolicySpecV1Alpha1 | Specification of the desired behavior of the MutatingAdmissionPolicy. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.MutatingAdmissionPolicySpecV1Alpha1 Specification of the desired behavior of the MutatingAdmissionPolicy. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyV1Alpha1; KubeMutatingAdmissionPolicyV1Alpha1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyV1Alpha1; KubeMutatingAdmissionPolicyV1Alpha1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyV1Alpha1; KubeMutatingAdmissionPolicyV1Alpha1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyV1Alpha1; KubeMutatingAdmissionPolicyV1Alpha1.manifest(),KubeMutatingAdmissionPolicyV1Alpha1.manifest(KubeMutatingAdmissionPolicyV1Alpha1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeMutatingAdmissionPolicyV1Alpha1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicy". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeMutatingWebhookConfiguration; KubeMutatingWebhookConfiguration.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .webhooks(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata; | | webhooks | java.util.List | Webhooks is a list of webhooks and the affected resources and operations. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `webhooks`^Optional - *Type:* java.util.List Webhooks is a list of webhooks and the affected resources and operations. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeMutatingWebhookConfiguration; KubeMutatingWebhookConfiguration.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeMutatingWebhookConfiguration; KubeMutatingWebhookConfiguration.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeMutatingWebhookConfiguration; KubeMutatingWebhookConfiguration.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeMutatingWebhookConfiguration; KubeMutatingWebhookConfiguration.manifest(),KubeMutatingWebhookConfiguration.manifest(KubeMutatingWebhookConfigurationProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeMutatingWebhookConfigurationProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration". --- ### KubeMutatingWebhookConfigurationList MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeMutatingWebhookConfigurationList; KubeMutatingWebhookConfigurationList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of MutatingWebhookConfiguration. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of MutatingWebhookConfiguration. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeMutatingWebhookConfigurationList; KubeMutatingWebhookConfigurationList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeMutatingWebhookConfigurationList; KubeMutatingWebhookConfigurationList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeMutatingWebhookConfigurationList; KubeMutatingWebhookConfigurationList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeMutatingWebhookConfigurationList; KubeMutatingWebhookConfigurationList.manifest(KubeMutatingWebhookConfigurationListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeMutatingWebhookConfigurationListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeNamespace; KubeNamespace.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(NamespaceSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.NamespaceSpec | Spec defines the behavior of the Namespace. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeNamespace; KubeNamespace.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeNamespace; KubeNamespace.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeNamespace; KubeNamespace.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeNamespace; KubeNamespace.manifest(),KubeNamespace.manifest(KubeNamespaceProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeNamespaceProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Namespace". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.Namespace". --- ### KubeNamespaceList NamespaceList is a list of Namespaces. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeNamespaceList; KubeNamespaceList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of Namespace objects in the list. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeNamespaceList; KubeNamespaceList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeNamespaceList; KubeNamespaceList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeNamespaceList; KubeNamespaceList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeNamespaceList; KubeNamespaceList.manifest(KubeNamespaceListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeNamespaceListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.NamespaceList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeNetworkPolicy; KubeNetworkPolicy.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(NetworkPolicySpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.NetworkPolicySpec | spec represents the specification of the desired behavior for this NetworkPolicy. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.NetworkPolicySpec spec represents the specification of the desired behavior for this NetworkPolicy. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeNetworkPolicy; KubeNetworkPolicy.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeNetworkPolicy; KubeNetworkPolicy.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeNetworkPolicy; KubeNetworkPolicy.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeNetworkPolicy; KubeNetworkPolicy.manifest(),KubeNetworkPolicy.manifest(KubeNetworkPolicyProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeNetworkPolicyProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1.NetworkPolicy". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.networking.v1.NetworkPolicy". --- ### KubeNetworkPolicyList NetworkPolicyList is a list of NetworkPolicy objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeNetworkPolicyList; KubeNetworkPolicyList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is a list of schema objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is a list of schema objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeNetworkPolicyList; KubeNetworkPolicyList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeNetworkPolicyList; KubeNetworkPolicyList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeNetworkPolicyList; KubeNetworkPolicyList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeNetworkPolicyList; KubeNetworkPolicyList.manifest(KubeNetworkPolicyListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeNetworkPolicyListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1.NetworkPolicyList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeNode; KubeNode.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(NodeSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.NodeSpec | Spec defines the behavior of a node. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.NodeSpec Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeNode; KubeNode.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeNode; KubeNode.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeNode; KubeNode.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeNode; KubeNode.manifest(),KubeNode.manifest(KubeNodeProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeNodeProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Node". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeNodeList; KubeNodeList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of nodes. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of nodes. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeNodeList; KubeNodeList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeNodeList; KubeNodeList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeNodeList; KubeNodeList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeNodeList; KubeNodeList.manifest(KubeNodeListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeNodeListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.NodeList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubePersistentVolume; KubePersistentVolume.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(PersistentVolumeSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.PersistentVolumeSpec | spec defines a specification of a persistent volume owned by the cluster. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePersistentVolume; KubePersistentVolume.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePersistentVolume; KubePersistentVolume.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePersistentVolume; KubePersistentVolume.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePersistentVolume; KubePersistentVolume.manifest(),KubePersistentVolume.manifest(KubePersistentVolumeProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePersistentVolumeProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolume". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeClaim; KubePersistentVolumeClaim.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(PersistentVolumeClaimSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.PersistentVolumeClaimSpec | spec defines the desired characteristics of a volume requested by a pod author. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeClaim; KubePersistentVolumeClaim.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeClaim; KubePersistentVolumeClaim.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeClaim; KubePersistentVolumeClaim.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeClaim; KubePersistentVolumeClaim.manifest(),KubePersistentVolumeClaim.manifest(KubePersistentVolumeClaimProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePersistentVolumeClaimProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeClaim". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeClaim". --- ### KubePersistentVolumeClaimList PersistentVolumeClaimList is a list of PersistentVolumeClaim items. #### Initializers ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeClaimList; KubePersistentVolumeClaimList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is a list of persistent volume claims. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is a list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeClaimList; KubePersistentVolumeClaimList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeClaimList; KubePersistentVolumeClaimList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeClaimList; KubePersistentVolumeClaimList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeClaimList; KubePersistentVolumeClaimList.manifest(KubePersistentVolumeClaimListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePersistentVolumeClaimListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeClaimList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeClaimList". --- ### KubePersistentVolumeList PersistentVolumeList is a list of PersistentVolume items. #### Initializers ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeList; KubePersistentVolumeList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is a list of persistent volumes. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is a list of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeList; KubePersistentVolumeList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeList; KubePersistentVolumeList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeList; KubePersistentVolumeList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePersistentVolumeList; KubePersistentVolumeList.manifest(KubePersistentVolumeListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePersistentVolumeListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubePod; KubePod.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(PodSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.PodSpec | Specification of the desired behavior of the pod. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePod; KubePod.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePod; KubePod.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePod; KubePod.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePod; KubePod.manifest(),KubePod.manifest(KubePodProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePodProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Pod". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubePodDisruptionBudget; KubePodDisruptionBudget.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(PodDisruptionBudgetSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.PodDisruptionBudgetSpec | Specification of the desired behavior of the PodDisruptionBudget. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.PodDisruptionBudgetSpec Specification of the desired behavior of the PodDisruptionBudget. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePodDisruptionBudget; KubePodDisruptionBudget.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePodDisruptionBudget; KubePodDisruptionBudget.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePodDisruptionBudget; KubePodDisruptionBudget.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePodDisruptionBudget; KubePodDisruptionBudget.manifest(),KubePodDisruptionBudget.manifest(KubePodDisruptionBudgetProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePodDisruptionBudgetProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.policy.v1.PodDisruptionBudget". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.policy.v1.PodDisruptionBudget". --- ### KubePodDisruptionBudgetList PodDisruptionBudgetList is a collection of PodDisruptionBudgets. #### Initializers ```java import org.cdk8s.plus32.k8s.KubePodDisruptionBudgetList; KubePodDisruptionBudgetList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is a list of PodDisruptionBudgets. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is a list of PodDisruptionBudgets. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePodDisruptionBudgetList; KubePodDisruptionBudgetList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePodDisruptionBudgetList; KubePodDisruptionBudgetList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePodDisruptionBudgetList; KubePodDisruptionBudgetList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePodDisruptionBudgetList; KubePodDisruptionBudgetList.manifest(KubePodDisruptionBudgetListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePodDisruptionBudgetListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.policy.v1.PodDisruptionBudgetList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.policy.v1.PodDisruptionBudgetList". --- ### KubePodList PodList is a list of Pods. #### Initializers ```java import org.cdk8s.plus32.k8s.KubePodList; KubePodList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of pods. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePodList; KubePodList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePodList; KubePodList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePodList; KubePodList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePodList; KubePodList.manifest(KubePodListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePodListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PodList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubePodTemplate; KubePodTemplate.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .template(PodTemplateSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | template | org.cdk8s.plus32.k8s.PodTemplateSpec | Template defines the pods that will be created from this pod template. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `template`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePodTemplate; KubePodTemplate.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePodTemplate; KubePodTemplate.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePodTemplate; KubePodTemplate.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePodTemplate; KubePodTemplate.manifest(),KubePodTemplate.manifest(KubePodTemplateProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePodTemplateProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PodTemplate". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.PodTemplate". --- ### KubePodTemplateList PodTemplateList is a list of PodTemplates. #### Initializers ```java import org.cdk8s.plus32.k8s.KubePodTemplateList; KubePodTemplateList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of pod templates. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of pod templates. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePodTemplateList; KubePodTemplateList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePodTemplateList; KubePodTemplateList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePodTemplateList; KubePodTemplateList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePodTemplateList; KubePodTemplateList.manifest(KubePodTemplateListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePodTemplateListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PodTemplateList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubePriorityClass; KubePriorityClass.Builder.create(Construct scope, java.lang.String id) .value(java.lang.Number) // .description(java.lang.String) // .globalDefault(java.lang.Boolean) // .metadata(ObjectMeta) // .preemptionPolicy(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | value | java.lang.Number | value represents the integer value of this priority class. | | description | java.lang.String | description is an arbitrary string that usually provides guidelines on when this priority class should be used. | | globalDefault | java.lang.Boolean | globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | preemptionPolicy | java.lang.String | preemptionPolicy is the Policy for preempting pods with lower priority. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `value`^Required - *Type:* java.lang.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 - *Type:* java.lang.String description is an arbitrary string that usually provides guidelines on when this priority class should be used. --- ##### `globalDefault`^Optional - *Type:* java.lang.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `preemptionPolicy`^Optional - *Type:* java.lang.String - *Default:* PreemptLowerPriority if unset. preemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePriorityClass; KubePriorityClass.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePriorityClass; KubePriorityClass.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePriorityClass; KubePriorityClass.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePriorityClass; KubePriorityClass.manifest(KubePriorityClassProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePriorityClassProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.scheduling.v1.PriorityClass". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.scheduling.v1.PriorityClass". --- ### KubePriorityClassList PriorityClassList is a collection of priority classes. #### Initializers ```java import org.cdk8s.plus32.k8s.KubePriorityClassList; KubePriorityClassList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of PriorityClasses. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of PriorityClasses. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePriorityClassList; KubePriorityClassList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePriorityClassList; KubePriorityClassList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePriorityClassList; KubePriorityClassList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePriorityClassList; KubePriorityClassList.manifest(KubePriorityClassListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePriorityClassListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.scheduling.v1.PriorityClassList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.scheduling.v1.PriorityClassList". --- ### KubePriorityLevelConfiguration PriorityLevelConfiguration represents the configuration of a priority level. #### Initializers ```java import org.cdk8s.plus32.k8s.KubePriorityLevelConfiguration; KubePriorityLevelConfiguration.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(PriorityLevelConfigurationSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | `metadata` is the standard object's metadata. | | spec | org.cdk8s.plus32.k8s.PriorityLevelConfigurationSpec | `spec` is the specification of the desired behavior of a "request-priority". | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePriorityLevelConfiguration; KubePriorityLevelConfiguration.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePriorityLevelConfiguration; KubePriorityLevelConfiguration.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePriorityLevelConfiguration; KubePriorityLevelConfiguration.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePriorityLevelConfiguration; KubePriorityLevelConfiguration.manifest(),KubePriorityLevelConfiguration.manifest(KubePriorityLevelConfigurationProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePriorityLevelConfigurationProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1.PriorityLevelConfiguration". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1.PriorityLevelConfiguration". --- ### KubePriorityLevelConfigurationList PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubePriorityLevelConfigurationList; KubePriorityLevelConfigurationList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | `items` is a list of request-priorities. | | metadata | org.cdk8s.plus32.k8s.ListMeta | `metadata` is the standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List `items` is a list of request-priorities. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubePriorityLevelConfigurationList; KubePriorityLevelConfigurationList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubePriorityLevelConfigurationList; KubePriorityLevelConfigurationList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubePriorityLevelConfigurationList; KubePriorityLevelConfigurationList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubePriorityLevelConfigurationList; KubePriorityLevelConfigurationList.manifest(KubePriorityLevelConfigurationListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubePriorityLevelConfigurationListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1.PriorityLevelConfigurationList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeReplicaSet; KubeReplicaSet.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(ReplicaSetSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.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 | org.cdk8s.plus32.k8s.ReplicaSetSpec | Spec defines the specification of the desired behavior of the ReplicaSet. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeReplicaSet; KubeReplicaSet.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeReplicaSet; KubeReplicaSet.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeReplicaSet; KubeReplicaSet.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeReplicaSet; KubeReplicaSet.manifest(),KubeReplicaSet.manifest(KubeReplicaSetProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeReplicaSetProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.ReplicaSet". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.apps.v1.ReplicaSet". --- ### KubeReplicaSetList ReplicaSetList is a collection of ReplicaSets. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeReplicaSetList; KubeReplicaSetList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of ReplicaSets. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeReplicaSetList; KubeReplicaSetList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeReplicaSetList; KubeReplicaSetList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeReplicaSetList; KubeReplicaSetList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeReplicaSetList; KubeReplicaSetList.manifest(KubeReplicaSetListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeReplicaSetListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.ReplicaSetList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.apps.v1.ReplicaSetList". --- ### KubeReplicationController ReplicationController represents the configuration of a replication controller. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeReplicationController; KubeReplicationController.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(ReplicationControllerSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.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 | org.cdk8s.plus32.k8s.ReplicationControllerSpec | Spec defines the specification of the desired behavior of the replication controller. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeReplicationController; KubeReplicationController.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeReplicationController; KubeReplicationController.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeReplicationController; KubeReplicationController.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeReplicationController; KubeReplicationController.manifest(),KubeReplicationController.manifest(KubeReplicationControllerProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeReplicationControllerProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ReplicationController". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.ReplicationController". --- ### KubeReplicationControllerList ReplicationControllerList is a collection of replication controllers. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeReplicationControllerList; KubeReplicationControllerList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of replication controllers. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeReplicationControllerList; KubeReplicationControllerList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeReplicationControllerList; KubeReplicationControllerList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeReplicationControllerList; KubeReplicationControllerList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeReplicationControllerList; KubeReplicationControllerList.manifest(KubeReplicationControllerListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeReplicationControllerListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ReplicationControllerList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.ReplicationControllerList". --- ### KubeResourceClaimListV1Alpha3 ResourceClaimList is a collection of claims. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeResourceClaimListV1Alpha3; KubeResourceClaimListV1Alpha3.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of resource claims. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of resource claims. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimListV1Alpha3; KubeResourceClaimListV1Alpha3.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimListV1Alpha3; KubeResourceClaimListV1Alpha3.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimListV1Alpha3; KubeResourceClaimListV1Alpha3.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimListV1Alpha3; KubeResourceClaimListV1Alpha3.manifest(KubeResourceClaimListV1Alpha3Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceClaimListV1Alpha3Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceClaimList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceClaimList". --- ### KubeResourceClaimListV1Beta1 ResourceClaimList is a collection of claims. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeResourceClaimListV1Beta1; KubeResourceClaimListV1Beta1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of resource claims. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of resource claims. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimListV1Beta1; KubeResourceClaimListV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimListV1Beta1; KubeResourceClaimListV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimListV1Beta1; KubeResourceClaimListV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimListV1Beta1; KubeResourceClaimListV1Beta1.manifest(KubeResourceClaimListV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceClaimListV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceClaimList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceClaimList". --- ### KubeResourceClaimTemplateListV1Alpha3 ResourceClaimTemplateList is a collection of claim templates. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateListV1Alpha3; KubeResourceClaimTemplateListV1Alpha3.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of resource claim templates. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of resource claim templates. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateListV1Alpha3; KubeResourceClaimTemplateListV1Alpha3.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateListV1Alpha3; KubeResourceClaimTemplateListV1Alpha3.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateListV1Alpha3; KubeResourceClaimTemplateListV1Alpha3.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateListV1Alpha3; KubeResourceClaimTemplateListV1Alpha3.manifest(KubeResourceClaimTemplateListV1Alpha3Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceClaimTemplateListV1Alpha3Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceClaimTemplateList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceClaimTemplateList". --- ### KubeResourceClaimTemplateListV1Beta1 ResourceClaimTemplateList is a collection of claim templates. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateListV1Beta1; KubeResourceClaimTemplateListV1Beta1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of resource claim templates. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of resource claim templates. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateListV1Beta1; KubeResourceClaimTemplateListV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateListV1Beta1; KubeResourceClaimTemplateListV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateListV1Beta1; KubeResourceClaimTemplateListV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateListV1Beta1; KubeResourceClaimTemplateListV1Beta1.manifest(KubeResourceClaimTemplateListV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceClaimTemplateListV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceClaimTemplateList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateV1Alpha3; KubeResourceClaimTemplateV1Alpha3.Builder.create(Construct scope, java.lang.String id) .spec(ResourceClaimTemplateSpecV1Alpha3) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.ResourceClaimTemplateSpecV1Alpha3 | Describes the ResourceClaim that is to be generated. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateV1Alpha3; KubeResourceClaimTemplateV1Alpha3.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateV1Alpha3; KubeResourceClaimTemplateV1Alpha3.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateV1Alpha3; KubeResourceClaimTemplateV1Alpha3.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateV1Alpha3; KubeResourceClaimTemplateV1Alpha3.manifest(KubeResourceClaimTemplateV1Alpha3Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceClaimTemplateV1Alpha3Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceClaimTemplate". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateV1Beta1; KubeResourceClaimTemplateV1Beta1.Builder.create(Construct scope, java.lang.String id) .spec(ResourceClaimTemplateSpecV1Beta1) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.ResourceClaimTemplateSpecV1Beta1 | Describes the ResourceClaim that is to be generated. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateV1Beta1; KubeResourceClaimTemplateV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateV1Beta1; KubeResourceClaimTemplateV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateV1Beta1; KubeResourceClaimTemplateV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimTemplateV1Beta1; KubeResourceClaimTemplateV1Beta1.manifest(KubeResourceClaimTemplateV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceClaimTemplateV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceClaimTemplate". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeResourceClaimV1Alpha3; KubeResourceClaimV1Alpha3.Builder.create(Construct scope, java.lang.String id) .spec(ResourceClaimSpecV1Alpha3) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.ResourceClaimSpecV1Alpha3 | Spec describes what is being requested and how to configure it. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.ResourceClaimSpecV1Alpha3 Spec describes what is being requested and how to configure it. The spec is immutable. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimV1Alpha3; KubeResourceClaimV1Alpha3.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimV1Alpha3; KubeResourceClaimV1Alpha3.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimV1Alpha3; KubeResourceClaimV1Alpha3.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimV1Alpha3; KubeResourceClaimV1Alpha3.manifest(KubeResourceClaimV1Alpha3Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceClaimV1Alpha3Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceClaim". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeResourceClaimV1Beta1; KubeResourceClaimV1Beta1.Builder.create(Construct scope, java.lang.String id) .spec(ResourceClaimSpecV1Beta1) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.ResourceClaimSpecV1Beta1 | Spec describes what is being requested and how to configure it. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.ResourceClaimSpecV1Beta1 Spec describes what is being requested and how to configure it. The spec is immutable. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimV1Beta1; KubeResourceClaimV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimV1Beta1; KubeResourceClaimV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimV1Beta1; KubeResourceClaimV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceClaimV1Beta1; KubeResourceClaimV1Beta1.manifest(KubeResourceClaimV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceClaimV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceClaim". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceClaim". --- ### KubeResourceQuota ResourceQuota sets aggregate quota restrictions enforced per namespace. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeResourceQuota; KubeResourceQuota.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(ResourceQuotaSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.ResourceQuotaSpec | Spec defines the desired quota. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.ResourceQuotaSpec Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceQuota; KubeResourceQuota.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceQuota; KubeResourceQuota.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceQuota; KubeResourceQuota.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceQuota; KubeResourceQuota.manifest(),KubeResourceQuota.manifest(KubeResourceQuotaProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceQuotaProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ResourceQuota". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.ResourceQuota". --- ### KubeResourceQuotaList ResourceQuotaList is a list of ResourceQuota items. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeResourceQuotaList; KubeResourceQuotaList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is a list of ResourceQuota objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceQuotaList; KubeResourceQuotaList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceQuotaList; KubeResourceQuotaList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceQuotaList; KubeResourceQuotaList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceQuotaList; KubeResourceQuotaList.manifest(KubeResourceQuotaListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceQuotaListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ResourceQuotaList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.ResourceQuotaList". --- ### KubeResourceSliceListV1Alpha3 ResourceSliceList is a collection of ResourceSlices. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeResourceSliceListV1Alpha3; KubeResourceSliceListV1Alpha3.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of resource ResourceSlices. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of resource ResourceSlices. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceListV1Alpha3; KubeResourceSliceListV1Alpha3.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceListV1Alpha3; KubeResourceSliceListV1Alpha3.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceListV1Alpha3; KubeResourceSliceListV1Alpha3.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceListV1Alpha3; KubeResourceSliceListV1Alpha3.manifest(KubeResourceSliceListV1Alpha3Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceSliceListV1Alpha3Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceSliceList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceSliceList". --- ### KubeResourceSliceListV1Beta1 ResourceSliceList is a collection of ResourceSlices. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeResourceSliceListV1Beta1; KubeResourceSliceListV1Beta1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of resource ResourceSlices. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of resource ResourceSlices. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceListV1Beta1; KubeResourceSliceListV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceListV1Beta1; KubeResourceSliceListV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceListV1Beta1; KubeResourceSliceListV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceListV1Beta1; KubeResourceSliceListV1Beta1.manifest(KubeResourceSliceListV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceSliceListV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceSliceList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeResourceSliceV1Alpha3; KubeResourceSliceV1Alpha3.Builder.create(Construct scope, java.lang.String id) .spec(ResourceSliceSpecV1Alpha3) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.ResourceSliceSpecV1Alpha3 | Contains the information published by the driver. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.ResourceSliceSpecV1Alpha3 Contains the information published by the driver. Changing the spec automatically increments the metadata.generation number. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceV1Alpha3; KubeResourceSliceV1Alpha3.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceV1Alpha3; KubeResourceSliceV1Alpha3.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceV1Alpha3; KubeResourceSliceV1Alpha3.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceV1Alpha3; KubeResourceSliceV1Alpha3.manifest(KubeResourceSliceV1Alpha3Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceSliceV1Alpha3Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1alpha3.ResourceSlice". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeResourceSliceV1Beta1; KubeResourceSliceV1Beta1.Builder.create(Construct scope, java.lang.String id) .spec(ResourceSliceSpecV1Beta1) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.ResourceSliceSpecV1Beta1 | Contains the information published by the driver. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.ResourceSliceSpecV1Beta1 Contains the information published by the driver. Changing the spec automatically increments the metadata.generation number. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceV1Beta1; KubeResourceSliceV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceV1Beta1; KubeResourceSliceV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceV1Beta1; KubeResourceSliceV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeResourceSliceV1Beta1; KubeResourceSliceV1Beta1.manifest(KubeResourceSliceV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeResourceSliceV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.resource.v1beta1.ResourceSlice". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeRole; KubeRole.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .rules(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | rules | java.util.List | Rules holds all the PolicyRules for this Role. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. --- ##### `rules`^Optional - *Type:* java.util.List Rules holds all the PolicyRules for this Role. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeRole; KubeRole.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeRole; KubeRole.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeRole; KubeRole.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeRole; KubeRole.manifest(),KubeRole.manifest(KubeRoleProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeRoleProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.Role". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeRoleBinding; KubeRoleBinding.Builder.create(Construct scope, java.lang.String id) .roleRef(RoleRef) // .metadata(ObjectMeta) // .subjects(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | roleRef | org.cdk8s.plus32.k8s.RoleRef | RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | subjects | java.util.List | Subjects holds references to the objects the role applies to. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `roleRef`^Required - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. --- ##### `subjects`^Optional - *Type:* java.util.List Subjects holds references to the objects the role applies to. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeRoleBinding; KubeRoleBinding.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeRoleBinding; KubeRoleBinding.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeRoleBinding; KubeRoleBinding.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeRoleBinding; KubeRoleBinding.manifest(KubeRoleBindingProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeRoleBindingProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleBinding". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleBinding". --- ### KubeRoleBindingList RoleBindingList is a collection of RoleBindings. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeRoleBindingList; KubeRoleBindingList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is a list of RoleBindings. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is a list of RoleBindings. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard object's metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeRoleBindingList; KubeRoleBindingList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeRoleBindingList; KubeRoleBindingList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeRoleBindingList; KubeRoleBindingList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeRoleBindingList; KubeRoleBindingList.manifest(KubeRoleBindingListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeRoleBindingListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleBindingList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleBindingList". --- ### KubeRoleList RoleList is a collection of Roles. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeRoleList; KubeRoleList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is a list of Roles. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is a list of Roles. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard object's metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeRoleList; KubeRoleList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeRoleList; KubeRoleList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeRoleList; KubeRoleList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeRoleList; KubeRoleList.manifest(KubeRoleListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeRoleListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeRuntimeClass; KubeRuntimeClass.Builder.create(Construct scope, java.lang.String id) .handler(java.lang.String) // .metadata(ObjectMeta) // .overhead(Overhead) // .scheduling(Scheduling) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | handler | java.lang.String | handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | | overhead | org.cdk8s.plus32.k8s.Overhead | overhead represents the resource overhead associated with running a pod for a given RuntimeClass. | | scheduling | org.cdk8s.plus32.k8s.Scheduling | scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `handler`^Required - *Type:* java.lang.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `overhead`^Optional - *Type:* org.cdk8s.plus32.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 - *Type:* org.cdk8s.plus32.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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeRuntimeClass; KubeRuntimeClass.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeRuntimeClass; KubeRuntimeClass.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeRuntimeClass; KubeRuntimeClass.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeRuntimeClass; KubeRuntimeClass.manifest(KubeRuntimeClassProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeRuntimeClassProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.node.v1.RuntimeClass". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.node.v1.RuntimeClass". --- ### KubeRuntimeClassList RuntimeClassList is a list of RuntimeClass objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeRuntimeClassList; KubeRuntimeClassList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is a list of schema objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is a list of schema objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeRuntimeClassList; KubeRuntimeClassList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeRuntimeClassList; KubeRuntimeClassList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeRuntimeClassList; KubeRuntimeClassList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeRuntimeClassList; KubeRuntimeClassList.manifest(KubeRuntimeClassListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeRuntimeClassListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.node.v1.RuntimeClassList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.node.v1.RuntimeClassList". --- ### KubeScale Scale represents a scaling request for a resource. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeScale; KubeScale.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(ScaleSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata; | | spec | org.cdk8s.plus32.k8s.ScaleSpec | spec defines the behavior of the scale. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeScale; KubeScale.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeScale; KubeScale.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeScale; KubeScale.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeScale; KubeScale.manifest(),KubeScale.manifest(KubeScaleProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeScaleProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.Scale". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeSecret; KubeSecret.Builder.create(Construct scope, java.lang.String id) // .data(java.util.Map) // .immutable(java.lang.Boolean) // .metadata(ObjectMeta) // .stringData(java.util.Map) // .type(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | data | java.util.Map | Data contains the secret data. | | immutable | java.lang.Boolean | Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | stringData | java.util.Map | stringData allows specifying non-binary secret data in string form. | | type | java.lang.String | Used to facilitate programmatic handling of secret data. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `data`^Optional - *Type:* java.util.Map 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 - *Type:* java.lang.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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `stringData`^Optional - *Type:* java.util.Map 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 - *Type:* java.lang.String Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeSecret; KubeSecret.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeSecret; KubeSecret.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeSecret; KubeSecret.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeSecret; KubeSecret.manifest(),KubeSecret.manifest(KubeSecretProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeSecretProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Secret". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.Secret". --- ### KubeSecretList SecretList is a list of Secret. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeSecretList; KubeSecretList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is a list of secret objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeSecretList; KubeSecretList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeSecretList; KubeSecretList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeSecretList; KubeSecretList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeSecretList; KubeSecretList.manifest(KubeSecretListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeSecretListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.SecretList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectAccessReview; KubeSelfSubjectAccessReview.Builder.create(Construct scope, java.lang.String id) .spec(SelfSubjectAccessReviewSpec) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.SelfSubjectAccessReviewSpec | Spec holds information about the request being evaluated. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.SelfSubjectAccessReviewSpec Spec holds information about the request being evaluated. user and groups must be empty --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectAccessReview; KubeSelfSubjectAccessReview.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectAccessReview; KubeSelfSubjectAccessReview.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectAccessReview; KubeSelfSubjectAccessReview.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectAccessReview; KubeSelfSubjectAccessReview.manifest(KubeSelfSubjectAccessReviewProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeSelfSubjectAccessReviewProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authorization.v1.SelfSubjectAccessReview". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectReview; KubeSelfSubjectReview.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectReview; KubeSelfSubjectReview.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectReview; KubeSelfSubjectReview.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectReview; KubeSelfSubjectReview.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectReview; KubeSelfSubjectReview.manifest(),KubeSelfSubjectReview.manifest(KubeSelfSubjectReviewProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeSelfSubjectReviewProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authentication.v1.SelfSubjectReview". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectReviewV1Beta1; KubeSelfSubjectReviewV1Beta1.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectReviewV1Beta1; KubeSelfSubjectReviewV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectReviewV1Beta1; KubeSelfSubjectReviewV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectReviewV1Beta1; KubeSelfSubjectReviewV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectReviewV1Beta1; KubeSelfSubjectReviewV1Beta1.manifest(),KubeSelfSubjectReviewV1Beta1.manifest(KubeSelfSubjectReviewV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeSelfSubjectReviewV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authentication.v1beta1.SelfSubjectReview". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectRulesReview; KubeSelfSubjectRulesReview.Builder.create(Construct scope, java.lang.String id) .spec(SelfSubjectRulesReviewSpec) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.SelfSubjectRulesReviewSpec | Spec holds information about the request being evaluated. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.SelfSubjectRulesReviewSpec Spec holds information about the request being evaluated. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectRulesReview; KubeSelfSubjectRulesReview.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectRulesReview; KubeSelfSubjectRulesReview.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectRulesReview; KubeSelfSubjectRulesReview.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeSelfSubjectRulesReview; KubeSelfSubjectRulesReview.manifest(KubeSelfSubjectRulesReviewProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeSelfSubjectRulesReviewProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authorization.v1.SelfSubjectRulesReview". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeService; KubeService.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(ServiceSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.ServiceSpec | Spec defines the behavior of a service. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.ServiceSpec Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeService; KubeService.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeService; KubeService.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeService; KubeService.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeService; KubeService.manifest(),KubeService.manifest(KubeServiceProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeServiceProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Service". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeServiceAccount; KubeServiceAccount.Builder.create(Construct scope, java.lang.String id) // .automountServiceAccountToken(java.lang.Boolean) // .imagePullSecrets(java.util.List) // .metadata(ObjectMeta) // .secrets(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | automountServiceAccountToken | java.lang.Boolean | AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. | | imagePullSecrets | java.util.List | 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 | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | secrets | java.util.List | Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `automountServiceAccountToken`^Optional - *Type:* java.lang.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 - *Type:* java.util.List 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 - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `secrets`^Optional - *Type:* java.util.List 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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeServiceAccount; KubeServiceAccount.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeServiceAccount; KubeServiceAccount.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeServiceAccount; KubeServiceAccount.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeServiceAccount; KubeServiceAccount.manifest(),KubeServiceAccount.manifest(KubeServiceAccountProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeServiceAccountProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceAccount". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceAccount". --- ### KubeServiceAccountList ServiceAccountList is a list of ServiceAccount objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeServiceAccountList; KubeServiceAccountList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of ServiceAccounts. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeServiceAccountList; KubeServiceAccountList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeServiceAccountList; KubeServiceAccountList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeServiceAccountList; KubeServiceAccountList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeServiceAccountList; KubeServiceAccountList.manifest(KubeServiceAccountListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeServiceAccountListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceAccountList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceAccountList". --- ### KubeServiceCidrListV1Beta1 ServiceCIDRList contains a list of ServiceCIDR objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeServiceCidrListV1Beta1; KubeServiceCidrListV1Beta1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of ServiceCIDRs. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of ServiceCIDRs. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeServiceCidrListV1Beta1; KubeServiceCidrListV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeServiceCidrListV1Beta1; KubeServiceCidrListV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeServiceCidrListV1Beta1; KubeServiceCidrListV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeServiceCidrListV1Beta1; KubeServiceCidrListV1Beta1.manifest(KubeServiceCidrListV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeServiceCidrListV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.ServiceCIDRList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeServiceCidrv1Beta1; KubeServiceCidrv1Beta1.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(ServiceCidrSpecV1Beta1) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.ServiceCidrSpecV1Beta1 | spec is the desired state of the ServiceCIDR. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.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 --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeServiceCidrv1Beta1; KubeServiceCidrv1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeServiceCidrv1Beta1; KubeServiceCidrv1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeServiceCidrv1Beta1; KubeServiceCidrv1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeServiceCidrv1Beta1; KubeServiceCidrv1Beta1.manifest(),KubeServiceCidrv1Beta1.manifest(KubeServiceCidrv1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeServiceCidrv1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.ServiceCIDR". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.ServiceCIDR". --- ### KubeServiceList ServiceList holds a list of services. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeServiceList; KubeServiceList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of services. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of services. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeServiceList; KubeServiceList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeServiceList; KubeServiceList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeServiceList; KubeServiceList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeServiceList; KubeServiceList.manifest(KubeServiceListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeServiceListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeStatefulSet; KubeStatefulSet.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(StatefulSetSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | spec | org.cdk8s.plus32.k8s.StatefulSetSpec | Spec defines the desired identities of pods in this set. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.StatefulSetSpec Spec defines the desired identities of pods in this set. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeStatefulSet; KubeStatefulSet.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeStatefulSet; KubeStatefulSet.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeStatefulSet; KubeStatefulSet.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeStatefulSet; KubeStatefulSet.manifest(),KubeStatefulSet.manifest(KubeStatefulSetProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeStatefulSetProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.StatefulSet". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.apps.v1.StatefulSet". --- ### KubeStatefulSetList StatefulSetList is a collection of StatefulSets. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeStatefulSetList; KubeStatefulSetList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of stateful sets. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of stateful sets. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeStatefulSetList; KubeStatefulSetList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeStatefulSetList; KubeStatefulSetList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeStatefulSetList; KubeStatefulSetList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeStatefulSetList; KubeStatefulSetList.manifest(KubeStatefulSetListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeStatefulSetListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.StatefulSetList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeStatus; KubeStatus.Builder.create(Construct scope, java.lang.String id) // .code(java.lang.Number) // .details(StatusDetails) // .message(java.lang.String) // .metadata(ListMeta) // .reason(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | code | java.lang.Number | Suggested HTTP return code for this status, 0 if not set. | | details | org.cdk8s.plus32.k8s.StatusDetails | Extended data associated with the reason. | | message | java.lang.String | A human-readable description of the status of this operation. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | | reason | java.lang.String | A machine-readable description of why this operation is in the "Failure" status. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `code`^Optional - *Type:* java.lang.Number Suggested HTTP return code for this status, 0 if not set. --- ##### `details`^Optional - *Type:* org.cdk8s.plus32.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 - *Type:* java.lang.String A human-readable description of the status of this operation. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- ##### `reason`^Optional - *Type:* java.lang.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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is 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` ```java import org.cdk8s.plus32.k8s.KubeStatus; KubeStatus.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeStatus; KubeStatus.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeStatus; KubeStatus.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeStatus; KubeStatus.manifest(),KubeStatus.manifest(KubeStatusProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeStatusProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.apimachinery.pkg.apis.meta.v1.Status". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeStorageClass; KubeStorageClass.Builder.create(Construct scope, java.lang.String id) .provisioner(java.lang.String) // .allowedTopologies(java.util.List) // .allowVolumeExpansion(java.lang.Boolean) // .metadata(ObjectMeta) // .mountOptions(java.util.List) // .parameters(java.util.Map) // .reclaimPolicy(java.lang.String) // .volumeBindingMode(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | provisioner | java.lang.String | provisioner indicates the type of the provisioner. | | allowedTopologies | java.util.List | allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. | | allowVolumeExpansion | java.lang.Boolean | allowVolumeExpansion shows whether the storage class allow volume expand. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | mountOptions | java.util.List | mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. | | parameters | java.util.Map | parameters holds the parameters for the provisioner that should create volumes of this storage class. | | reclaimPolicy | java.lang.String | reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. | | volumeBindingMode | java.lang.String | volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `provisioner`^Required - *Type:* java.lang.String provisioner indicates the type of the provisioner. --- ##### `allowedTopologies`^Optional - *Type:* java.util.List 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 - *Type:* java.lang.Boolean allowVolumeExpansion shows whether the storage class allow volume expand. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `mountOptions`^Optional - *Type:* java.util.List 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 - *Type:* java.util.Map parameters holds the parameters for the provisioner that should create volumes of this storage class. --- ##### `reclaimPolicy`^Optional - *Type:* java.lang.String - *Default:* Delete. reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete. --- ##### `volumeBindingMode`^Optional - *Type:* java.lang.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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeStorageClass; KubeStorageClass.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeStorageClass; KubeStorageClass.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeStorageClass; KubeStorageClass.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeStorageClass; KubeStorageClass.manifest(KubeStorageClassProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeStorageClassProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.StorageClass". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1.StorageClass". --- ### KubeStorageClassList StorageClassList is a collection of storage classes. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeStorageClassList; KubeStorageClassList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of StorageClasses. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of StorageClasses. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeStorageClassList; KubeStorageClassList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeStorageClassList; KubeStorageClassList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeStorageClassList; KubeStorageClassList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeStorageClassList; KubeStorageClassList.manifest(KubeStorageClassListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeStorageClassListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.StorageClassList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1.StorageClassList". --- ### KubeStorageVersionListV1Alpha1 A list of StorageVersions. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeStorageVersionListV1Alpha1; KubeStorageVersionListV1Alpha1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items holds a list of StorageVersion. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items holds a list of StorageVersion. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionListV1Alpha1; KubeStorageVersionListV1Alpha1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionListV1Alpha1; KubeStorageVersionListV1Alpha1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionListV1Alpha1; KubeStorageVersionListV1Alpha1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionListV1Alpha1; KubeStorageVersionListV1Alpha1.manifest(KubeStorageVersionListV1Alpha1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeStorageVersionListV1Alpha1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList". --- ### KubeStorageVersionMigrationListV1Alpha1 StorageVersionMigrationList is a collection of storage version migrations. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeStorageVersionMigrationListV1Alpha1; KubeStorageVersionMigrationListV1Alpha1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | Items is the list of StorageVersionMigration. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List Items is the list of StorageVersionMigration. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionMigrationListV1Alpha1; KubeStorageVersionMigrationListV1Alpha1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionMigrationListV1Alpha1; KubeStorageVersionMigrationListV1Alpha1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionMigrationListV1Alpha1; KubeStorageVersionMigrationListV1Alpha1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionMigrationListV1Alpha1; KubeStorageVersionMigrationListV1Alpha1.manifest(KubeStorageVersionMigrationListV1Alpha1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeStorageVersionMigrationListV1Alpha1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storagemigration.v1alpha1.StorageVersionMigrationList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeStorageVersionMigrationV1Alpha1; KubeStorageVersionMigrationV1Alpha1.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(StorageVersionMigrationSpecV1Alpha1) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata. | | spec | org.cdk8s.plus32.k8s.StorageVersionMigrationSpecV1Alpha1 | Specification of the migration. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.StorageVersionMigrationSpecV1Alpha1 Specification of the migration. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionMigrationV1Alpha1; KubeStorageVersionMigrationV1Alpha1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionMigrationV1Alpha1; KubeStorageVersionMigrationV1Alpha1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionMigrationV1Alpha1; KubeStorageVersionMigrationV1Alpha1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionMigrationV1Alpha1; KubeStorageVersionMigrationV1Alpha1.manifest(),KubeStorageVersionMigrationV1Alpha1.manifest(KubeStorageVersionMigrationV1Alpha1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeStorageVersionMigrationV1Alpha1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storagemigration.v1alpha1.StorageVersionMigration". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storagemigration.v1alpha1.StorageVersionMigration". --- ### KubeStorageVersionV1Alpha1 Storage version of a specific resource. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeStorageVersionV1Alpha1; KubeStorageVersionV1Alpha1.Builder.create(Construct scope, java.lang.String id) .spec(java.lang.Object) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | java.lang.Object | Spec is an empty spec. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | The name is .. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* java.lang.Object Spec is an empty spec. It is here to comply with Kubernetes API style. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta The name is .. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionV1Alpha1; KubeStorageVersionV1Alpha1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionV1Alpha1; KubeStorageVersionV1Alpha1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionV1Alpha1; KubeStorageVersionV1Alpha1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeStorageVersionV1Alpha1; KubeStorageVersionV1Alpha1.manifest(KubeStorageVersionV1Alpha1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeStorageVersionV1Alpha1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersion". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeSubjectAccessReview; KubeSubjectAccessReview.Builder.create(Construct scope, java.lang.String id) .spec(SubjectAccessReviewSpec) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.SubjectAccessReviewSpec | Spec holds information about the request being evaluated. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.SubjectAccessReviewSpec Spec holds information about the request being evaluated. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeSubjectAccessReview; KubeSubjectAccessReview.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeSubjectAccessReview; KubeSubjectAccessReview.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeSubjectAccessReview; KubeSubjectAccessReview.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeSubjectAccessReview; KubeSubjectAccessReview.manifest(KubeSubjectAccessReviewProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeSubjectAccessReviewProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authorization.v1.SubjectAccessReview". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeTokenRequest; KubeTokenRequest.Builder.create(Construct scope, java.lang.String id) .spec(TokenRequestSpec) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.TokenRequestSpec | Spec holds information about the request being evaluated. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.TokenRequestSpec Spec holds information about the request being evaluated. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeTokenRequest; KubeTokenRequest.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeTokenRequest; KubeTokenRequest.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeTokenRequest; KubeTokenRequest.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeTokenRequest; KubeTokenRequest.manifest(KubeTokenRequestProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeTokenRequestProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authentication.v1.TokenRequest". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeTokenReview; KubeTokenReview.Builder.create(Construct scope, java.lang.String id) .spec(TokenReviewSpec) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.TokenReviewSpec | Spec holds information about the request being evaluated. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.TokenReviewSpec Spec holds information about the request being evaluated. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeTokenReview; KubeTokenReview.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeTokenReview; KubeTokenReview.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeTokenReview; KubeTokenReview.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeTokenReview; KubeTokenReview.manifest(KubeTokenReviewProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeTokenReviewProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authentication.v1.TokenReview". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicy; KubeValidatingAdmissionPolicy.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(ValidatingAdmissionPolicySpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata; | | spec | org.cdk8s.plus32.k8s.ValidatingAdmissionPolicySpec | Specification of the desired behavior of the ValidatingAdmissionPolicy. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.ValidatingAdmissionPolicySpec Specification of the desired behavior of the ValidatingAdmissionPolicy. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicy; KubeValidatingAdmissionPolicy.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicy; KubeValidatingAdmissionPolicy.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicy; KubeValidatingAdmissionPolicy.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicy; KubeValidatingAdmissionPolicy.manifest(),KubeValidatingAdmissionPolicy.manifest(KubeValidatingAdmissionPolicyProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicy". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBinding; KubeValidatingAdmissionPolicyBinding.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(ValidatingAdmissionPolicyBindingSpec) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata; | | spec | org.cdk8s.plus32.k8s.ValidatingAdmissionPolicyBindingSpec | Specification of the desired behavior of the ValidatingAdmissionPolicyBinding. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.ValidatingAdmissionPolicyBindingSpec Specification of the desired behavior of the ValidatingAdmissionPolicyBinding. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBinding; KubeValidatingAdmissionPolicyBinding.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBinding; KubeValidatingAdmissionPolicyBinding.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBinding; KubeValidatingAdmissionPolicyBinding.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBinding; KubeValidatingAdmissionPolicyBinding.manifest(),KubeValidatingAdmissionPolicyBinding.manifest(KubeValidatingAdmissionPolicyBindingProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBinding". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBinding". --- ### KubeValidatingAdmissionPolicyBindingList ValidatingAdmissionPolicyBindingList is a list of ValidatingAdmissionPolicyBinding. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingList; KubeValidatingAdmissionPolicyBindingList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of PolicyBinding. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of PolicyBinding. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingList; KubeValidatingAdmissionPolicyBindingList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingList; KubeValidatingAdmissionPolicyBindingList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingList; KubeValidatingAdmissionPolicyBindingList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingList; KubeValidatingAdmissionPolicyBindingList.manifest(KubeValidatingAdmissionPolicyBindingListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBindingList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBindingList". --- ### KubeValidatingAdmissionPolicyBindingListV1Beta1 ValidatingAdmissionPolicyBindingList is a list of ValidatingAdmissionPolicyBinding. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1; KubeValidatingAdmissionPolicyBindingListV1Beta1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of PolicyBinding. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of PolicyBinding. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1; KubeValidatingAdmissionPolicyBindingListV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1; KubeValidatingAdmissionPolicyBindingListV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1; KubeValidatingAdmissionPolicyBindingListV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1; KubeValidatingAdmissionPolicyBindingListV1Beta1.manifest(KubeValidatingAdmissionPolicyBindingListV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingListV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyBindingList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingV1Beta1; KubeValidatingAdmissionPolicyBindingV1Beta1.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(ValidatingAdmissionPolicyBindingSpecV1Beta1) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata; | | spec | org.cdk8s.plus32.k8s.ValidatingAdmissionPolicyBindingSpecV1Beta1 | Specification of the desired behavior of the ValidatingAdmissionPolicyBinding. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.ValidatingAdmissionPolicyBindingSpecV1Beta1 Specification of the desired behavior of the ValidatingAdmissionPolicyBinding. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingV1Beta1; KubeValidatingAdmissionPolicyBindingV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingV1Beta1; KubeValidatingAdmissionPolicyBindingV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingV1Beta1; KubeValidatingAdmissionPolicyBindingV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingV1Beta1; KubeValidatingAdmissionPolicyBindingV1Beta1.manifest(),KubeValidatingAdmissionPolicyBindingV1Beta1.manifest(KubeValidatingAdmissionPolicyBindingV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyBindingV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyBinding". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyBinding". --- ### KubeValidatingAdmissionPolicyList ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyList; KubeValidatingAdmissionPolicyList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of ValidatingAdmissionPolicy. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of ValidatingAdmissionPolicy. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyList; KubeValidatingAdmissionPolicyList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyList; KubeValidatingAdmissionPolicyList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyList; KubeValidatingAdmissionPolicyList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyList; KubeValidatingAdmissionPolicyList.manifest(KubeValidatingAdmissionPolicyListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyList". --- ### KubeValidatingAdmissionPolicyListV1Beta1 ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyListV1Beta1; KubeValidatingAdmissionPolicyListV1Beta1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of ValidatingAdmissionPolicy. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of ValidatingAdmissionPolicy. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyListV1Beta1; KubeValidatingAdmissionPolicyListV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyListV1Beta1; KubeValidatingAdmissionPolicyListV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyListV1Beta1; KubeValidatingAdmissionPolicyListV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyListV1Beta1; KubeValidatingAdmissionPolicyListV1Beta1.manifest(KubeValidatingAdmissionPolicyListV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyListV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyV1Beta1; KubeValidatingAdmissionPolicyV1Beta1.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .spec(ValidatingAdmissionPolicySpecV1Beta1) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata; | | spec | org.cdk8s.plus32.k8s.ValidatingAdmissionPolicySpecV1Beta1 | Specification of the desired behavior of the ValidatingAdmissionPolicy. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `spec`^Optional - *Type:* org.cdk8s.plus32.k8s.ValidatingAdmissionPolicySpecV1Beta1 Specification of the desired behavior of the ValidatingAdmissionPolicy. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyV1Beta1; KubeValidatingAdmissionPolicyV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyV1Beta1; KubeValidatingAdmissionPolicyV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyV1Beta1; KubeValidatingAdmissionPolicyV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyV1Beta1; KubeValidatingAdmissionPolicyV1Beta1.manifest(),KubeValidatingAdmissionPolicyV1Beta1.manifest(KubeValidatingAdmissionPolicyV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeValidatingAdmissionPolicyV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicy". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeValidatingWebhookConfiguration; KubeValidatingWebhookConfiguration.Builder.create(Construct scope, java.lang.String id) // .metadata(ObjectMeta) // .webhooks(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata; | | webhooks | java.util.List | Webhooks is a list of webhooks and the affected resources and operations. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- ##### `webhooks`^Optional - *Type:* java.util.List Webhooks is a list of webhooks and the affected resources and operations. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeValidatingWebhookConfiguration; KubeValidatingWebhookConfiguration.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeValidatingWebhookConfiguration; KubeValidatingWebhookConfiguration.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeValidatingWebhookConfiguration; KubeValidatingWebhookConfiguration.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeValidatingWebhookConfiguration; KubeValidatingWebhookConfiguration.manifest(),KubeValidatingWebhookConfiguration.manifest(KubeValidatingWebhookConfigurationProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeValidatingWebhookConfigurationProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration". --- ### KubeValidatingWebhookConfigurationList ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeValidatingWebhookConfigurationList; KubeValidatingWebhookConfigurationList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | List of ValidatingWebhookConfiguration. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List List of ValidatingWebhookConfiguration. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeValidatingWebhookConfigurationList; KubeValidatingWebhookConfigurationList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeValidatingWebhookConfigurationList; KubeValidatingWebhookConfigurationList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeValidatingWebhookConfigurationList; KubeValidatingWebhookConfigurationList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeValidatingWebhookConfigurationList; KubeValidatingWebhookConfigurationList.manifest(KubeValidatingWebhookConfigurationListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeValidatingWebhookConfigurationListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeVolumeAttachment; KubeVolumeAttachment.Builder.create(Construct scope, java.lang.String id) .spec(VolumeAttachmentSpec) // .metadata(ObjectMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | spec | org.cdk8s.plus32.k8s.VolumeAttachmentSpec | spec represents specification of the desired attach/detach volume behavior. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `spec`^Required - *Type:* org.cdk8s.plus32.k8s.VolumeAttachmentSpec spec represents specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttachment; KubeVolumeAttachment.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttachment; KubeVolumeAttachment.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttachment; KubeVolumeAttachment.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttachment; KubeVolumeAttachment.manifest(KubeVolumeAttachmentProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeVolumeAttachmentProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.VolumeAttachment". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1.VolumeAttachment". --- ### KubeVolumeAttachmentList VolumeAttachmentList is a collection of VolumeAttachment objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeVolumeAttachmentList; KubeVolumeAttachmentList.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of VolumeAttachments. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of VolumeAttachments. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttachmentList; KubeVolumeAttachmentList.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttachmentList; KubeVolumeAttachmentList.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttachmentList; KubeVolumeAttachmentList.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttachmentList; KubeVolumeAttachmentList.manifest(KubeVolumeAttachmentListProps props) ``` 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:* org.cdk8s.plus32.k8s.KubeVolumeAttachmentListProps initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.VolumeAttachmentList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1.VolumeAttachmentList". --- ### KubeVolumeAttributesClassListV1Alpha1 VolumeAttributesClassList is a collection of VolumeAttributesClass objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassListV1Alpha1; KubeVolumeAttributesClassListV1Alpha1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of VolumeAttributesClass objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of VolumeAttributesClass objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassListV1Alpha1; KubeVolumeAttributesClassListV1Alpha1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassListV1Alpha1; KubeVolumeAttributesClassListV1Alpha1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassListV1Alpha1; KubeVolumeAttributesClassListV1Alpha1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassListV1Alpha1; KubeVolumeAttributesClassListV1Alpha1.manifest(KubeVolumeAttributesClassListV1Alpha1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeVolumeAttributesClassListV1Alpha1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.VolumeAttributesClassList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.cdk8s.GroupVersionKind Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.VolumeAttributesClassList". --- ### KubeVolumeAttributesClassListV1Beta1 VolumeAttributesClassList is a collection of VolumeAttributesClass objects. #### Initializers ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassListV1Beta1; KubeVolumeAttributesClassListV1Beta1.Builder.create(Construct scope, java.lang.String id) .items(java.util.List) // .metadata(ListMeta) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | items | java.util.List | items is the list of VolumeAttributesClass objects. | | metadata | org.cdk8s.plus32.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `items`^Required - *Type:* java.util.List items is the list of VolumeAttributesClass objects. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ListMeta Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassListV1Beta1; KubeVolumeAttributesClassListV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassListV1Beta1; KubeVolumeAttributesClassListV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassListV1Beta1; KubeVolumeAttributesClassListV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassListV1Beta1; KubeVolumeAttributesClassListV1Beta1.manifest(KubeVolumeAttributesClassListV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeVolumeAttributesClassListV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.VolumeAttributesClassList". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassV1Alpha1; KubeVolumeAttributesClassV1Alpha1.Builder.create(Construct scope, java.lang.String id) .driverName(java.lang.String) // .metadata(ObjectMeta) // .parameters(java.util.Map) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | driverName | java.lang.String | Name of the CSI driver This field is immutable. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | parameters | java.util.Map | parameters hold volume attributes defined by the CSI driver. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `driverName`^Required - *Type:* java.lang.String Name of the CSI driver This field is immutable. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `parameters`^Optional - *Type:* java.util.Map 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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassV1Alpha1; KubeVolumeAttributesClassV1Alpha1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassV1Alpha1; KubeVolumeAttributesClassV1Alpha1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassV1Alpha1; KubeVolumeAttributesClassV1Alpha1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassV1Alpha1; KubeVolumeAttributesClassV1Alpha1.manifest(KubeVolumeAttributesClassV1Alpha1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeVolumeAttributesClassV1Alpha1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.VolumeAttributesClass". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassV1Beta1; KubeVolumeAttributesClassV1Beta1.Builder.create(Construct scope, java.lang.String id) .driverName(java.lang.String) // .metadata(ObjectMeta) // .parameters(java.util.Map) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | the scope in which to define this object. | | id | java.lang.String | a scope-local name for the object. | | driverName | java.lang.String | Name of the CSI driver This field is immutable. | | metadata | org.cdk8s.plus32.k8s.ObjectMeta | Standard object's metadata. | | parameters | java.util.Map | parameters hold volume attributes defined by the CSI driver. | --- ##### `scope`^Required - *Type:* software.constructs.Construct the scope in which to define this object. --- ##### `id`^Required - *Type:* java.lang.String a scope-local name for the object. --- ##### `driverName`^Required - *Type:* java.lang.String Name of the CSI driver This field is immutable. --- ##### `metadata`^Optional - *Type:* org.cdk8s.plus32.k8s.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata --- ##### `parameters`^Optional - *Type:* java.util.Map 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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `addDependency` ```java public void addDependency(IConstruct... dependencies) ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* software.constructs.IConstruct... the dependencies to add. --- ##### `addJsonPatch` ```java public void addJsonPatch(JsonPatch... ops) ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```java kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* org.cdk8s.JsonPatch... The JSON-Patch operations to apply. --- ##### `toJson` ```java public java.lang.Object toJson() ``` Renders the object to Kubernetes JSON. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `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` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassV1Beta1; KubeVolumeAttributesClassV1Beta1.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `isApiObject` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassV1Beta1; KubeVolumeAttributesClassV1Beta1.isApiObject(java.lang.Object o) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* java.lang.Object The object to check. --- ##### `of` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassV1Beta1; KubeVolumeAttributesClassV1Beta1.of(IConstruct c) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* software.constructs.IConstruct The higher-level construct. --- ##### `manifest` ```java import org.cdk8s.plus32.k8s.KubeVolumeAttributesClassV1Beta1; KubeVolumeAttributesClassV1Beta1.manifest(KubeVolumeAttributesClassV1Beta1Props props) ``` 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:* org.cdk8s.plus32.k8s.KubeVolumeAttributesClassV1Beta1Props initialization props. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | java.lang.String | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | org.cdk8s.Chart | The chart in which this object is defined. | | kind | java.lang.String | The object kind. | | metadata | org.cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | java.lang.String | The name of the API object. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```java public Chart getChart(); ``` - *Type:* org.cdk8s.Chart The chart in which this object is defined. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind. --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | GVK | org.cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.VolumeAttributesClass". | --- ##### `GVK`^Required ```java public GroupVersionKind getGvk(); ``` - *Type:* org.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 ```java import org.cdk8s.plus32.Namespace; Namespace.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `toNamespaceSelectorConfig` ```java public NamespaceSelectorConfig toNamespaceSelectorConfig() ``` Return the configuration of this selector. > [INamespaceSelector.toNamespaceSelectorConfig ()](INamespaceSelector.toNamespaceSelectorConfig ()) ##### `toNetworkPolicyPeerConfig` ```java public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig() ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```java public IPodSelector toPodSelector() ``` 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` ```java import org.cdk8s.plus32.Namespace; Namespace.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 | java.lang.String | *No description.* | --- ##### `NAME_LABEL`^Required ```java public java.lang.String getNameLabel(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.Namespaces; new Namespaces(Construct scope, java.lang.String id);,new Namespaces(Construct scope, java.lang.String id, java.util.List expressions);,new Namespaces(Construct scope, java.lang.String id, java.util.List expressions, java.util.List names);,new Namespaces(Construct scope, java.lang.String id, java.util.List expressions, java.util.List names, java.util.Map labels); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | expressions | java.util.List<LabelExpression> | *No description.* | | names | java.util.List | *No description.* | | labels | java.util.Map | *No description.* | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `expressions`^Optional - *Type:* java.util.List<LabelExpression> --- ##### `names`^Optional - *Type:* java.util.List --- ##### `labels`^Optional - *Type:* java.util.Map --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `toNamespaceSelectorConfig` ```java public NamespaceSelectorConfig toNamespaceSelectorConfig() ``` Return the configuration of this selector. > [INamespaceSelector.toNamespaceSelectorConfig ()](INamespaceSelector.toNamespaceSelectorConfig ()) ##### `toNetworkPolicyPeerConfig` ```java public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig() ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```java public IPodSelector toPodSelector() ``` 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` ```java import org.cdk8s.plus32.Namespaces; Namespaces.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `all` ```java import org.cdk8s.plus32.Namespaces; Namespaces.all(Construct scope, java.lang.String id) ``` Select all namespaces. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ##### `select` ```java import org.cdk8s.plus32.Namespaces; Namespaces.select(Construct scope, java.lang.String id, NamespacesSelectOptions options) ``` Select specific namespaces. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `options`^Required - *Type:* NamespacesSelectOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.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 ```java import org.cdk8s.plus32.NetworkPolicy; NetworkPolicy.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .egress(NetworkPolicyTraffic) // .ingress(NetworkPolicyTraffic) // .selector(IPodSelector) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.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. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `egress`^Optional - *Type:* NetworkPolicyTraffic - *Default:* the policy doesn't change egress behavior of the pods it selects. Egress traffic configuration. --- ##### `ingress`^Optional - *Type:* NetworkPolicyTraffic - *Default:* the policy doesn't change ingress behavior of the pods it selects. Ingress traffic configuration. --- ##### `selector`^Optional - *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 --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addEgressRule` ```java public void addEgressRule(INetworkPolicyPeer peer) public void addEgressRule(INetworkPolicyPeer peer, java.util.List ports) ``` 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:* java.util.List<NetworkPolicyPort> --- ##### `addIngressRule` ```java public void addIngressRule(INetworkPolicyPeer peer) public void addIngressRule(INetworkPolicyPeer peer, java.util.List ports) ``` 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:* java.util.List<NetworkPolicyPort> --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.NetworkPolicy; NetworkPolicy.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `toNetworkPolicyPeerConfig` ```java public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig() ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```java public IPodSelector toPodSelector() ``` 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` ```java import org.cdk8s.plus32.NetworkPolicyIpBlock; NetworkPolicyIpBlock.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `anyIpv4` ```java import org.cdk8s.plus32.NetworkPolicyIpBlock; NetworkPolicyIpBlock.anyIpv4(Construct scope, java.lang.String id) ``` Any IPv4 address. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ##### `anyIpv6` ```java import org.cdk8s.plus32.NetworkPolicyIpBlock; NetworkPolicyIpBlock.anyIpv6(Construct scope, java.lang.String id) ``` Any IPv6 address. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ##### `ipv4` ```java import org.cdk8s.plus32.NetworkPolicyIpBlock; NetworkPolicyIpBlock.ipv4(Construct scope, java.lang.String id, java.lang.String cidrIp),NetworkPolicyIpBlock.ipv4(Construct scope, java.lang.String id, java.lang.String cidrIp, java.util.List except) ``` Create an IPv4 peer from a CIDR. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `cidrIp`^Required - *Type:* java.lang.String --- ###### `except`^Optional - *Type:* java.util.List --- ##### `ipv6` ```java import org.cdk8s.plus32.NetworkPolicyIpBlock; NetworkPolicyIpBlock.ipv6(Construct scope, java.lang.String id, java.lang.String cidrIp),NetworkPolicyIpBlock.ipv6(Construct scope, java.lang.String id, java.lang.String cidrIp, java.util.List except) ``` Create an IPv6 peer from a CIDR. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `cidrIp`^Required - *Type:* java.lang.String --- ###### `except`^Optional - *Type:* java.util.List --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | cidr | java.lang.String | A string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64". | | except | java.util.List | 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 ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `cidr`^Required ```java public java.lang.String getCidr(); ``` - *Type:* java.lang.String A string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64". --- ##### `except`^Optional ```java public java.util.List getExcept(); ``` - *Type:* java.util.List 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 ```java import org.cdk8s.plus32.PersistentVolume; PersistentVolume.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .accessModes(java.util.List) // .claim(IPersistentVolumeClaim) // .mountOptions(java.util.List) // .reclaimPolicy(PersistentVolumeReclaimPolicy) // .storage(Size) // .storageClassName(java.lang.String) // .volumeMode(PersistentVolumeMode) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | java.util.List<PersistentVolumeAccessMode> | Contains all ways the volume can be mounted. | | claim | IPersistentVolumeClaim | Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. | | mountOptions | java.util.List | 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 | org.cdk8s.Size | What is the storage capacity of this volume. | | storageClassName | java.lang.String | Name of StorageClass to which this persistent volume belongs. | | volumeMode | PersistentVolumeMode | Defines what type of volume is required by the claim. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional - *Type:* java.util.List<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 - *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 - *Type:* java.util.List - *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 - *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 - *Type:* org.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 - *Type:* java.lang.String - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`^Optional - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `asVolume` ```java public Volume asVolume() ``` Convert the piece of storage into a concrete volume. ##### `bind` ```java public void bind(IPersistentVolumeClaim claim) ``` 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` ```java public PersistentVolumeClaim reserve() ``` 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` ```java import org.cdk8s.plus32.PersistentVolume; PersistentVolume.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromPersistentVolumeName` ```java import org.cdk8s.plus32.PersistentVolume; PersistentVolume.fromPersistentVolumeName(Construct scope, java.lang.String id, java.lang.String volumeName) ``` Imports a pv from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `volumeName`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.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 | java.util.List<PersistentVolumeAccessMode> | Access modes requirement of this claim. | | claim | IPersistentVolumeClaim | PVC this volume is bound to. | | mountOptions | java.util.List | Mount options of this volume. | | storage | org.cdk8s.Size | Storage size of this volume. | | storageClassName | java.lang.String | Storage class this volume belongs to. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public PersistentVolumeMode getMode(); ``` - *Type:* PersistentVolumeMode Volume mode of this volume. --- ##### `reclaimPolicy`^Required ```java public PersistentVolumeReclaimPolicy getReclaimPolicy(); ``` - *Type:* PersistentVolumeReclaimPolicy Reclaim policy of this volume. --- ##### `accessModes`^Optional ```java public java.util.List getAccessModes(); ``` - *Type:* java.util.List<PersistentVolumeAccessMode> Access modes requirement of this claim. --- ##### `claim`^Optional ```java public IPersistentVolumeClaim getClaim(); ``` - *Type:* IPersistentVolumeClaim PVC this volume is bound to. Undefined means this volume is not yet claimed by any PVC. --- ##### `mountOptions`^Optional ```java public java.util.List getMountOptions(); ``` - *Type:* java.util.List Mount options of this volume. --- ##### `storage`^Optional ```java public Size getStorage(); ``` - *Type:* org.cdk8s.Size Storage size of this volume. --- ##### `storageClassName`^Optional ```java public java.lang.String getStorageClassName(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.PersistentVolumeClaim; PersistentVolumeClaim.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .accessModes(java.util.List) // .storage(Size) // .storageClassName(java.lang.String) // .volume(IPersistentVolume) // .volumeMode(PersistentVolumeMode) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | java.util.List<PersistentVolumeAccessMode> | Contains the access modes the volume should support. | | storage | org.cdk8s.Size | Minimum storage size the volume should have. | | storageClassName | java.lang.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. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional - *Type:* java.util.List<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 - *Type:* org.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 - *Type:* java.lang.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 - *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 - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `bind` ```java public void bind(IPersistentVolume vol) ``` 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` ```java import org.cdk8s.plus32.PersistentVolumeClaim; PersistentVolumeClaim.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromClaimName` ```java import org.cdk8s.plus32.PersistentVolumeClaim; PersistentVolumeClaim.fromClaimName(Construct scope, java.lang.String id, java.lang.String claimName) ``` Imports a pvc from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `claimName`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | volumeMode | PersistentVolumeMode | Volume mode requirement of this claim. | | accessModes | java.util.List<PersistentVolumeAccessMode> | Access modes requirement of this claim. | | storage | org.cdk8s.Size | Storage requirement of this claim. | | storageClassName | java.lang.String | Storage class requirment of this claim. | | volume | IPersistentVolume | PV this claim is bound to. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public PersistentVolumeMode getVolumeMode(); ``` - *Type:* PersistentVolumeMode Volume mode requirement of this claim. --- ##### `accessModes`^Optional ```java public java.util.List getAccessModes(); ``` - *Type:* java.util.List<PersistentVolumeAccessMode> Access modes requirement of this claim. --- ##### `storage`^Optional ```java public Size getStorage(); ``` - *Type:* org.cdk8s.Size Storage requirement of this claim. --- ##### `storageClassName`^Optional ```java public java.lang.String getStorageClassName(); ``` - *Type:* java.lang.String Storage class requirment of this claim. --- ##### `volume`^Optional ```java public IPersistentVolume getVolume(); ``` - *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 ```java import org.cdk8s.plus32.Pod; Pod.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .automountServiceAccountToken(java.lang.Boolean) // .containers(java.util.List) // .dns(PodDnsProps) // .dockerRegistryAuth(ISecret) // .enableServiceLinks(java.lang.Boolean) // .hostAliases(java.util.List) // .hostNetwork(java.lang.Boolean) // .initContainers(java.util.List) // .isolate(java.lang.Boolean) // .restartPolicy(RestartPolicy) // .securityContext(PodSecurityContextProps) // .serviceAccount(IServiceAccount) // .shareProcessNamespace(java.lang.Boolean) // .terminationGracePeriod(Duration) // .volumes(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | java.lang.Boolean | Indicates whether a service account token should be automatically mounted. | | containers | java.util.List<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 | java.lang.Boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | java.util.List<HostAlias> | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | java.lang.Boolean | Host network for the pod. | | initContainers | java.util.List<ContainerProps> | List of initialization containers belonging to the pod. | | isolate | java.lang.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 | java.lang.Boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | org.cdk8s.Duration | Grace period until the pod is terminated. | | volumes | java.util.List<Volume> | List of volumes that can be mounted by containers belonging to the pod. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<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 - *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 - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<HostAlias> HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional - *Type:* java.lang.Boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional - *Type:* java.util.List<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 - *Type:* java.lang.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 - *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 - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional - *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 - *Type:* java.lang.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 - *Type:* org.cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional - *Type:* java.util.List<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) --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addContainer` ```java public Container addContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```java public void addHostAlias(HostAlias hostAlias) ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```java public Container addInitContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```java public void addVolume(Volume vol) ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```java public void attachContainer(Container cont) ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```java public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig() ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```java public IPodSelector toPodSelector() ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```java public PodSelectorConfig toPodSelectorConfig() ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```java public SubjectConfiguration toSubjectConfiguration() ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.Pod; Pod.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | automountServiceAccountToken | java.lang.Boolean | *No description.* | | containers | java.util.List<Container> | *No description.* | | dns | PodDns | *No description.* | | hostAliases | java.util.List<HostAlias> | *No description.* | | initContainers | java.util.List<Container> | *No description.* | | podMetadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | securityContext | PodSecurityContext | *No description.* | | shareProcessNamespace | java.lang.Boolean | *No description.* | | volumes | java.util.List<Volume> | *No description.* | | dockerRegistryAuth | ISecret | *No description.* | | enableServiceLinks | java.lang.Boolean | *No description.* | | hostNetwork | java.lang.Boolean | *No description.* | | restartPolicy | RestartPolicy | *No description.* | | serviceAccount | IServiceAccount | *No description.* | | terminationGracePeriod | org.cdk8s.Duration | *No description.* | | connections | PodConnections | *No description.* | | scheduling | PodScheduling | *No description.* | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getAutomountServiceAccountToken(); ``` - *Type:* java.lang.Boolean --- ##### `containers`^Required ```java public java.util.List getContainers(); ``` - *Type:* java.util.List<Container> --- ##### `dns`^Required ```java public PodDns getDns(); ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```java public java.util.List getHostAliases(); ``` - *Type:* java.util.List<HostAlias> --- ##### `initContainers`^Required ```java public java.util.List getInitContainers(); ``` - *Type:* java.util.List<Container> --- ##### `podMetadata`^Required ```java public ApiObjectMetadataDefinition getPodMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `securityContext`^Required ```java public PodSecurityContext getSecurityContext(); ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```java public java.lang.Boolean getShareProcessNamespace(); ``` - *Type:* java.lang.Boolean --- ##### `volumes`^Required ```java public java.util.List getVolumes(); ``` - *Type:* java.util.List<Volume> --- ##### `dockerRegistryAuth`^Optional ```java public ISecret getDockerRegistryAuth(); ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```java public java.lang.Boolean getEnableServiceLinks(); ``` - *Type:* java.lang.Boolean --- ##### `hostNetwork`^Optional ```java public java.lang.Boolean getHostNetwork(); ``` - *Type:* java.lang.Boolean --- ##### `restartPolicy`^Optional ```java public RestartPolicy getRestartPolicy(); ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```java public IServiceAccount getServiceAccount(); ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```java public Duration getTerminationGracePeriod(); ``` - *Type:* org.cdk8s.Duration --- ##### `connections`^Required ```java public PodConnections getConnections(); ``` - *Type:* PodConnections --- ##### `scheduling`^Required ```java public PodScheduling getScheduling(); ``` - *Type:* PodScheduling --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ADDRESS_LABEL | java.lang.String | This label is autoamtically added by cdk8s to any pod. | --- ##### `ADDRESS_LABEL`^Required ```java public java.lang.String getAddressLabel(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.Pods; new Pods(Construct scope, java.lang.String id);,new Pods(Construct scope, java.lang.String id, java.util.List expressions);,new Pods(Construct scope, java.lang.String id, java.util.List expressions, java.util.Map labels);,new Pods(Construct scope, java.lang.String id, java.util.List expressions, java.util.Map labels, INamespaceSelector namespaces); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | expressions | java.util.List<LabelExpression> | *No description.* | | labels | java.util.Map | *No description.* | | namespaces | INamespaceSelector | *No description.* | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `expressions`^Optional - *Type:* java.util.List<LabelExpression> --- ##### `labels`^Optional - *Type:* java.util.Map --- ##### `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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `toNetworkPolicyPeerConfig` ```java public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig() ``` > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```java public IPodSelector toPodSelector() ``` > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```java public PodSelectorConfig toPodSelectorConfig() ``` 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` ```java import org.cdk8s.plus32.Pods; Pods.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `all` ```java import org.cdk8s.plus32.Pods; Pods.all(Construct scope, java.lang.String id),Pods.all(Construct scope, java.lang.String id, PodsAllOptions options) ``` Select all pods. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `options`^Optional - *Type:* PodsAllOptions --- ##### `select` ```java import org.cdk8s.plus32.Pods; Pods.select(Construct scope, java.lang.String id, PodsSelectOptions options) ``` Select pods in the cluster with various selectors. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `options`^Required - *Type:* PodsSelectOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ### Resource - *Implements:* IResource, IApiResource, IApiEndpoint Base class for all Kubernetes objects in stdk8s. Represents a single resource. #### Initializers ```java import org.cdk8s.plus32.Resource; new Resource(Construct scope, java.lang.String id); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.Resource; Resource.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.Role; Role.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .rules(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | rules | java.util.List<RolePolicyRule> | A list of rules the role should allow. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `rules`^Optional - *Type:* java.util.List<RolePolicyRule> - *Default:* [] A list of rules the role should allow. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `allow` ```java public void allow(java.util.List verbs, IApiResource... resources) ``` 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:* java.util.List --- ###### `resources`^Required - *Type:* IApiResource... The resource(s) to apply to. --- ##### `allowCreate` ```java public void allowCreate(IApiResource... resources) ``` Add "create" permission for the resources. ###### `resources`^Required - *Type:* IApiResource... The resource(s) to apply to. --- ##### `allowDelete` ```java public void allowDelete(IApiResource... resources) ``` Add "delete" permission for the resources. ###### `resources`^Required - *Type:* IApiResource... The resource(s) to apply to. --- ##### `allowDeleteCollection` ```java public void allowDeleteCollection(IApiResource... resources) ``` Add "deletecollection" permission for the resources. ###### `resources`^Required - *Type:* IApiResource... The resource(s) to apply to. --- ##### `allowGet` ```java public void allowGet(IApiResource... resources) ``` Add "get" permission for the resources. ###### `resources`^Required - *Type:* IApiResource... The resource(s) to apply to. --- ##### `allowList` ```java public void allowList(IApiResource... resources) ``` Add "list" permission for the resources. ###### `resources`^Required - *Type:* IApiResource... The resource(s) to apply to. --- ##### `allowPatch` ```java public void allowPatch(IApiResource... resources) ``` Add "patch" permission for the resources. ###### `resources`^Required - *Type:* IApiResource... The resource(s) to apply to. --- ##### `allowRead` ```java public void allowRead(IApiResource... resources) ``` Add "get", "list", and "watch" permissions for the resources. ###### `resources`^Required - *Type:* IApiResource... The resource(s) to apply to. --- ##### `allowReadWrite` ```java public void allowReadWrite(IApiResource... resources) ``` 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` ```java public void allowUpdate(IApiResource... resources) ``` Add "update" permission for the resources. ###### `resources`^Required - *Type:* IApiResource... The resource(s) to apply to. --- ##### `allowWatch` ```java public void allowWatch(IApiResource... resources) ``` Add "watch" permission for the resources. ###### `resources`^Required - *Type:* IApiResource... The resource(s) to apply to. --- ##### `bind` ```java public RoleBinding bind(ISubject... subjects) ``` 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` ```java import org.cdk8s.plus32.Role; Role.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromRoleName` ```java import org.cdk8s.plus32.Role; Role.fromRoleName(Construct scope, java.lang.String id, java.lang.String name) ``` Imports a role from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | rules | java.util.List<RolePolicyRule> | Rules associaated with this Role. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.util.List getRules(); ``` - *Type:* java.util.List<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 ```java import org.cdk8s.plus32.RoleBinding; RoleBinding.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) .role(IRole) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | role | IRole | The role to bind to. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `role`^Required - *Type:* IRole The role to bind to. A RoleBinding can reference a Role or a ClusterRole. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addSubjects` ```java public void addSubjects(ISubject... subjects) ``` 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` ```java import org.cdk8s.plus32.RoleBinding; RoleBinding.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | role | IRole | *No description.* | | subjects | java.util.List<ISubject> | *No description.* | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public IRole getRole(); ``` - *Type:* IRole --- ##### `subjects`^Required ```java public java.util.List getSubjects(); ``` - *Type:* java.util.List<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 ```java import org.cdk8s.plus32.Secret; Secret.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .immutable(java.lang.Boolean) // .stringData(java.util.Map) // .type(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | java.lang.Boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | stringData | java.util.Map | stringData allows specifying non-binary secret data in string form. | | type | java.lang.String | Optional type associated with the secret. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional - *Type:* java.lang.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 - *Type:* java.util.Map 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 - *Type:* java.lang.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. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addStringData` ```java public void addStringData(java.lang.String key, java.lang.String value) ``` Adds a string data field to the secret. ###### `key`^Required - *Type:* java.lang.String Key. --- ###### `value`^Required - *Type:* java.lang.String Value. --- ##### `envValue` ```java public EnvValue envValue(java.lang.String key) public EnvValue envValue(java.lang.String key, EnvValueFromSecretOptions options) ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* java.lang.String --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions --- ##### `getStringData` ```java public java.lang.String getStringData(java.lang.String key) ``` Gets a string data by key or undefined. ###### `key`^Required - *Type:* java.lang.String Key. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromSecretName | Imports a secret from the cluster as a reference. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.Secret; Secret.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromSecretName` ```java import org.cdk8s.plus32.Secret; Secret.fromSecretName(Construct scope, java.lang.String id, java.lang.String name) ``` Imports a secret from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | immutable | java.lang.Boolean | Whether or not the secret is immutable. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getImmutable(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.Service; Service.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .clusterIP(java.lang.String) // .externalIPs(java.util.List) // .externalName(java.lang.String) // .loadBalancerSourceRanges(java.util.List) // .ports(java.util.List) // .publishNotReadyAddresses(java.lang.Boolean) // .selector(IPodSelector) // .type(ServiceType) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | clusterIP | java.lang.String | The IP address of the service and is usually assigned randomly by the master. | | externalIPs | java.util.List | A list of IP addresses for which nodes in the cluster will also accept traffic for this service. | | externalName | java.lang.String | The externalName to be used when ServiceType.EXTERNAL_NAME is set. | | loadBalancerSourceRanges | java.util.List | 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 | java.util.List<ServicePort> | The ports this service binds to. | | publishNotReadyAddresses | java.lang.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. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `clusterIP`^Optional - *Type:* java.lang.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 - *Type:* java.util.List - *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 - *Type:* java.lang.String - *Default:* No external name. The externalName to be used when ServiceType.EXTERNAL_NAME is set. --- ##### `loadBalancerSourceRanges`^Optional - *Type:* java.util.List 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 - *Type:* java.util.List<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 - *Type:* java.lang.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 - *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* ```java // Example automatically generated from non-compiling source. May contain errors. // select the pods of a specific deployment Object backend = new Deployment(this, "Backend", ...); Service.Builder.create(this, "Service").selector(backend).build(); // select all pods labeled with the `tier=backend` label Object backend = kplus.Pod.labeled(Map.of("tier", "backend")); Service.Builder.create(this, "Service").selector(backend).build(); ``` ##### `type`^Optional - *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 --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `bind` ```java public void bind(java.lang.Number port) public void bind(java.lang.Number port, ServiceBindOptions options) ``` Configure a port the service will bind to. This method can be called multiple times. ###### `port`^Required - *Type:* java.lang.Number The port definition. --- ###### `options`^Optional - *Type:* ServiceBindOptions --- ##### `exposeViaIngress` ```java public Ingress exposeViaIngress(java.lang.String path) public Ingress exposeViaIngress(java.lang.String path, ExposeServiceViaIngressOptions options) ``` Expose a service via an ingress using the specified path. ###### `path`^Required - *Type:* java.lang.String The path to expose the service under. --- ###### `options`^Optional - *Type:* ExposeServiceViaIngressOptions Additional options. --- ##### `select` ```java public void select(IPodSelector selector) ``` 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` ```java public void selectLabel(java.lang.String key, java.lang.String value) ``` 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:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.Service; Service.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | port | java.lang.Number | Return the first port of the service. | | ports | java.util.List<ServicePort> | Ports for this service. | | type | ServiceType | Determines how the Service is exposed. | | clusterIP | java.lang.String | The IP address of the service and is usually assigned randomly by the master. | | externalName | java.lang.String | The externalName to be used for EXTERNAL_NAME types. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Number getPort(); ``` - *Type:* java.lang.Number Return the first port of the service. --- ##### `ports`^Required ```java public java.util.List getPorts(); ``` - *Type:* java.util.List<ServicePort> Ports for this service. Use `bind()` to bind additional service ports. --- ##### `type`^Required ```java public ServiceType getType(); ``` - *Type:* ServiceType Determines how the Service is exposed. --- ##### `clusterIP`^Optional ```java public java.lang.String getClusterIP(); ``` - *Type:* java.lang.String The IP address of the service and is usually assigned randomly by the master. --- ##### `externalName`^Optional ```java public java.lang.String getExternalName(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.ServiceAccount; ServiceAccount.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .automountToken(java.lang.Boolean) // .secrets(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountToken | java.lang.Boolean | Indicates whether pods running as this service account should have an API token automatically mounted. | | secrets | java.util.List<ISecret> | List of secrets allowed to be used by pods running using this ServiceAccount. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountToken`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<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) --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addSecret` ```java public void addSecret(ISecret secr) ``` Allow a secret to be accessed by pods using this service account. ###### `secr`^Required - *Type:* ISecret The secret. --- ##### `toSubjectConfiguration` ```java public SubjectConfiguration toSubjectConfiguration() ``` 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` ```java import org.cdk8s.plus32.ServiceAccount; ServiceAccount.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromServiceAccountName` ```java import org.cdk8s.plus32.ServiceAccount; ServiceAccount.fromServiceAccountName(Construct scope, java.lang.String id, java.lang.String name),ServiceAccount.fromServiceAccountName(Construct scope, java.lang.String id, java.lang.String name, FromServiceAccountNameOptions options) ``` Imports a service account from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String The name of the service account resource. --- ###### `options`^Optional - *Type:* FromServiceAccountNameOptions additional options. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | automountToken | java.lang.Boolean | Whether or not a token is automatically mounted for this service account. | | secrets | java.util.List<ISecret> | List of secrets allowed to be used by pods running using this service account. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getAutomountToken(); ``` - *Type:* java.lang.Boolean Whether or not a token is automatically mounted for this service account. --- ##### `secrets`^Required ```java public java.util.List getSecrets(); ``` - *Type:* java.util.List<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 ```java import org.cdk8s.plus32.ServiceAccountTokenSecret; ServiceAccountTokenSecret.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .immutable(java.lang.Boolean) .serviceAccount(IServiceAccount) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | java.lang.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. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional - *Type:* java.lang.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 - *Type:* IServiceAccount The service account to store a secret for. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addStringData` ```java public void addStringData(java.lang.String key, java.lang.String value) ``` Adds a string data field to the secret. ###### `key`^Required - *Type:* java.lang.String Key. --- ###### `value`^Required - *Type:* java.lang.String Value. --- ##### `envValue` ```java public EnvValue envValue(java.lang.String key) public EnvValue envValue(java.lang.String key, EnvValueFromSecretOptions options) ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* java.lang.String --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions --- ##### `getStringData` ```java public java.lang.String getStringData(java.lang.String key) ``` Gets a string data by key or undefined. ###### `key`^Required - *Type:* java.lang.String Key. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromSecretName | Imports a secret from the cluster as a reference. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.ServiceAccountTokenSecret; ServiceAccountTokenSecret.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromSecretName` ```java import org.cdk8s.plus32.ServiceAccountTokenSecret; ServiceAccountTokenSecret.fromSecretName(Construct scope, java.lang.String id, java.lang.String name) ``` Imports a secret from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | immutable | java.lang.Boolean | Whether or not the secret is immutable. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getImmutable(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.SshAuthSecret; SshAuthSecret.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .immutable(java.lang.Boolean) .sshPrivateKey(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | java.lang.Boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | sshPrivateKey | java.lang.String | The SSH private key to use. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional - *Type:* java.lang.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 - *Type:* java.lang.String The SSH private key to use. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addStringData` ```java public void addStringData(java.lang.String key, java.lang.String value) ``` Adds a string data field to the secret. ###### `key`^Required - *Type:* java.lang.String Key. --- ###### `value`^Required - *Type:* java.lang.String Value. --- ##### `envValue` ```java public EnvValue envValue(java.lang.String key) public EnvValue envValue(java.lang.String key, EnvValueFromSecretOptions options) ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* java.lang.String --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions --- ##### `getStringData` ```java public java.lang.String getStringData(java.lang.String key) ``` Gets a string data by key or undefined. ###### `key`^Required - *Type:* java.lang.String Key. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromSecretName | Imports a secret from the cluster as a reference. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.SshAuthSecret; SshAuthSecret.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromSecretName` ```java import org.cdk8s.plus32.SshAuthSecret; SshAuthSecret.fromSecretName(Construct scope, java.lang.String id, java.lang.String name) ``` Imports a secret from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | immutable | java.lang.Boolean | Whether or not the secret is immutable. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getImmutable(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.StatefulSet; StatefulSet.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .automountServiceAccountToken(java.lang.Boolean) // .containers(java.util.List) // .dns(PodDnsProps) // .dockerRegistryAuth(ISecret) // .enableServiceLinks(java.lang.Boolean) // .hostAliases(java.util.List) // .hostNetwork(java.lang.Boolean) // .initContainers(java.util.List) // .isolate(java.lang.Boolean) // .restartPolicy(RestartPolicy) // .securityContext(PodSecurityContextProps) // .serviceAccount(IServiceAccount) // .shareProcessNamespace(java.lang.Boolean) // .terminationGracePeriod(Duration) // .volumes(java.util.List) // .podMetadata(ApiObjectMetadata) // .select(java.lang.Boolean) // .spread(java.lang.Boolean) // .minReady(Duration) // .podManagementPolicy(PodManagementPolicy) // .replicas(java.lang.Number) // .service(Service) // .strategy(StatefulSetUpdateStrategy) // .volumeClaimTemplates(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | java.lang.Boolean | Indicates whether a service account token should be automatically mounted. | | containers | java.util.List<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 | java.lang.Boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | java.util.List<HostAlias> | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | java.lang.Boolean | Host network for the pod. | | initContainers | java.util.List<ContainerProps> | List of initialization containers belonging to the pod. | | isolate | java.lang.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 | java.lang.Boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | org.cdk8s.Duration | Grace period until the pod is terminated. | | volumes | java.util.List<Volume> | List of volumes that can be mounted by containers belonging to the pod. | | podMetadata | org.cdk8s.ApiObjectMetadata | The pod metadata of this workload. | | select | java.lang.Boolean | Automatically allocates a pod label selector for this workload and add it to the pod metadata. | | spread | java.lang.Boolean | Automatically spread pods across hostname and zones. | | minReady | org.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 | java.lang.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 | java.util.List<PersistentVolumeClaimTemplateProps> | A list of PersistentVolumeClaim templates that will be created for each pod in the StatefulSet. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<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 - *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 - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<HostAlias> HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional - *Type:* java.lang.Boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional - *Type:* java.util.List<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 - *Type:* java.lang.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 - *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 - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional - *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 - *Type:* java.lang.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 - *Type:* org.cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional - *Type:* java.util.List<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 - *Type:* org.cdk8s.ApiObjectMetadata The pod metadata of this workload. --- ##### `select`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* org.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 - *Type:* PodManagementPolicy - *Default:* PodManagementPolicy.ORDERED_READY Pod management policy to use for this statefulset. --- ##### `replicas`^Optional - *Type:* java.lang.Number - *Default:* 1 Number of desired pods. --- ##### `service`^Optional - *Type:* Service - *Default:* A new headless service will be created. Service to associate with the statefulset. --- ##### `strategy`^Optional - *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 - *Type:* java.util.List<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. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addContainer` ```java public Container addContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```java public void addHostAlias(HostAlias hostAlias) ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```java public Container addInitContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```java public void addVolume(Volume vol) ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```java public void attachContainer(Container cont) ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```java public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig() ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```java public IPodSelector toPodSelector() ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```java public PodSelectorConfig toPodSelectorConfig() ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```java public SubjectConfiguration toSubjectConfiguration() ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) ##### `select` ```java public void select(LabelSelector... selectors) ``` Configure selectors for this workload. ###### `selectors`^Required - *Type:* LabelSelector... --- ##### `addVolumeClaimTemplate` ```java public void addVolumeClaimTemplate(PersistentVolumeClaimTemplateProps template) ``` ###### `template`^Required - *Type:* PersistentVolumeClaimTemplateProps --- ##### `markHasAutoscaler` ```java public void markHasAutoscaler() ``` Called on all IScalable targets when they are associated with an autoscaler. > [IScalable.markHasAutoscaler ()](IScalable.markHasAutoscaler ()) ##### `toScalingTarget` ```java public ScalingTarget toScalingTarget() ``` Return the target spec properties of this Scalable. > [IScalable.toScalingTarget ()](IScalable.toScalingTarget ()) #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.StatefulSet; StatefulSet.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | automountServiceAccountToken | java.lang.Boolean | *No description.* | | containers | java.util.List<Container> | *No description.* | | dns | PodDns | *No description.* | | hostAliases | java.util.List<HostAlias> | *No description.* | | initContainers | java.util.List<Container> | *No description.* | | podMetadata | org.cdk8s.ApiObjectMetadataDefinition | The metadata of pods in this workload. | | securityContext | PodSecurityContext | *No description.* | | shareProcessNamespace | java.lang.Boolean | *No description.* | | volumes | java.util.List<Volume> | *No description.* | | dockerRegistryAuth | ISecret | *No description.* | | enableServiceLinks | java.lang.Boolean | *No description.* | | hostNetwork | java.lang.Boolean | *No description.* | | restartPolicy | RestartPolicy | *No description.* | | serviceAccount | IServiceAccount | *No description.* | | terminationGracePeriod | org.cdk8s.Duration | *No description.* | | connections | PodConnections | *No description.* | | matchExpressions | java.util.List<LabelSelectorRequirement> | The expression matchers this workload will use in order to select pods. | | matchLabels | java.util.Map | The label matchers this workload will use in order to select pods. | | scheduling | WorkloadScheduling | *No description.* | | minReady | org.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 | java.lang.Number | Number of desired pods. | | hasAutoscaler | java.lang.Boolean | If this is a target of an autoscaler. | | volumeClaimTemplates | java.util.List<PersistentVolumeClaimTemplateProps> | *No description.* | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getAutomountServiceAccountToken(); ``` - *Type:* java.lang.Boolean --- ##### `containers`^Required ```java public java.util.List getContainers(); ``` - *Type:* java.util.List<Container> --- ##### `dns`^Required ```java public PodDns getDns(); ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```java public java.util.List getHostAliases(); ``` - *Type:* java.util.List<HostAlias> --- ##### `initContainers`^Required ```java public java.util.List getInitContainers(); ``` - *Type:* java.util.List<Container> --- ##### `podMetadata`^Required ```java public ApiObjectMetadataDefinition getPodMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition The metadata of pods in this workload. --- ##### `securityContext`^Required ```java public PodSecurityContext getSecurityContext(); ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```java public java.lang.Boolean getShareProcessNamespace(); ``` - *Type:* java.lang.Boolean --- ##### `volumes`^Required ```java public java.util.List getVolumes(); ``` - *Type:* java.util.List<Volume> --- ##### `dockerRegistryAuth`^Optional ```java public ISecret getDockerRegistryAuth(); ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```java public java.lang.Boolean getEnableServiceLinks(); ``` - *Type:* java.lang.Boolean --- ##### `hostNetwork`^Optional ```java public java.lang.Boolean getHostNetwork(); ``` - *Type:* java.lang.Boolean --- ##### `restartPolicy`^Optional ```java public RestartPolicy getRestartPolicy(); ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```java public IServiceAccount getServiceAccount(); ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```java public Duration getTerminationGracePeriod(); ``` - *Type:* org.cdk8s.Duration --- ##### `connections`^Required ```java public PodConnections getConnections(); ``` - *Type:* PodConnections --- ##### `matchExpressions`^Required ```java public java.util.List getMatchExpressions(); ``` - *Type:* java.util.List<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 ```java public java.util.Map getMatchLabels(); ``` - *Type:* java.util.Map The label matchers this workload will use in order to select pods. Returns a a copy. Use `select()` to add label matchers. --- ##### `scheduling`^Required ```java public WorkloadScheduling getScheduling(); ``` - *Type:* WorkloadScheduling --- ##### `minReady`^Required ```java public Duration getMinReady(); ``` - *Type:* org.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 ```java public PodManagementPolicy getPodManagementPolicy(); ``` - *Type:* PodManagementPolicy Management policy to use for the set. --- ##### `service`^Required ```java public Service getService(); ``` - *Type:* Service --- ##### `strategy`^Required ```java public StatefulSetUpdateStrategy getStrategy(); ``` - *Type:* StatefulSetUpdateStrategy The update startegy of this stateful set. --- ##### `replicas`^Optional ```java public java.lang.Number getReplicas(); ``` - *Type:* java.lang.Number Number of desired pods. --- ##### `hasAutoscaler`^Required ```java public java.lang.Boolean getHasAutoscaler(); ``` - *Type:* java.lang.Boolean If this is a target of an autoscaler. --- ##### `volumeClaimTemplates`^Optional ```java public java.util.List getVolumeClaimTemplates(); ``` - *Type:* java.util.List<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 ```java import org.cdk8s.plus32.TlsSecret; TlsSecret.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .immutable(java.lang.Boolean) .tlsCert(java.lang.String) .tlsKey(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | java.lang.Boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | tlsCert | java.lang.String | The TLS cert. | | tlsKey | java.lang.String | The TLS key. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional - *Type:* java.lang.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 - *Type:* java.lang.String The TLS cert. --- ##### `tlsKey`^Required - *Type:* java.lang.String The TLS key. --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addStringData` ```java public void addStringData(java.lang.String key, java.lang.String value) ``` Adds a string data field to the secret. ###### `key`^Required - *Type:* java.lang.String Key. --- ###### `value`^Required - *Type:* java.lang.String Value. --- ##### `envValue` ```java public EnvValue envValue(java.lang.String key) public EnvValue envValue(java.lang.String key, EnvValueFromSecretOptions options) ``` Returns EnvValue object from a secret's key. ###### `key`^Required - *Type:* java.lang.String --- ###### `options`^Optional - *Type:* EnvValueFromSecretOptions --- ##### `getStringData` ```java public java.lang.String getStringData(java.lang.String key) ``` Gets a string data by key or undefined. ###### `key`^Required - *Type:* java.lang.String Key. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromSecretName | Imports a secret from the cluster as a reference. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.TlsSecret; TlsSecret.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromSecretName` ```java import org.cdk8s.plus32.TlsSecret; TlsSecret.fromSecretName(Construct scope, java.lang.String id, java.lang.String name) ``` Imports a secret from the cluster as a reference. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | immutable | java.lang.Boolean | Whether or not the secret is immutable. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getImmutable(); ``` - *Type:* java.lang.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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `toSubjectConfiguration` ```java public SubjectConfiguration toSubjectConfiguration() ``` 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` ```java import org.cdk8s.plus32.User; User.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromName` ```java import org.cdk8s.plus32.User; User.fromName(Construct scope, java.lang.String id, java.lang.String name) ``` Reference a user in the cluster by name. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | kind | java.lang.String | *No description.* | | name | java.lang.String | *No description.* | | apiGroup | java.lang.String | *No description.* | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String --- ##### `apiGroup`^Optional ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asVolume` ```java public Volume asVolume() ``` 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` ```java import org.cdk8s.plus32.Volume; Volume.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- ##### `fromAwsElasticBlockStore` ```java import org.cdk8s.plus32.Volume; Volume.fromAwsElasticBlockStore(Construct scope, java.lang.String id, java.lang.String volumeId),Volume.fromAwsElasticBlockStore(Construct scope, java.lang.String id, java.lang.String volumeId, AwsElasticBlockStoreVolumeOptions options) ``` 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:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `volumeId`^Required - *Type:* java.lang.String --- ###### `options`^Optional - *Type:* AwsElasticBlockStoreVolumeOptions --- ##### `fromAzureDisk` ```java import org.cdk8s.plus32.Volume; Volume.fromAzureDisk(Construct scope, java.lang.String id, java.lang.String diskName, java.lang.String diskUri),Volume.fromAzureDisk(Construct scope, java.lang.String id, java.lang.String diskName, java.lang.String diskUri, AzureDiskVolumeOptions options) ``` Mounts a Microsoft Azure Data Disk into a pod. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `diskName`^Required - *Type:* java.lang.String --- ###### `diskUri`^Required - *Type:* java.lang.String --- ###### `options`^Optional - *Type:* AzureDiskVolumeOptions --- ##### `fromConfigMap` ```java import org.cdk8s.plus32.Volume; Volume.fromConfigMap(Construct scope, java.lang.String id, IConfigMap configMap),Volume.fromConfigMap(Construct scope, java.lang.String id, IConfigMap configMap, ConfigMapVolumeOptions options) ``` 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:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `configMap`^Required - *Type:* IConfigMap The config map to use to populate the volume. --- ###### `options`^Optional - *Type:* ConfigMapVolumeOptions Options. --- ##### `fromCsi` ```java import org.cdk8s.plus32.Volume; Volume.fromCsi(Construct scope, java.lang.String id, java.lang.String driver),Volume.fromCsi(Construct scope, java.lang.String id, java.lang.String driver, CsiVolumeOptions options) ``` 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:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `driver`^Required - *Type:* java.lang.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` ```java import org.cdk8s.plus32.Volume; Volume.fromEmptyDir(Construct scope, java.lang.String id, java.lang.String name),Volume.fromEmptyDir(Construct scope, java.lang.String id, java.lang.String name, EmptyDirVolumeOptions options) ``` 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:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- ###### `options`^Optional - *Type:* EmptyDirVolumeOptions Additional options. --- ##### `fromGcePersistentDisk` ```java import org.cdk8s.plus32.Volume; Volume.fromGcePersistentDisk(Construct scope, java.lang.String id, java.lang.String pdName),Volume.fromGcePersistentDisk(Construct scope, java.lang.String id, java.lang.String pdName, GCEPersistentDiskVolumeOptions options) ``` 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:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `pdName`^Required - *Type:* java.lang.String --- ###### `options`^Optional - *Type:* GCEPersistentDiskVolumeOptions --- ##### `fromHostPath` ```java import org.cdk8s.plus32.Volume; Volume.fromHostPath(Construct scope, java.lang.String id, java.lang.String name, HostPathVolumeOptions options) ``` 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:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- ###### `options`^Required - *Type:* HostPathVolumeOptions --- ##### `fromName` ```java import org.cdk8s.plus32.Volume; Volume.fromName(Construct scope, java.lang.String id, java.lang.String name) ``` Create a volume with an arbitrary name and no configuration. ###### `scope`^Required - *Type:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- ##### `fromNfs` ```java import org.cdk8s.plus32.Volume; Volume.fromNfs(Construct scope, java.lang.String id, java.lang.String name, NfsVolumeOptions options) ``` 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:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `name`^Required - *Type:* java.lang.String --- ###### `options`^Required - *Type:* NfsVolumeOptions --- ##### `fromPersistentVolumeClaim` ```java import org.cdk8s.plus32.Volume; Volume.fromPersistentVolumeClaim(Construct scope, java.lang.String id, IPersistentVolumeClaim claim),Volume.fromPersistentVolumeClaim(Construct scope, java.lang.String id, IPersistentVolumeClaim claim, PersistentVolumeClaimVolumeOptions options) ``` 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:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `claim`^Required - *Type:* IPersistentVolumeClaim --- ###### `options`^Optional - *Type:* PersistentVolumeClaimVolumeOptions --- ##### `fromSecret` ```java import org.cdk8s.plus32.Volume; Volume.fromSecret(Construct scope, java.lang.String id, ISecret secr),Volume.fromSecret(Construct scope, java.lang.String id, ISecret secr, SecretVolumeOptions options) ``` 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:* software.constructs.Construct --- ###### `id`^Required - *Type:* java.lang.String --- ###### `secr`^Required - *Type:* ISecret The secret to use to populate the volume. --- ###### `options`^Optional - *Type:* SecretVolumeOptions Options. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | name | java.lang.String | *No description.* | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.Workload; Workload.Builder.create(Construct scope, java.lang.String id) // .metadata(ApiObjectMetadata) // .automountServiceAccountToken(java.lang.Boolean) // .containers(java.util.List) // .dns(PodDnsProps) // .dockerRegistryAuth(ISecret) // .enableServiceLinks(java.lang.Boolean) // .hostAliases(java.util.List) // .hostNetwork(java.lang.Boolean) // .initContainers(java.util.List) // .isolate(java.lang.Boolean) // .restartPolicy(RestartPolicy) // .securityContext(PodSecurityContextProps) // .serviceAccount(IServiceAccount) // .shareProcessNamespace(java.lang.Boolean) // .terminationGracePeriod(Duration) // .volumes(java.util.List) // .podMetadata(ApiObjectMetadata) // .select(java.lang.Boolean) // .spread(java.lang.Boolean) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | java.lang.Boolean | Indicates whether a service account token should be automatically mounted. | | containers | java.util.List<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 | java.lang.Boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | java.util.List<HostAlias> | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | java.lang.Boolean | Host network for the pod. | | initContainers | java.util.List<ContainerProps> | List of initialization containers belonging to the pod. | | isolate | java.lang.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 | java.lang.Boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | org.cdk8s.Duration | Grace period until the pod is terminated. | | volumes | java.util.List<Volume> | List of volumes that can be mounted by containers belonging to the pod. | | podMetadata | org.cdk8s.ApiObjectMetadata | The pod metadata of this workload. | | select | java.lang.Boolean | Automatically allocates a pod label selector for this workload and add it to the pod metadata. | | spread | java.lang.Boolean | Automatically spread pods across hostname and zones. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `metadata`^Optional - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<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 - *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 - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional - *Type:* java.lang.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 - *Type:* java.util.List<HostAlias> HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional - *Type:* java.lang.Boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional - *Type:* java.util.List<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 - *Type:* java.lang.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 - *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 - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional - *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 - *Type:* java.lang.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 - *Type:* org.cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional - *Type:* java.util.List<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 - *Type:* org.cdk8s.ApiObjectMetadata The pod metadata of this workload. --- ##### `select`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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) --- #### 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` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `with` ```java public IConstruct with(IMixin... mixins) ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* software.constructs.IMixin... The mixins to apply. --- ##### `asApiResource` ```java public IApiResource asApiResource() ``` Return the IApiResource this object represents. ##### `asNonApiResource` ```java public java.lang.String asNonApiResource() ``` Return the non resource url this object represents. ##### `addContainer` ```java public Container addContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addHostAlias` ```java public void addHostAlias(HostAlias hostAlias) ``` ###### `hostAlias`^Required - *Type:* HostAlias --- ##### `addInitContainer` ```java public Container addInitContainer(ContainerProps cont) ``` ###### `cont`^Required - *Type:* ContainerProps --- ##### `addVolume` ```java public void addVolume(Volume vol) ``` ###### `vol`^Required - *Type:* Volume --- ##### `attachContainer` ```java public void attachContainer(Container cont) ``` ###### `cont`^Required - *Type:* Container --- ##### `toNetworkPolicyPeerConfig` ```java public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig() ``` Return the configuration of this peer. > [INetworkPolicyPeer.toNetworkPolicyPeerConfig ()](INetworkPolicyPeer.toNetworkPolicyPeerConfig ()) ##### `toPodSelector` ```java public IPodSelector toPodSelector() ``` Convert the peer into a pod selector, if possible. > [INetworkPolicyPeer.toPodSelector ()](INetworkPolicyPeer.toPodSelector ()) ##### `toPodSelectorConfig` ```java public PodSelectorConfig toPodSelectorConfig() ``` Return the configuration of this selector. > [IPodSelector.toPodSelectorConfig ()](IPodSelector.toPodSelectorConfig ()) ##### `toSubjectConfiguration` ```java public SubjectConfiguration toSubjectConfiguration() ``` Return the subject configuration. > [ISubect.toSubjectConfiguration ()](ISubect.toSubjectConfiguration ()) ##### `select` ```java public void select(LabelSelector... selectors) ``` Configure selectors for this workload. ###### `selectors`^Required - *Type:* LabelSelector... --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import org.cdk8s.plus32.Workload; Workload.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | apiGroup | java.lang.String | The group portion of the API version (e.g. "authorization.k8s.io"). | | apiVersion | java.lang.String | The object's API version (e.g. "authorization.k8s.io/v1"). | | kind | java.lang.String | The object kind (e.g. "Deployment"). | | metadata | org.cdk8s.ApiObjectMetadataDefinition | *No description.* | | name | java.lang.String | The name of this API object. | | permissions | ResourcePermissions | *No description.* | | resourceType | java.lang.String | The name of a resource type as it appears in the relevant API endpoint. | | resourceName | java.lang.String | The unique, namespace-global, name of an object inside the Kubernetes cluster. | | automountServiceAccountToken | java.lang.Boolean | *No description.* | | containers | java.util.List<Container> | *No description.* | | dns | PodDns | *No description.* | | hostAliases | java.util.List<HostAlias> | *No description.* | | initContainers | java.util.List<Container> | *No description.* | | podMetadata | org.cdk8s.ApiObjectMetadataDefinition | The metadata of pods in this workload. | | securityContext | PodSecurityContext | *No description.* | | shareProcessNamespace | java.lang.Boolean | *No description.* | | volumes | java.util.List<Volume> | *No description.* | | dockerRegistryAuth | ISecret | *No description.* | | enableServiceLinks | java.lang.Boolean | *No description.* | | hostNetwork | java.lang.Boolean | *No description.* | | restartPolicy | RestartPolicy | *No description.* | | serviceAccount | IServiceAccount | *No description.* | | terminationGracePeriod | org.cdk8s.Duration | *No description.* | | connections | PodConnections | *No description.* | | matchExpressions | java.util.List<LabelSelectorRequirement> | The expression matchers this workload will use in order to select pods. | | matchLabels | java.util.Map | The label matchers this workload will use in order to select pods. | | scheduling | WorkloadScheduling | *No description.* | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`^Required ```java public java.lang.String getApiVersion(); ``` - *Type:* java.lang.String The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`^Required ```java public java.lang.String getKind(); ``` - *Type:* java.lang.String The object kind (e.g. "Deployment"). --- ##### `metadata`^Required ```java public ApiObjectMetadataDefinition getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of this API object. --- ##### `permissions`^Required ```java public ResourcePermissions getPermissions(); ``` - *Type:* ResourcePermissions --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.String The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`^Optional ```java public java.lang.String getResourceName(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getAutomountServiceAccountToken(); ``` - *Type:* java.lang.Boolean --- ##### `containers`^Required ```java public java.util.List getContainers(); ``` - *Type:* java.util.List<Container> --- ##### `dns`^Required ```java public PodDns getDns(); ``` - *Type:* PodDns --- ##### `hostAliases`^Required ```java public java.util.List getHostAliases(); ``` - *Type:* java.util.List<HostAlias> --- ##### `initContainers`^Required ```java public java.util.List getInitContainers(); ``` - *Type:* java.util.List<Container> --- ##### `podMetadata`^Required ```java public ApiObjectMetadataDefinition getPodMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadataDefinition The metadata of pods in this workload. --- ##### `securityContext`^Required ```java public PodSecurityContext getSecurityContext(); ``` - *Type:* PodSecurityContext --- ##### `shareProcessNamespace`^Required ```java public java.lang.Boolean getShareProcessNamespace(); ``` - *Type:* java.lang.Boolean --- ##### `volumes`^Required ```java public java.util.List getVolumes(); ``` - *Type:* java.util.List<Volume> --- ##### `dockerRegistryAuth`^Optional ```java public ISecret getDockerRegistryAuth(); ``` - *Type:* ISecret --- ##### `enableServiceLinks`^Optional ```java public java.lang.Boolean getEnableServiceLinks(); ``` - *Type:* java.lang.Boolean --- ##### `hostNetwork`^Optional ```java public java.lang.Boolean getHostNetwork(); ``` - *Type:* java.lang.Boolean --- ##### `restartPolicy`^Optional ```java public RestartPolicy getRestartPolicy(); ``` - *Type:* RestartPolicy --- ##### `serviceAccount`^Optional ```java public IServiceAccount getServiceAccount(); ``` - *Type:* IServiceAccount --- ##### `terminationGracePeriod`^Optional ```java public Duration getTerminationGracePeriod(); ``` - *Type:* org.cdk8s.Duration --- ##### `connections`^Required ```java public PodConnections getConnections(); ``` - *Type:* PodConnections --- ##### `matchExpressions`^Required ```java public java.util.List getMatchExpressions(); ``` - *Type:* java.util.List<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 ```java public java.util.Map getMatchLabels(); ``` - *Type:* java.util.Map The label matchers this workload will use in order to select pods. Returns a a copy. Use `select()` to add label matchers. --- ##### `scheduling`^Required ```java public WorkloadScheduling getScheduling(); ``` - *Type:* WorkloadScheduling --- ## Structs ### AbstractPodProps Properties for `AbstractPod`. #### Initializer ```java import org.cdk8s.plus32.AbstractPodProps; AbstractPodProps.builder() // .metadata(ApiObjectMetadata) // .automountServiceAccountToken(java.lang.Boolean) // .containers(java.util.List) // .dns(PodDnsProps) // .dockerRegistryAuth(ISecret) // .enableServiceLinks(java.lang.Boolean) // .hostAliases(java.util.List) // .hostNetwork(java.lang.Boolean) // .initContainers(java.util.List) // .isolate(java.lang.Boolean) // .restartPolicy(RestartPolicy) // .securityContext(PodSecurityContextProps) // .serviceAccount(IServiceAccount) // .shareProcessNamespace(java.lang.Boolean) // .terminationGracePeriod(Duration) // .volumes(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | automountServiceAccountToken | java.lang.Boolean | Indicates whether a service account token should be automatically mounted. | | containers | java.util.List<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 | java.lang.Boolean | Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | | hostAliases | java.util.List<HostAlias> | HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. | | hostNetwork | java.lang.Boolean | Host network for the pod. | | initContainers | java.util.List<ContainerProps> | List of initialization containers belonging to the pod. | | isolate | java.lang.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 | java.lang.Boolean | When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. | | terminationGracePeriod | org.cdk8s.Duration | Grace period until the pod is terminated. | | volumes | java.util.List<Volume> | List of volumes that can be mounted by containers belonging to the pod. | --- ##### `metadata`^Optional ```java public ApiObjectMetadata getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`^Optional ```java public java.lang.Boolean getAutomountServiceAccountToken(); ``` - *Type:* java.lang.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 ```java public java.util.List getContainers(); ``` - *Type:* java.util.List<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 ```java public PodDnsProps getDns(); ``` - *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 ```java public ISecret getDockerRegistryAuth(); ``` - *Type:* ISecret - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `enableServiceLinks`^Optional ```java public java.lang.Boolean getEnableServiceLinks(); ``` - *Type:* java.lang.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 ```java public java.util.List getHostAliases(); ``` - *Type:* java.util.List<HostAlias> HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `hostNetwork`^Optional ```java public java.lang.Boolean getHostNetwork(); ``` - *Type:* java.lang.Boolean - *Default:* false Host network for the pod. --- ##### `initContainers`^Optional ```java public java.util.List getInitContainers(); ``` - *Type:* java.util.List<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 ```java public java.lang.Boolean getIsolate(); ``` - *Type:* java.lang.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 ```java public RestartPolicy getRestartPolicy(); ``` - *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 ```java public PodSecurityContextProps getSecurityContext(); ``` - *Type:* PodSecurityContextProps - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`^Optional ```java public IServiceAccount getServiceAccount(); ``` - *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 ```java public java.lang.Boolean getShareProcessNamespace(); ``` - *Type:* java.lang.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 ```java public Duration getTerminationGracePeriod(); ``` - *Type:* org.cdk8s.Duration - *Default:* Duration.seconds(30) Grace period until the pod is terminated. --- ##### `volumes`^Optional ```java public java.util.List getVolumes(); ``` - *Type:* java.util.List<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 ```java import org.cdk8s.plus32.AddDeploymentOptions; AddDeploymentOptions.builder() // .name(java.lang.String) // .nodePort(java.lang.Number) // .protocol(Protocol) // .targetPort(java.lang.Number) // .port(java.lang.Number) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | The name of this port within the service. | | nodePort | java.lang.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 | java.lang.Number | The port number the service will redirect to. | | port | java.lang.Number | The port number the service will bind to. | --- ##### `name`^Optional ```java public java.lang.String getName(); ``` - *Type:* java.lang.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 ```java public java.lang.Number getNodePort(); ``` - *Type:* java.lang.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 ```java public Protocol getProtocol(); ``` - *Type:* Protocol - *Default:* Protocol.TCP The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. --- ##### `targetPort`^Optional ```java public java.lang.Number getTargetPort(); ``` - *Type:* java.lang.Number - *Default:* The value of `port` will be used. The port number the service will redirect to. --- ##### `port`^Optional ```java public java.lang.Number getPort(); ``` - *Type:* java.lang.Number - *Default:* Copied from the first container of the deployment. The port number the service will bind to. --- ### AddDirectoryOptions Options for `configmap.addDirectory()`. #### Initializer ```java import org.cdk8s.plus32.AddDirectoryOptions; AddDirectoryOptions.builder() // .exclude(java.util.List) // .keyPrefix(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | exclude | java.util.List | Glob patterns to exclude when adding files. | | keyPrefix | java.lang.String | A prefix to add to all keys in the config map. | --- ##### `exclude`^Optional ```java public java.util.List getExclude(); ``` - *Type:* java.util.List - *Default:* include all files Glob patterns to exclude when adding files. --- ##### `keyPrefix`^Optional ```java public java.lang.String getKeyPrefix(); ``` - *Type:* java.lang.String - *Default:* "" A prefix to add to all keys in the config map. --- ### Affinity Affinity is a group of affinity scheduling rules. #### Initializer ```java import org.cdk8s.plus32.k8s.Affinity; Affinity.builder() // .nodeAffinity(NodeAffinity) // .podAffinity(PodAffinity) // .podAntiAffinity(PodAntiAffinity) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nodeAffinity | org.cdk8s.plus32.k8s.NodeAffinity | Describes node affinity scheduling rules for the pod. | | podAffinity | org.cdk8s.plus32.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 | org.cdk8s.plus32.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 ```java public NodeAffinity getNodeAffinity(); ``` - *Type:* org.cdk8s.plus32.k8s.NodeAffinity Describes node affinity scheduling rules for the pod. --- ##### `podAffinity`^Optional ```java public PodAffinity getPodAffinity(); ``` - *Type:* org.cdk8s.plus32.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 ```java public PodAntiAffinity getPodAntiAffinity(); ``` - *Type:* org.cdk8s.plus32.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 ```java import org.cdk8s.plus32.k8s.AggregationRule; AggregationRule.builder() // .clusterRoleSelectors(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterRoleSelectors | java.util.List | ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. | --- ##### `clusterRoleSelectors`^Optional ```java public java.util.List getClusterRoleSelectors(); ``` - *Type:* java.util.List 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 ```java import org.cdk8s.plus32.ApiResourceOptions; ApiResourceOptions.builder() .apiGroup(java.lang.String) .resourceType(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiGroup | java.lang.String | The group portion of the API version (e.g. `authorization.k8s.io`). | | resourceType | java.lang.String | The name of the resource type as it appears in the relevant API endpoint. | --- ##### `apiGroup`^Required ```java public java.lang.String getApiGroup(); ``` - *Type:* java.lang.String The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`^Required ```java public java.lang.String getResourceType(); ``` - *Type:* java.lang.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* ```java // Example automatically generated from non-compiling source. May contain errors. -"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 ```java import org.cdk8s.plus32.k8s.ApiServiceSpec; ApiServiceSpec.builder() .groupPriorityMinimum(java.lang.Number) .versionPriority(java.lang.Number) // .caBundle(java.lang.String) // .group(java.lang.String) // .insecureSkipTlsVerify(java.lang.Boolean) // .service(ServiceReference) // .version(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | groupPriorityMinimum | java.lang.Number | GroupPriorityMinimum is the priority this group should have at least. | | versionPriority | java.lang.Number | VersionPriority controls the ordering of this API version inside of its group. | | caBundle | java.lang.String | CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. | | group | java.lang.String | Group is the API group name this server hosts. | | insecureSkipTlsVerify | java.lang.Boolean | InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. | | service | org.cdk8s.plus32.k8s.ServiceReference | Service is a reference to the service for this API server. | | version | java.lang.String | Version is the API version this server hosts. | --- ##### `groupPriorityMinimum`^Required ```java public java.lang.Number getGroupPriorityMinimum(); ``` - *Type:* java.lang.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 ```java public java.lang.Number getVersionPriority(); ``` - *Type:* java.lang.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 ```java public java.lang.String getCaBundle(); ``` - *Type:* java.lang.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 ```java public java.lang.String getGroup(); ``` - *Type:* java.lang.String Group is the API group name this server hosts. --- ##### `insecureSkipTlsVerify`^Optional ```java public java.lang.Boolean getInsecureSkipTlsVerify(); ``` - *Type:* java.lang.Boolean InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. --- ##### `service`^Optional ```java public ServiceReference getService(); ``` - *Type:* org.cdk8s.plus32.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 ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String Version is the API version this server hosts. For example, "v1" --- ### AppArmorProfile AppArmorProfile defines a pod or container's AppArmor settings. #### Initializer ```java import org.cdk8s.plus32.k8s.AppArmorProfile; AppArmorProfile.builder() .type(java.lang.String) // .localhostProfile(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | java.lang.String | type indicates which kind of AppArmor profile will be applied. | | localhostProfile | java.lang.String | localhostProfile indicates a profile loaded on the node that should be used. | --- ##### `type`^Required ```java public java.lang.String getType(); ``` - *Type:* java.lang.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 ```java public java.lang.String getLocalhostProfile(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.k8s.ApplyConfigurationV1Alpha1; ApplyConfigurationV1Alpha1.builder() // .expression(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | java.lang.String | expression will be evaluated by CEL to create an apply configuration. ref: https://github.com/google/cel-spec. | --- ##### `expression`^Optional ```java public java.lang.String getExpression(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.k8s.AuditAnnotation; AuditAnnotation.builder() .key(java.lang.String) .valueExpression(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | java.lang.String | key specifies the audit annotation key. | | valueExpression | java.lang.String | valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. | --- ##### `key`^Required ```java public java.lang.String getKey(); ``` - *Type:* java.lang.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 ```java public java.lang.String getValueExpression(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.k8s.AuditAnnotationV1Beta1; AuditAnnotationV1Beta1.builder() .key(java.lang.String) .valueExpression(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | java.lang.String | key specifies the audit annotation key. | | valueExpression | java.lang.String | valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. | --- ##### `key`^Required ```java public java.lang.String getKey(); ``` - *Type:* java.lang.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 ```java public java.lang.String getValueExpression(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.AwsElasticBlockStorePersistentVolumeProps; AwsElasticBlockStorePersistentVolumeProps.builder() // .metadata(ApiObjectMetadata) // .accessModes(java.util.List) // .claim(IPersistentVolumeClaim) // .mountOptions(java.util.List) // .reclaimPolicy(PersistentVolumeReclaimPolicy) // .storage(Size) // .storageClassName(java.lang.String) // .volumeMode(PersistentVolumeMode) .volumeId(java.lang.String) // .fsType(java.lang.String) // .partition(java.lang.Number) // .readOnly(java.lang.Boolean) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | java.util.List<PersistentVolumeAccessMode> | Contains all ways the volume can be mounted. | | claim | IPersistentVolumeClaim | Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. | | mountOptions | java.util.List | 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 | org.cdk8s.Size | What is the storage capacity of this volume. | | storageClassName | java.lang.String | Name of StorageClass to which this persistent volume belongs. | | volumeMode | PersistentVolumeMode | Defines what type of volume is required by the claim. | | volumeId | java.lang.String | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). | | fsType | java.lang.String | Filesystem type of the volume that you want to mount. | | partition | java.lang.Number | The partition in the volume that you want to mount. | | readOnly | java.lang.Boolean | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". | --- ##### `metadata`^Optional ```java public ApiObjectMetadata getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional ```java public java.util.List getAccessModes(); ``` - *Type:* java.util.List<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 ```java public IPersistentVolumeClaim getClaim(); ``` - *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 ```java public java.util.List getMountOptions(); ``` - *Type:* java.util.List - *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 ```java public PersistentVolumeReclaimPolicy getReclaimPolicy(); ``` - *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 ```java public Size getStorage(); ``` - *Type:* org.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 ```java public java.lang.String getStorageClassName(); ``` - *Type:* java.lang.String - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`^Optional ```java public PersistentVolumeMode getVolumeMode(); ``` - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ##### `volumeId`^Required ```java public java.lang.String getVolumeId(); ``` - *Type:* java.lang.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 ```java public java.lang.String getFsType(); ``` - *Type:* java.lang.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 ```java public java.lang.Number getPartition(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getReadOnly(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.AwsElasticBlockStoreVolumeOptions; AwsElasticBlockStoreVolumeOptions.builder() // .fsType(java.lang.String) // .name(java.lang.String) // .partition(java.lang.Number) // .readOnly(java.lang.Boolean) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fsType | java.lang.String | Filesystem type of the volume that you want to mount. | | name | java.lang.String | The volume name. | | partition | java.lang.Number | The partition in the volume that you want to mount. | | readOnly | java.lang.Boolean | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". | --- ##### `fsType`^Optional ```java public java.lang.String getFsType(); ``` - *Type:* java.lang.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 ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* auto-generated The volume name. --- ##### `partition`^Optional ```java public java.lang.Number getPartition(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getReadOnly(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.k8s.AwsElasticBlockStoreVolumeSource; AwsElasticBlockStoreVolumeSource.builder() .volumeId(java.lang.String) // .fsType(java.lang.String) // .partition(java.lang.Number) // .readOnly(java.lang.Boolean) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | volumeId | java.lang.String | volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). | | fsType | java.lang.String | fsType is the filesystem type of the volume that you want to mount. | | partition | java.lang.Number | partition is the partition in the volume that you want to mount. | | readOnly | java.lang.Boolean | readOnly value true will force the readOnly setting in VolumeMounts. | --- ##### `volumeId`^Required ```java public java.lang.String getVolumeId(); ``` - *Type:* java.lang.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 ```java public java.lang.String getFsType(); ``` - *Type:* java.lang.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 ```java public java.lang.Number getPartition(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getReadOnly(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.AzureDiskPersistentVolumeProps; AzureDiskPersistentVolumeProps.builder() // .metadata(ApiObjectMetadata) // .accessModes(java.util.List) // .claim(IPersistentVolumeClaim) // .mountOptions(java.util.List) // .reclaimPolicy(PersistentVolumeReclaimPolicy) // .storage(Size) // .storageClassName(java.lang.String) // .volumeMode(PersistentVolumeMode) .diskName(java.lang.String) .diskUri(java.lang.String) // .cachingMode(AzureDiskPersistentVolumeCachingMode) // .fsType(java.lang.String) // .kind(AzureDiskPersistentVolumeKind) // .readOnly(java.lang.Boolean) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | accessModes | java.util.List<PersistentVolumeAccessMode> | Contains all ways the volume can be mounted. | | claim | IPersistentVolumeClaim | Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. | | mountOptions | java.util.List | 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 | org.cdk8s.Size | What is the storage capacity of this volume. | | storageClassName | java.lang.String | Name of StorageClass to which this persistent volume belongs. | | volumeMode | PersistentVolumeMode | Defines what type of volume is required by the claim. | | diskName | java.lang.String | The Name of the data disk in the blob storage. | | diskUri | java.lang.String | The URI the data disk in the blob storage. | | cachingMode | AzureDiskPersistentVolumeCachingMode | Host Caching mode. | | fsType | java.lang.String | Filesystem type to mount. | | kind | AzureDiskPersistentVolumeKind | Kind of disk. | | readOnly | java.lang.Boolean | Force the ReadOnly setting in VolumeMounts. | --- ##### `metadata`^Optional ```java public ApiObjectMetadata getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`^Optional ```java public java.util.List getAccessModes(); ``` - *Type:* java.util.List<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 ```java public IPersistentVolumeClaim getClaim(); ``` - *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 ```java public java.util.List getMountOptions(); ``` - *Type:* java.util.List - *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 ```java public PersistentVolumeReclaimPolicy getReclaimPolicy(); ``` - *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 ```java public Size getStorage(); ``` - *Type:* org.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 ```java public java.lang.String getStorageClassName(); ``` - *Type:* java.lang.String - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`^Optional ```java public PersistentVolumeMode getVolumeMode(); ``` - *Type:* PersistentVolumeMode - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ##### `diskName`^Required ```java public java.lang.String getDiskName(); ``` - *Type:* java.lang.String The Name of the data disk in the blob storage. --- ##### `diskUri`^Required ```java public java.lang.String getDiskUri(); ``` - *Type:* java.lang.String The URI the data disk in the blob storage. --- ##### `cachingMode`^Optional ```java public AzureDiskPersistentVolumeCachingMode getCachingMode(); ``` - *Type:* AzureDiskPersistentVolumeCachingMode - *Default:* AzureDiskPersistentVolumeCachingMode.NONE. Host Caching mode. --- ##### `fsType`^Optional ```java public java.lang.String getFsType(); ``` - *Type:* java.lang.String - *Default:* 'ext4' Filesystem type to mount. Must be a filesystem type supported by the host operating system. --- ##### `kind`^Optional ```java public AzureDiskPersistentVolumeKind getKind(); ``` - *Type:* AzureDiskPersistentVolumeKind - *Default:* AzureDiskPersistentVolumeKind.SHARED Kind of disk. --- ##### `readOnly`^Optional ```java public java.lang.Boolean getReadOnly(); ``` - *Type:* java.lang.Boolean - *Default:* false Force the ReadOnly setting in VolumeMounts. --- ### AzureDiskVolumeOptions Options of `Volume.fromAzureDisk`. #### Initializer ```java import org.cdk8s.plus32.AzureDiskVolumeOptions; AzureDiskVolumeOptions.builder() // .cachingMode(AzureDiskPersistentVolumeCachingMode) // .fsType(java.lang.String) // .kind(AzureDiskPersistentVolumeKind) // .name(java.lang.String) // .readOnly(java.lang.Boolean) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cachingMode | AzureDiskPersistentVolumeCachingMode | Host Caching mode. | | fsType | java.lang.String | Filesystem type to mount. | | kind | AzureDiskPersistentVolumeKind | Kind of disk. | | name | java.lang.String | The volume name. | | readOnly | java.lang.Boolean | Force the ReadOnly setting in VolumeMounts. | --- ##### `cachingMode`^Optional ```java public AzureDiskPersistentVolumeCachingMode getCachingMode(); ``` - *Type:* AzureDiskPersistentVolumeCachingMode - *Default:* AzureDiskPersistentVolumeCachingMode.NONE. Host Caching mode. --- ##### `fsType`^Optional ```java public java.lang.String getFsType(); ``` - *Type:* java.lang.String - *Default:* 'ext4' Filesystem type to mount. Must be a filesystem type supported by the host operating system. --- ##### `kind`^Optional ```java public AzureDiskPersistentVolumeKind getKind(); ``` - *Type:* AzureDiskPersistentVolumeKind - *Default:* AzureDiskPersistentVolumeKind.SHARED Kind of disk. --- ##### `name`^Optional ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* auto-generated The volume name. --- ##### `readOnly`^Optional ```java public java.lang.Boolean getReadOnly(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.k8s.AzureDiskVolumeSource; AzureDiskVolumeSource.builder() .diskName(java.lang.String) .diskUri(java.lang.String) // .cachingMode(java.lang.String) // .fsType(java.lang.String) // .kind(java.lang.String) // .readOnly(java.lang.Boolean) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | diskName | java.lang.String | diskName is the Name of the data disk in the blob storage. | | diskUri | java.lang.String | diskURI is the URI of data disk in the blob storage. | | cachingMode | java.lang.String | cachingMode is the Host Caching mode: None, Read Only, Read Write. | | fsType | java.lang.String | fsType is Filesystem type to mount. | | kind | java.lang.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 | java.lang.Boolean | readOnly Defaults to false (read/write). | --- ##### `diskName`^Required ```java public java.lang.String getDiskName(); ``` - *Type:* java.lang.String diskName is the Name of the data disk in the blob storage. --- ##### `diskUri`^Required ```java public java.lang.String getDiskUri(); ``` - *Type:* java.lang.String diskURI is the URI of data disk in the blob storage. --- ##### `cachingMode`^Optional ```java public java.lang.String getCachingMode(); ``` - *Type:* java.lang.String cachingMode is the Host Caching mode: None, Read Only, Read Write. --- ##### `fsType`^Optional ```java public java.lang.String getFsType(); ``` - *Type:* java.lang.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 ```java public java.lang.String getKind(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getReadOnly(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.k8s.AzureFilePersistentVolumeSource; AzureFilePersistentVolumeSource.builder() .secretName(java.lang.String) .shareName(java.lang.String) // .readOnly(java.lang.Boolean) // .secretNamespace(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | secretName | java.lang.String | secretName is the name of secret that contains Azure Storage Account Name and Key. | | shareName | java.lang.String | shareName is the azure Share Name. | | readOnly | java.lang.Boolean | readOnly defaults to false (read/write). | | secretNamespace | java.lang.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 ```java public java.lang.String getSecretName(); ``` - *Type:* java.lang.String secretName is the name of secret that contains Azure Storage Account Name and Key. --- ##### `shareName`^Required ```java public java.lang.String getShareName(); ``` - *Type:* java.lang.String shareName is the azure Share Name. --- ##### `readOnly`^Optional ```java public java.lang.Boolean getReadOnly(); ``` - *Type:* java.lang.Boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ##### `secretNamespace`^Optional ```java public java.lang.String getSecretNamespace(); ``` - *Type:* java.lang.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 ```java import org.cdk8s.plus32.k8s.AzureFileVolumeSource; AzureFileVolumeSource.builder() .secretName(java.lang.String) .shareName(java.lang.String) // .readOnly(java.lang.Boolean) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | secretName | java.lang.String | secretName is the name of secret that contains Azure Storage Account Name and Key. | | shareName | java.lang.String | shareName is the azure share Name. | | readOnly | java.lang.Boolean | readOnly defaults to false (read/write). | --- ##### `secretName`^Required ```java public java.lang.String getSecretName(); ``` - *Type:* java.lang.String secretName is the name of secret that contains Azure Storage Account Name and Key. --- ##### `shareName`^Required ```java public java.lang.String getShareName(); ``` - *Type:* java.lang.String shareName is the azure share Name. --- ##### `readOnly`^Optional ```java public java.lang.Boolean getReadOnly(); ``` - *Type:* java.lang.Boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. --- ### BasicAuthSecretProps Options for `BasicAuthSecret`. #### Initializer ```java import org.cdk8s.plus32.BasicAuthSecretProps; BasicAuthSecretProps.builder() // .metadata(ApiObjectMetadata) // .immutable(java.lang.Boolean) .password(java.lang.String) .username(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metadata | org.cdk8s.ApiObjectMetadata | Metadata that all persisted resources must have, which includes all objects users must create. | | immutable | java.lang.Boolean | If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | | password | java.lang.String | The password or token for authentication. | | username | java.lang.String | The user name for authentication. | --- ##### `metadata`^Optional ```java public ApiObjectMetadata getMetadata(); ``` - *Type:* org.cdk8s.ApiObjectMetadata Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`^Optional ```java public java.lang.Boolean getImmutable(); ``` - *Type:* java.lang.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 ```java public java.lang.String getPassword(); ``` - *Type:* java.lang.String The password or token for authentication. --- ##### `username`^Required ```java public java.lang.String getUsername(); ``` - *Type:* java.lang.String The user name for authentication. --- ### BasicDeviceV1Alpha3 BasicDevice defines one device instance. #### Initializer ```java import org.cdk8s.plus32.k8s.BasicDeviceV1Alpha3; BasicDeviceV1Alpha3.builder() // .attributes(java.util.Map) // .capacity(java.util.Map) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.Map | Attributes defines the set of attributes for this device. | | capacity | java.util.Map | Capacity defines the set of capacities for this device. | --- ##### `attributes`^Optional ```java public java.util.Map getAttributes(); ``` - *Type:* java.util.Map 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 ```java public java.util.Map getCapacity(); ``` - *Type:* java.util.Map 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 ```java import org.cdk8s.plus32.k8s.BasicDeviceV1Beta1; BasicDeviceV1Beta1.builder() // .attributes(java.util.Map