Package org.cdk8s.plus24.k8s
Class PodSecurityContext.Builder
- java.lang.Object
-
- org.cdk8s.plus24.k8s.PodSecurityContext.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<PodSecurityContext>
- Enclosing interface:
- PodSecurityContext
@Stability(Stable) public static final class PodSecurityContext.Builder extends Object implements software.amazon.jsii.Builder<PodSecurityContext>
A builder forPodSecurityContext
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
fsGroup
@Stability(Stable) public PodSecurityContext.Builder fsGroup(Number fsGroup)
Sets the value ofPodSecurityContext.getFsGroup()
- Parameters:
fsGroup
- A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:- The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.
- Returns:
this
-
fsGroupChangePolicy
@Stability(Stable) public PodSecurityContext.Builder fsGroupChangePolicy(String fsGroupChangePolicy)
Sets the value ofPodSecurityContext.getFsGroupChangePolicy()
- Parameters:
fsGroupChangePolicy
- fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
runAsGroup
@Stability(Stable) public PodSecurityContext.Builder runAsGroup(Number runAsGroup)
Sets the value ofPodSecurityContext.getRunAsGroup()
- Parameters:
runAsGroup
- The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
runAsNonRoot
@Stability(Stable) public PodSecurityContext.Builder runAsNonRoot(Boolean runAsNonRoot)
Sets the value ofPodSecurityContext.getRunAsNonRoot()
- Parameters:
runAsNonRoot
- Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.- Returns:
this
-
runAsUser
@Stability(Stable) public PodSecurityContext.Builder runAsUser(Number runAsUser)
Sets the value ofPodSecurityContext.getRunAsUser()
- Parameters:
runAsUser
- The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
seccompProfile
@Stability(Stable) public PodSecurityContext.Builder seccompProfile(SeccompProfile seccompProfile)
Sets the value ofPodSecurityContext.getSeccompProfile()
- Parameters:
seccompProfile
- The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
seLinuxOptions
@Stability(Stable) public PodSecurityContext.Builder seLinuxOptions(SeLinuxOptions seLinuxOptions)
Sets the value ofPodSecurityContext.getSeLinuxOptions()
- Parameters:
seLinuxOptions
- The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
supplementalGroups
@Stability(Stable) public PodSecurityContext.Builder supplementalGroups(List<? extends Number> supplementalGroups)
Sets the value ofPodSecurityContext.getSupplementalGroups()
- Parameters:
supplementalGroups
- A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
sysctls
@Stability(Stable) public PodSecurityContext.Builder sysctls(List<? extends Sysctl> sysctls)
Sets the value ofPodSecurityContext.getSysctls()
- Parameters:
sysctls
- Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
windowsOptions
@Stability(Stable) public PodSecurityContext.Builder windowsOptions(WindowsSecurityContextOptions windowsOptions)
Sets the value ofPodSecurityContext.getWindowsOptions()
- Parameters:
windowsOptions
- The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.- Returns:
this
-
build
@Stability(Stable) public PodSecurityContext build()
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<PodSecurityContext>
- Returns:
- a new instance of
PodSecurityContext
- Throws:
NullPointerException
- if any required attribute was not provided
-
-