Package org.cdk8s.plus24.k8s
Class SecurityContext.Builder
- java.lang.Object
-
- org.cdk8s.plus24.k8s.SecurityContext.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<SecurityContext>
- Enclosing interface:
- SecurityContext
@Stability(Stable) public static final class SecurityContext.Builder extends Object implements software.amazon.jsii.Builder<SecurityContext>
A builder forSecurityContext
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
allowPrivilegeEscalation
@Stability(Stable) public SecurityContext.Builder allowPrivilegeEscalation(Boolean allowPrivilegeEscalation)
Sets the value ofSecurityContext.getAllowPrivilegeEscalation()
- Parameters:
allowPrivilegeEscalation
- AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
capabilities
@Stability(Stable) public SecurityContext.Builder capabilities(Capabilities capabilities)
Sets the value ofSecurityContext.getCapabilities()
- Parameters:
capabilities
- The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
privileged
@Stability(Stable) public SecurityContext.Builder privileged(Boolean privileged)
Sets the value ofSecurityContext.getPrivileged()
- Parameters:
privileged
- Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
procMount
@Stability(Stable) public SecurityContext.Builder procMount(String procMount)
Sets the value ofSecurityContext.getProcMount()
- Parameters:
procMount
- procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
readOnlyRootFilesystem
@Stability(Stable) public SecurityContext.Builder readOnlyRootFilesystem(Boolean readOnlyRootFilesystem)
Sets the value ofSecurityContext.getReadOnlyRootFilesystem()
- Parameters:
readOnlyRootFilesystem
- Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
runAsGroup
@Stability(Stable) public SecurityContext.Builder runAsGroup(Number runAsGroup)
Sets the value ofSecurityContext.getRunAsGroup()
- Parameters:
runAsGroup
- The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
runAsNonRoot
@Stability(Stable) public SecurityContext.Builder runAsNonRoot(Boolean runAsNonRoot)
Sets the value ofSecurityContext.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 PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.- Returns:
this
-
runAsUser
@Stability(Stable) public SecurityContext.Builder runAsUser(Number runAsUser)
Sets the value ofSecurityContext.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 PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
seccompProfile
@Stability(Stable) public SecurityContext.Builder seccompProfile(SeccompProfile seccompProfile)
Sets the value ofSecurityContext.getSeccompProfile()
- Parameters:
seccompProfile
- The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
seLinuxOptions
@Stability(Stable) public SecurityContext.Builder seLinuxOptions(SeLinuxOptions seLinuxOptions)
Sets the value ofSecurityContext.getSeLinuxOptions()
- Parameters:
seLinuxOptions
- The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.- Returns:
this
-
windowsOptions
@Stability(Stable) public SecurityContext.Builder windowsOptions(WindowsSecurityContextOptions windowsOptions)
Sets the value ofSecurityContext.getWindowsOptions()
- Parameters:
windowsOptions
- The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.- Returns:
this
-
build
@Stability(Stable) public SecurityContext build()
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<SecurityContext>
- Returns:
- a new instance of
SecurityContext
- Throws:
NullPointerException
- if any required attribute was not provided
-
-