Package software.amazon.awscdk.services.batch

Class LinuxParameters

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.services.batch.LinuxParameters
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-08-02T00:29:07.224Z") @Stability(Stable) public class LinuxParameters extends software.constructs.Construct
Linux-specific options that are applied to the container.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.batch.*;
 Size size;
 LinuxParameters linuxParameters = LinuxParameters.Builder.create(this, "MyLinuxParameters")
         .initProcessEnabled(false)
         .maxSwap(size)
         .sharedMemorySize(size)
         .swappiness(123)
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    LinuxParameters.Builder
    A fluent builder for LinuxParameters.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    LinuxParameters(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    LinuxParameters(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    LinuxParameters(software.constructs.Construct scope, String id)
    Constructs a new instance of the LinuxParameters class.
     
    LinuxParameters(software.constructs.Construct scope, String id, LinuxParametersProps props)
    Constructs a new instance of the LinuxParameters class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addDevices(@NotNull Device... device)
    Adds one or more host devices to a container.
    void
    addTmpfs(@NotNull Tmpfs... tmpfs)
    Specifies the container path, mount options, and size (in MiB) of the tmpfs mount for a container.
    protected List<Device>
    getDevices()
    Device mounts.
    protected Boolean
    getInitProcessEnabled()
    Whether the init process is enabled.
    protected Size
    getMaxSwap()
    The max swap memory.
    protected Size
    getSharedMemorySize()
    The shared memory size (in MiB).
    protected Number
    getSwappiness()
    The swappiness behavior.
    protected List<Tmpfs>
    getTmpfs()
    TmpFs mounts.
    CfnJobDefinition.LinuxParametersProperty
    renderLinuxParameters()
    Renders the Linux parameters to the Batch version of this resource, which does not have 'capabilities' and requires tmpfs.containerPath to be defined.

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • LinuxParameters

      protected LinuxParameters(software.amazon.jsii.JsiiObjectRef objRef)

    • LinuxParameters

      protected LinuxParameters(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • LinuxParameters

      @Stability(Stable) public LinuxParameters(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable LinuxParametersProps props)
      Constructs a new instance of the LinuxParameters class.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props -

    • LinuxParameters

      @Stability(Stable) public LinuxParameters(@NotNull software.constructs.Construct scope, @NotNull String id)
      Constructs a new instance of the LinuxParameters class.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.

  • Method Details

    • addDevices

      @Stability(Stable) public void addDevices(@NotNull @NotNull Device... device)
      Adds one or more host devices to a container.

      Parameters:
      device - This parameter is required.

    • addTmpfs

      @Stability(Stable) public void addTmpfs(@NotNull @NotNull Tmpfs... tmpfs)
      Specifies the container path, mount options, and size (in MiB) of the tmpfs mount for a container.

      Only works with EC2 launch type.

      Parameters:
      tmpfs - This parameter is required.

    • renderLinuxParameters

      @Stability(Stable) @NotNull public CfnJobDefinition.LinuxParametersProperty renderLinuxParameters()
      Renders the Linux parameters to the Batch version of this resource, which does not have 'capabilities' and requires tmpfs.containerPath to be defined.

    • getDevices

      @Stability(Stable) @NotNull protected List<Device> getDevices()
      Device mounts.

    • getTmpfs

      @Stability(Stable) @NotNull protected List<Tmpfs> getTmpfs()
      TmpFs mounts.

    • getInitProcessEnabled

      @Stability(Stable) @Nullable protected Boolean getInitProcessEnabled()
      Whether the init process is enabled.

    • getMaxSwap

      @Stability(Stable) @Nullable protected Size getMaxSwap()
      The max swap memory.

    • getSharedMemorySize

      @Stability(Stable) @Nullable protected Size getSharedMemorySize()
      The shared memory size (in MiB).

      Not valid for Fargate launch type

    • getSwappiness

      @Stability(Stable) @Nullable protected Number getSwappiness()
      The swappiness behavior.