Interface CfnJobDefinition.NodeRangePropertyProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnJobDefinition.NodeRangePropertyProperty.Jsii$Proxy
- Enclosing class:
CfnJobDefinition
@Stability(Stable)
public static interface CfnJobDefinition.NodeRangePropertyProperty
extends software.amazon.jsii.JsiiSerializable
This is an object that represents the properties of the node range for 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 labels;
Object limits;
Object options;
Object requests;
NodeRangePropertyProperty nodeRangePropertyProperty = NodeRangePropertyProperty.builder()
.targetNodes("targetNodes")
// the properties below are optional
.consumableResourceProperties(ConsumableResourcePropertiesProperty.builder()
.consumableResourceList(List.of(ConsumableResourceRequirementProperty.builder()
.consumableResource("consumableResource")
.quantity(123)
.build()))
.build())
.container(ContainerPropertiesProperty.builder()
.image("image")
// the properties below are optional
.command(List.of("command"))
.enableExecuteCommand(false)
.environment(List.of(EnvironmentProperty.builder()
.name("name")
.value("value")
.build()))
.ephemeralStorage(EphemeralStorageProperty.builder()
.sizeInGiB(123)
.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)
.repositoryCredentials(RepositoryCredentialsProperty.builder()
.credentialsParameter("credentialsParameter")
.build())
.resourceRequirements(List.of(ResourceRequirementProperty.builder()
.type("type")
.value("value")
.build()))
.runtimePlatform(RuntimePlatformProperty.builder()
.cpuArchitecture("cpuArchitecture")
.operatingSystemFamily("operatingSystemFamily")
.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())
.ecsProperties(MultiNodeEcsPropertiesProperty.builder()
.taskProperties(List.of(MultiNodeEcsTaskPropertiesProperty.builder()
.containers(List.of(TaskContainerPropertiesProperty.builder()
.image("image")
// the properties below are optional
.command(List.of("command"))
.dependsOn(List.of(TaskContainerDependencyProperty.builder()
.condition("condition")
.containerName("containerName")
.build()))
.environment(List.of(EnvironmentProperty.builder()
.name("name")
.value("value")
.build()))
.essential(false)
.firelensConfiguration(FirelensConfigurationProperty.builder()
.type("type")
// the properties below are optional
.options(Map.of(
"optionsKey", "options"))
.build())
.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())
.mountPoints(List.of(MountPointProperty.builder()
.containerPath("containerPath")
.readOnly(false)
.sourceVolume("sourceVolume")
.build()))
.name("name")
.privileged(false)
.readonlyRootFilesystem(false)
.repositoryCredentials(RepositoryCredentialsProperty.builder()
.credentialsParameter("credentialsParameter")
.build())
.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")
.build()))
.enableExecuteCommand(false)
.executionRoleArn("executionRoleArn")
.ipcMode("ipcMode")
.pidMode("pidMode")
.taskRoleArn("taskRoleArn")
.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())
.eksProperties(EksPropertiesProperty.builder()
.podProperties(PodPropertiesProperty.builder()
.containers(List.of(EksContainerProperty.builder()
.image("image")
// the properties below are optional
.args(List.of("args"))
.command(List.of("command"))
.env(List.of(EksContainerEnvironmentVariableProperty.builder()
.name("name")
// the properties below are optional
.value("value")
.build()))
.imagePullPolicy("imagePullPolicy")
.name("name")
.resources(ResourcesProperty.builder()
.limits(limits)
.requests(requests)
.build())
.securityContext(SecurityContextProperty.builder()
.allowPrivilegeEscalation(false)
.privileged(false)
.readOnlyRootFilesystem(false)
.runAsGroup(123)
.runAsNonRoot(false)
.runAsUser(123)
.build())
.volumeMounts(List.of(EksContainerVolumeMountProperty.builder()
.mountPath("mountPath")
.name("name")
.readOnly(false)
.subPath("subPath")
.build()))
.build()))
.dnsPolicy("dnsPolicy")
.hostNetwork(false)
.imagePullSecrets(List.of(ImagePullSecretProperty.builder()
.name("name")
.build()))
.initContainers(List.of(EksContainerProperty.builder()
.image("image")
// the properties below are optional
.args(List.of("args"))
.command(List.of("command"))
.env(List.of(EksContainerEnvironmentVariableProperty.builder()
.name("name")
// the properties below are optional
.value("value")
.build()))
.imagePullPolicy("imagePullPolicy")
.name("name")
.resources(ResourcesProperty.builder()
.limits(limits)
.requests(requests)
.build())
.securityContext(SecurityContextProperty.builder()
.allowPrivilegeEscalation(false)
.privileged(false)
.readOnlyRootFilesystem(false)
.runAsGroup(123)
.runAsNonRoot(false)
.runAsUser(123)
.build())
.volumeMounts(List.of(EksContainerVolumeMountProperty.builder()
.mountPath("mountPath")
.name("name")
.readOnly(false)
.subPath("subPath")
.build()))
.build()))
.metadata(MetadataProperty.builder()
.labels(labels)
.build())
.serviceAccountName("serviceAccountName")
.shareProcessNamespace(false)
.volumes(List.of(EksVolumeProperty.builder()
.name("name")
// the properties below are optional
.emptyDir(EmptyDirProperty.builder()
.medium("medium")
.sizeLimit("sizeLimit")
.build())
.hostPath(HostPathProperty.builder()
.path("path")
.build())
.persistentVolumeClaim(EksPersistentVolumeClaimProperty.builder()
.claimName("claimName")
// the properties below are optional
.readOnly(false)
.build())
.secret(EksSecretProperty.builder()
.secretName("secretName")
// the properties below are optional
.optional(false)
.build())
.build()))
.build())
.build())
.instanceTypes(List.of("instanceTypes"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnJobDefinition.NodeRangePropertyPropertystatic final classAn implementation forCfnJobDefinition.NodeRangePropertyProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectContains a list of consumable resources required by a job.default ObjectThe container details for the node range.default ObjectThis is an object that represents the properties of the node range for a multi-node parallel job.default ObjectThis is an object that represents the properties of the node range for a multi-node parallel job.The instance types of the underlying host infrastructure of a multi-node parallel job.The range of nodes, using node index values.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getTargetNodes
The range of nodes, using node index values.A range of
0:3indicates nodes with index values of0through3. If the starting range value is omitted (:n), then0is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You can nest node ranges (for example,0:10and4:5). In this case, the4:5range properties override the0:10properties.- See Also:
-
getConsumableResourceProperties
Contains a list of consumable resources required by a job.Returns union: either
IResolvableorCfnJobDefinition.ConsumableResourcePropertiesProperty- See Also:
-
getContainer
The container details for the node range.Returns union: either
IResolvableorCfnJobDefinition.ContainerPropertiesProperty- See Also:
-
getEcsProperties
This is an object that represents the properties of the node range for a multi-node parallel job.Returns union: either
IResolvableorCfnJobDefinition.MultiNodeEcsPropertiesProperty- See Also:
-
getEksProperties
This is an object that represents the properties of the node range for a multi-node parallel job.Returns union: either
IResolvableorCfnJobDefinition.EksPropertiesProperty- See Also:
-
getInstanceTypes
The instance types of the underlying host infrastructure of a multi-node parallel job.This parameter isn't applicable to jobs that are running on Fargate resources.
In addition, this list object is currently limited to one element.
- See Also:
-
builder
-