Interface JobDefinition.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<JobDefinition.Builder,
,JobDefinition> SdkBuilder<JobDefinition.Builder,
,JobDefinition> SdkPojo
- Enclosing class:
JobDefinition
-
Method Summary
Modifier and TypeMethodDescriptioncontainerOrchestrationType
(String containerOrchestrationType) The orchestration type of the compute environment.containerOrchestrationType
(OrchestrationType containerOrchestrationType) The orchestration type of the compute environment.default JobDefinition.Builder
containerProperties
(Consumer<ContainerProperties.Builder> containerProperties) An object with properties specific to Amazon ECS-based jobs.containerProperties
(ContainerProperties containerProperties) An object with properties specific to Amazon ECS-based jobs.default JobDefinition.Builder
ecsProperties
(Consumer<EcsProperties.Builder> ecsProperties) An object that contains the properties for the Amazon ECS resources of a job.WhenecsProperties
is used in the job definition, it can't be used in addition tocontainerProperties
,eksProperties
, ornodeProperties
.ecsProperties
(EcsProperties ecsProperties) An object that contains the properties for the Amazon ECS resources of a job.WhenecsProperties
is used in the job definition, it can't be used in addition tocontainerProperties
,eksProperties
, ornodeProperties
.default JobDefinition.Builder
eksProperties
(Consumer<EksProperties.Builder> eksProperties) An object with properties that are specific to Amazon EKS-based jobs.eksProperties
(EksProperties eksProperties) An object with properties that are specific to Amazon EKS-based jobs.jobDefinitionArn
(String jobDefinitionArn) The Amazon Resource Name (ARN) for the job definition.jobDefinitionName
(String jobDefinitionName) The name of the job definition.default JobDefinition.Builder
nodeProperties
(Consumer<NodeProperties.Builder> nodeProperties) An object with properties that are specific to multi-node parallel jobs.nodeProperties
(NodeProperties nodeProperties) An object with properties that are specific to multi-node parallel jobs.parameters
(Map<String, String> parameters) Default parameters or parameter substitution placeholders that are set in the job definition.platformCapabilities
(Collection<PlatformCapability> platformCapabilities) The platform capabilities required by the job definition.platformCapabilities
(PlatformCapability... platformCapabilities) The platform capabilities required by the job definition.platformCapabilitiesWithStrings
(String... platformCapabilities) The platform capabilities required by the job definition.platformCapabilitiesWithStrings
(Collection<String> platformCapabilities) The platform capabilities required by the job definition.propagateTags
(Boolean propagateTags) Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.default JobDefinition.Builder
retryStrategy
(Consumer<RetryStrategy.Builder> retryStrategy) The retry strategy to use for failed jobs that are submitted with this job definition.retryStrategy
(RetryStrategy retryStrategy) The retry strategy to use for failed jobs that are submitted with this job definition.The revision of the job definition.schedulingPriority
(Integer schedulingPriority) The scheduling priority of the job definition.The status of the job definition.The tags that are applied to the job definition.default JobDefinition.Builder
timeout
(Consumer<JobTimeout.Builder> timeout) The timeout time for jobs that are submitted with this job definition.timeout
(JobTimeout timeout) The timeout time for jobs that are submitted with this job definition.The type of job definition.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
jobDefinitionName
The name of the job definition.
- Parameters:
jobDefinitionName
- The name of the job definition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobDefinitionArn
The Amazon Resource Name (ARN) for the job definition.
- Parameters:
jobDefinitionArn
- The Amazon Resource Name (ARN) for the job definition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
revision
The revision of the job definition.
- Parameters:
revision
- The revision of the job definition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status of the job definition.
- Parameters:
status
- The status of the job definition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The type of job definition. It's either
container
ormultinode
. If the job is run on Fargate resources, thenmultinode
isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.- Parameters:
type
- The type of job definition. It's eithercontainer
ormultinode
. If the job is run on Fargate resources, thenmultinode
isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
schedulingPriority
The scheduling priority of the job definition. 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.
- Parameters:
schedulingPriority
- The scheduling priority of the job definition. 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
Default parameters or parameter substitution placeholders that are set in the job definition. 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 Batch User Guide.- Parameters:
parameters
- Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in aSubmitJob
request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the Batch User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retryStrategy
The retry strategy to use for failed jobs that are submitted with this job definition.
- Parameters:
retryStrategy
- The retry strategy to use for failed jobs that are submitted with this job definition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retryStrategy
The retry strategy to use for failed jobs that are submitted with this job definition.
This is a convenience method that creates an instance of theRetryStrategy.Builder
avoiding the need to create one manually viaRetryStrategy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretryStrategy(RetryStrategy)
.- Parameters:
retryStrategy
- a consumer that will call methods onRetryStrategy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
containerProperties
An object with properties specific to Amazon ECS-based jobs. When
containerProperties
is used in the job definition, it can't be used in addition toeksProperties
,ecsProperties
, ornodeProperties
.- Parameters:
containerProperties
- An object with properties specific to Amazon ECS-based jobs. WhencontainerProperties
is used in the job definition, it can't be used in addition toeksProperties
,ecsProperties
, ornodeProperties
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
containerProperties
default JobDefinition.Builder containerProperties(Consumer<ContainerProperties.Builder> containerProperties) An object with properties specific to Amazon ECS-based jobs. When
This is a convenience method that creates an instance of thecontainerProperties
is used in the job definition, it can't be used in addition toeksProperties
,ecsProperties
, ornodeProperties
.ContainerProperties.Builder
avoiding the need to create one manually viaContainerProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocontainerProperties(ContainerProperties)
.- Parameters:
containerProperties
- a consumer that will call methods onContainerProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
timeout
The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.
- Parameters:
timeout
- The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timeout
The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.
This is a convenience method that creates an instance of theJobTimeout.Builder
avoiding the need to create one manually viaJobTimeout.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimeout(JobTimeout)
.- Parameters:
timeout
- a consumer that will call methods onJobTimeout.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
nodeProperties
An object with properties that are specific to multi-node parallel jobs. When
nodeProperties
is used in the job definition, it can't be used in addition tocontainerProperties
,ecsProperties
, oreksProperties
.If the job runs on Fargate resources, don't specify
nodeProperties
. UsecontainerProperties
instead.- Parameters:
nodeProperties
- An object with properties that are specific to multi-node parallel jobs. WhennodeProperties
is used in the job definition, it can't be used in addition tocontainerProperties
,ecsProperties
, oreksProperties
.If the job runs on Fargate resources, don't specify
nodeProperties
. UsecontainerProperties
instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nodeProperties
An object with properties that are specific to multi-node parallel jobs. When
nodeProperties
is used in the job definition, it can't be used in addition tocontainerProperties
,ecsProperties
, oreksProperties
.If the job runs on Fargate resources, don't specify
nodeProperties
. UsecontainerProperties
instead.NodeProperties.Builder
avoiding the need to create one manually viaNodeProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonodeProperties(NodeProperties)
.- Parameters:
nodeProperties
- a consumer that will call methods onNodeProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
The tags that are applied to the job definition.
- Parameters:
tags
- The tags that are applied to the job definition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
propagateTags
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. 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.- Parameters:
propagateTags
- Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. 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 theFAILED
state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformCapabilitiesWithStrings
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2
. Jobs run on Fargate resources specifyFARGATE
.- Parameters:
platformCapabilities
- The platform capabilities required by the job definition. If no value is specified, it defaults toEC2
. Jobs run on Fargate resources specifyFARGATE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformCapabilitiesWithStrings
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2
. Jobs run on Fargate resources specifyFARGATE
.- Parameters:
platformCapabilities
- The platform capabilities required by the job definition. If no value is specified, it defaults toEC2
. Jobs run on Fargate resources specifyFARGATE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformCapabilities
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2
. Jobs run on Fargate resources specifyFARGATE
.- Parameters:
platformCapabilities
- The platform capabilities required by the job definition. If no value is specified, it defaults toEC2
. Jobs run on Fargate resources specifyFARGATE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformCapabilities
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2
. Jobs run on Fargate resources specifyFARGATE
.- Parameters:
platformCapabilities
- The platform capabilities required by the job definition. If no value is specified, it defaults toEC2
. Jobs run on Fargate resources specifyFARGATE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ecsProperties
An object that contains the properties for the Amazon ECS resources of a job.When
ecsProperties
is used in the job definition, it can't be used in addition tocontainerProperties
,eksProperties
, ornodeProperties
.- Parameters:
ecsProperties
- An object that contains the properties for the Amazon ECS resources of a job.WhenecsProperties
is used in the job definition, it can't be used in addition tocontainerProperties
,eksProperties
, ornodeProperties
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ecsProperties
An object that contains the properties for the Amazon ECS resources of a job.When
This is a convenience method that creates an instance of theecsProperties
is used in the job definition, it can't be used in addition tocontainerProperties
,eksProperties
, ornodeProperties
.EcsProperties.Builder
avoiding the need to create one manually viaEcsProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toecsProperties(EcsProperties)
.- Parameters:
ecsProperties
- a consumer that will call methods onEcsProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
eksProperties
An object with properties that are specific to Amazon EKS-based jobs. When
eksProperties
is used in the job definition, it can't be used in addition tocontainerProperties
,ecsProperties
, ornodeProperties
.- Parameters:
eksProperties
- An object with properties that are specific to Amazon EKS-based jobs. WheneksProperties
is used in the job definition, it can't be used in addition tocontainerProperties
,ecsProperties
, ornodeProperties
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eksProperties
An object with properties that are specific to Amazon EKS-based jobs. When
This is a convenience method that creates an instance of theeksProperties
is used in the job definition, it can't be used in addition tocontainerProperties
,ecsProperties
, ornodeProperties
.EksProperties.Builder
avoiding the need to create one manually viaEksProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toeksProperties(EksProperties)
.- Parameters:
eksProperties
- a consumer that will call methods onEksProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
containerOrchestrationType
The orchestration type of the compute environment. The valid values are
ECS
(default) orEKS
.- Parameters:
containerOrchestrationType
- The orchestration type of the compute environment. The valid values areECS
(default) orEKS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
containerOrchestrationType
The orchestration type of the compute environment. The valid values are
ECS
(default) orEKS
.- Parameters:
containerOrchestrationType
- The orchestration type of the compute environment. The valid values areECS
(default) orEKS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-