@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:36.915Z") @Stability(value=Stable) public interface CfnJobDefinitionProps extends software.amazon.jsii.JsiiSerializable
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;
Object parameters;
Object tags;
CfnJobDefinitionProps cfnJobDefinitionProps = CfnJobDefinitionProps.builder()
.type("type")
// the properties below are optional
.containerProperties(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())
.jobDefinitionName("jobDefinitionName")
.nodeProperties(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())
.parameters(parameters)
.platformCapabilities(List.of("platformCapabilities"))
.propagateTags(false)
.retryStrategy(RetryStrategyProperty.builder()
.attempts(123)
.evaluateOnExit(List.of(EvaluateOnExitProperty.builder()
.action("action")
// the properties below are optional
.onExitCode("onExitCode")
.onReason("onReason")
.onStatusReason("onStatusReason")
.build()))
.build())
.schedulingPriority(123)
.tags(tags)
.timeout(TimeoutProperty.builder()
.attemptDurationSeconds(123)
.build())
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnJobDefinitionProps.Builder
A builder for
CfnJobDefinitionProps |
static class |
CfnJobDefinitionProps.Jsii$Proxy
An implementation for
CfnJobDefinitionProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnJobDefinitionProps.Builder |
builder() |
default Object |
getContainerProperties()
An object with various properties specific to container-based jobs.
|
default String |
getJobDefinitionName()
The name of the job definition.
|
default Object |
getNodeProperties()
An object with various properties specific to multi-node parallel jobs.
|
default Object |
getParameters()
Default parameters or parameter substitution placeholders that are set in the job definition.
|
default List<String> |
getPlatformCapabilities()
The platform capabilities required by the job definition.
|
default Object |
getPropagateTags()
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
|
default Object |
getRetryStrategy()
The retry strategy to use for failed jobs that are submitted with this job definition.
|
default Number |
getSchedulingPriority()
The scheduling priority of the job definition.
|
default Object |
getTags()
The tags applied to the job definition.
|
default Object |
getTimeout()
The timeout configuration for jobs that are submitted with this job definition.
|
String |
getType()
The type of job definition.
|
@Stability(value=Stable) @NotNull String getType()
For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide .
If the job is run on Fargate resources, then
multinodeisn't supported.
@Stability(value=Stable) @Nullable default Object getContainerProperties()
@Stability(value=Stable) @Nullable default String getJobDefinitionName()
@Stability(value=Stable) @Nullable default Object getNodeProperties()
If the job runs on Fargate resources, then you must not specify
nodeProperties; usecontainerPropertiesinstead.
@Stability(value=Stable) @Nullable default Object getParameters()
Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the AWS Batch User Guide .
@Stability(value=Stable) @Nullable default List<String> getPlatformCapabilities()
If no value is specified, it defaults to EC2 . Jobs run on Fargate resources specify FARGATE .
@Stability(value=Stable) @Nullable default Object getPropagateTags()
If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
@Stability(value=Stable) @Nullable default Object getRetryStrategy()
@Stability(value=Stable) @Nullable default Number getSchedulingPriority()
This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
@Stability(value=Stable) @Nullable default Object getTags()
@Stability(value=Stable) @Nullable default Object getTimeout()
You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished.
@Stability(value=Stable) static CfnJobDefinitionProps.Builder builder()
CfnJobDefinitionProps.Builder of CfnJobDefinitionPropsCopyright © 2022. All rights reserved.