software.amazon.awscdk.services.batch

Interface CfnJobDefinition.NodePropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.NodePropertiesProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

@Stability(value=Stable)
public static interface CfnJobDefinition.NodePropertiesProperty
extends software.amazon.jsii.JsiiSerializable

An object representing the node properties of a multi-node parallel job.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 Object options;
 NodePropertiesProperty nodePropertiesProperty = NodePropertiesProperty.builder()
         .mainNode(123)
         .nodeRangeProperties(List.of(NodeRangePropertyProperty.builder()
                 .targetNodes("targetNodes")
                 // the properties below are optional
                 .container(ContainerPropertiesProperty.builder()
                         .image("image")
                         // the properties below are optional
                         .command(List.of("command"))
                         .environment(List.of(EnvironmentProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .executionRoleArn("executionRoleArn")
                         .fargatePlatformConfiguration(FargatePlatformConfigurationProperty.builder()
                                 .platformVersion("platformVersion")
                                 .build())
                         .instanceType("instanceType")
                         .jobRoleArn("jobRoleArn")
                         .linuxParameters(LinuxParametersProperty.builder()
                                 .devices(List.of(DeviceProperty.builder()
                                         .containerPath("containerPath")
                                         .hostPath("hostPath")
                                         .permissions(List.of("permissions"))
                                         .build()))
                                 .initProcessEnabled(false)
                                 .maxSwap(123)
                                 .sharedMemorySize(123)
                                 .swappiness(123)
                                 .tmpfs(List.of(TmpfsProperty.builder()
                                         .containerPath("containerPath")
                                         .size(123)
                                         // the properties below are optional
                                         .mountOptions(List.of("mountOptions"))
                                         .build()))
                                 .build())
                         .logConfiguration(LogConfigurationProperty.builder()
                                 .logDriver("logDriver")
                                 // the properties below are optional
                                 .options(options)
                                 .secretOptions(List.of(SecretProperty.builder()
                                         .name("name")
                                         .valueFrom("valueFrom")
                                         .build()))
                                 .build())
                         .memory(123)
                         .mountPoints(List.of(MountPointsProperty.builder()
                                 .containerPath("containerPath")
                                 .readOnly(false)
                                 .sourceVolume("sourceVolume")
                                 .build()))
                         .networkConfiguration(NetworkConfigurationProperty.builder()
                                 .assignPublicIp("assignPublicIp")
                                 .build())
                         .privileged(false)
                         .readonlyRootFilesystem(false)
                         .resourceRequirements(List.of(ResourceRequirementProperty.builder()
                                 .type("type")
                                 .value("value")
                                 .build()))
                         .secrets(List.of(SecretProperty.builder()
                                 .name("name")
                                 .valueFrom("valueFrom")
                                 .build()))
                         .ulimits(List.of(UlimitProperty.builder()
                                 .hardLimit(123)
                                 .name("name")
                                 .softLimit(123)
                                 .build()))
                         .user("user")
                         .vcpus(123)
                         .volumes(List.of(VolumesProperty.builder()
                                 .efsVolumeConfiguration(EfsVolumeConfigurationProperty.builder()
                                         .fileSystemId("fileSystemId")
                                         // the properties below are optional
                                         .authorizationConfig(AuthorizationConfigProperty.builder()
                                                 .accessPointId("accessPointId")
                                                 .iam("iam")
                                                 .build())
                                         .rootDirectory("rootDirectory")
                                         .transitEncryption("transitEncryption")
                                         .transitEncryptionPort(123)
                                         .build())
                                 .host(VolumesHostProperty.builder()
                                         .sourcePath("sourcePath")
                                         .build())
                                 .name("name")
                                 .build()))
                         .build())
                 .build()))
         .numNodes(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnJobDefinition.NodePropertiesProperty.Builder A builder for CfnJobDefinition.NodePropertiesProperty
static class	CfnJobDefinition.NodePropertiesProperty.Jsii$Proxy An implementation for CfnJobDefinition.NodePropertiesProperty

Method Summary

Modifier and Type	Method and Description
static CfnJobDefinition.NodePropertiesProperty.Builder	builder()
Number	getMainNode() Specifies the node index for the main node of a multi-node parallel job.
Object	getNodeRangeProperties() A list of node ranges and their properties associated with a multi-node parallel job.
Number	getNumNodes() The number of nodes associated with a multi-node parallel job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMainNode

@Stability(value=Stable)
 @NotNull
Number getMainNode()

Specifies the node index for the main node of a multi-node parallel job.

This node index value must be fewer than the number of nodes.

getNodeRangeProperties

@Stability(value=Stable)
 @NotNull
Object getNodeRangeProperties()

A list of node ranges and their properties associated with a multi-node parallel job.

getNumNodes

@Stability(value=Stable)
 @NotNull
Number getNumNodes()

The number of nodes associated with a multi-node parallel job.

builder

@Stability(value=Stable)
static CfnJobDefinition.NodePropertiesProperty.Builder builder()

Returns:

a CfnJobDefinition.NodePropertiesProperty.Builder of CfnJobDefinition.NodePropertiesProperty