public static interface RegisterJobDefinitionRequest.Builder extends BatchRequest.Builder, SdkPojo, CopyableBuilder<RegisterJobDefinitionRequest.Builder,RegisterJobDefinitionRequest>
| Modifier and Type | Method and Description |
|---|---|
default RegisterJobDefinitionRequest.Builder |
containerProperties(Consumer<ContainerProperties.Builder> containerProperties)
An object with various properties specific to Amazon ECS based single-node container-based jobs.
|
RegisterJobDefinitionRequest.Builder |
containerProperties(ContainerProperties containerProperties)
An object with various properties specific to Amazon ECS based single-node container-based jobs.
|
default RegisterJobDefinitionRequest.Builder |
eksProperties(Consumer<EksProperties.Builder> eksProperties)
An object with various properties that are specific to Amazon EKS based jobs.
|
RegisterJobDefinitionRequest.Builder |
eksProperties(EksProperties eksProperties)
An object with various properties that are specific to Amazon EKS based jobs.
|
RegisterJobDefinitionRequest.Builder |
jobDefinitionName(String jobDefinitionName)
The name of the job definition to register.
|
default RegisterJobDefinitionRequest.Builder |
nodeProperties(Consumer<NodeProperties.Builder> nodeProperties)
An object with various properties specific to multi-node parallel jobs.
|
RegisterJobDefinitionRequest.Builder |
nodeProperties(NodeProperties nodeProperties)
An object with various properties specific to multi-node parallel jobs.
|
RegisterJobDefinitionRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
RegisterJobDefinitionRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
RegisterJobDefinitionRequest.Builder |
parameters(Map<String,String> parameters)
Default parameter substitution placeholders to set in the job definition.
|
RegisterJobDefinitionRequest.Builder |
platformCapabilities(Collection<PlatformCapability> platformCapabilities)
The platform capabilities required by the job definition.
|
RegisterJobDefinitionRequest.Builder |
platformCapabilities(PlatformCapability... platformCapabilities)
The platform capabilities required by the job definition.
|
RegisterJobDefinitionRequest.Builder |
platformCapabilitiesWithStrings(Collection<String> platformCapabilities)
The platform capabilities required by the job definition.
|
RegisterJobDefinitionRequest.Builder |
platformCapabilitiesWithStrings(String... platformCapabilities)
The platform capabilities required by the job definition.
|
RegisterJobDefinitionRequest.Builder |
propagateTags(Boolean propagateTags)
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
|
default RegisterJobDefinitionRequest.Builder |
retryStrategy(Consumer<RetryStrategy.Builder> retryStrategy)
The retry strategy to use for failed jobs that are submitted with this job definition.
|
RegisterJobDefinitionRequest.Builder |
retryStrategy(RetryStrategy retryStrategy)
The retry strategy to use for failed jobs that are submitted with this job definition.
|
RegisterJobDefinitionRequest.Builder |
schedulingPriority(Integer schedulingPriority)
The scheduling priority for jobs that are submitted with this job definition.
|
RegisterJobDefinitionRequest.Builder |
tags(Map<String,String> tags)
The tags that you apply to the job definition to help you categorize and organize your resources.
|
default RegisterJobDefinitionRequest.Builder |
timeout(Consumer<JobTimeout.Builder> timeout)
The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates
your jobs if they have not finished.
|
RegisterJobDefinitionRequest.Builder |
timeout(JobTimeout timeout)
The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates
your jobs if they have not finished.
|
RegisterJobDefinitionRequest.Builder |
type(JobDefinitionType type)
The type of job definition.
|
RegisterJobDefinitionRequest.Builder |
type(String type)
The type of job definition.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildRegisterJobDefinitionRequest.Builder jobDefinitionName(String jobDefinitionName)
The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
jobDefinitionName - The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase
and lowercase letters, numbers, hyphens (-), and underscores (_).RegisterJobDefinitionRequest.Builder type(String type)
The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
If the job is run on Fargate resources, then multinode isn't supported.
type - The type of job definition. For more information about multi-node parallel jobs, see Creating a
multi-node parallel job definition in the Batch User Guide.
If the job is run on Fargate resources, then multinode isn't supported.
JobDefinitionType,
JobDefinitionTypeRegisterJobDefinitionRequest.Builder type(JobDefinitionType type)
The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
If the job is run on Fargate resources, then multinode isn't supported.
type - The type of job definition. For more information about multi-node parallel jobs, see Creating a
multi-node parallel job definition in the Batch User Guide.
If the job is run on Fargate resources, then multinode isn't supported.
JobDefinitionType,
JobDefinitionTypeRegisterJobDefinitionRequest.Builder parameters(Map<String,String> parameters)
Default parameter substitution placeholders to 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.
parameters - Default parameter substitution placeholders to 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.RegisterJobDefinitionRequest.Builder schedulingPriority(Integer schedulingPriority)
The scheduling priority for jobs that are submitted with this 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.
The minimum supported value is 0 and the maximum supported value is 9999.
schedulingPriority - The scheduling priority for jobs that are submitted with this 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.
The minimum supported value is 0 and the maximum supported value is 9999.
RegisterJobDefinitionRequest.Builder containerProperties(ContainerProperties containerProperties)
An object with various properties specific to Amazon ECS based single-node container-based jobs. If the job
definition's type parameter is container, then you must specify either
containerProperties or nodeProperties. This must not be specified for Amazon EKS
based job definitions.
If the job runs on Fargate resources, then you must not specify nodeProperties; use only
containerProperties.
containerProperties - An object with various properties specific to Amazon ECS based single-node container-based jobs. If
the job definition's type parameter is container, then you must specify
either containerProperties or nodeProperties. This must not be specified for
Amazon EKS based job definitions.
If the job runs on Fargate resources, then you must not specify nodeProperties; use only
containerProperties.
default RegisterJobDefinitionRequest.Builder containerProperties(Consumer<ContainerProperties.Builder> containerProperties)
An object with various properties specific to Amazon ECS based single-node container-based jobs. If the job
definition's type parameter is container, then you must specify either
containerProperties or nodeProperties. This must not be specified for Amazon EKS
based job definitions.
If the job runs on Fargate resources, then you must not specify nodeProperties; use only
containerProperties.
ContainerProperties.Builder
avoiding the need to create one manually via ContainerProperties.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to containerProperties(ContainerProperties).
containerProperties - a consumer that will call methods on ContainerProperties.BuildercontainerProperties(ContainerProperties)RegisterJobDefinitionRequest.Builder nodeProperties(NodeProperties nodeProperties)
An object with various properties specific to multi-node parallel jobs. If you specify node properties for a
job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel
Jobs in the Batch User Guide. If the job definition's type parameter is
container, then you must specify either containerProperties or
nodeProperties.
If the job runs on Fargate resources, then you must not specify nodeProperties; use
containerProperties instead.
If the job runs on Amazon EKS resources, then you must not specify nodeProperties.
nodeProperties - An object with various properties specific to multi-node parallel jobs. If you specify node properties
for a job, it becomes a multi-node parallel job. For more information, see Multi-node
Parallel Jobs in the Batch User Guide. If the job definition's type parameter
is container, then you must specify either containerProperties or
nodeProperties.
If the job runs on Fargate resources, then you must not specify nodeProperties; use
containerProperties instead.
If the job runs on Amazon EKS resources, then you must not specify nodeProperties.
default RegisterJobDefinitionRequest.Builder nodeProperties(Consumer<NodeProperties.Builder> nodeProperties)
An object with various properties specific to multi-node parallel jobs. If you specify node properties for a
job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel
Jobs in the Batch User Guide. If the job definition's type parameter is
container, then you must specify either containerProperties or
nodeProperties.
If the job runs on Fargate resources, then you must not specify nodeProperties; use
containerProperties instead.
If the job runs on Amazon EKS resources, then you must not specify nodeProperties.
NodeProperties.Builder avoiding
the need to create one manually via NodeProperties.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to nodeProperties(NodeProperties).
nodeProperties - a consumer that will call methods on NodeProperties.BuildernodeProperties(NodeProperties)RegisterJobDefinitionRequest.Builder retryStrategy(RetryStrategy retryStrategy)
The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition. Any retry
strategy that's specified during a SubmitJob operation overrides the retry strategy defined
here. If a job is terminated due to a timeout, it isn't retried.default RegisterJobDefinitionRequest.Builder retryStrategy(Consumer<RetryStrategy.Builder> retryStrategy)
The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
This is a convenience method that creates an instance of theRetryStrategy.Builder avoiding the need
to create one manually via RetryStrategy.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to retryStrategy(RetryStrategy).
retryStrategy - a consumer that will call methods on RetryStrategy.BuilderretryStrategy(RetryStrategy)RegisterJobDefinitionRequest.Builder propagateTags(Boolean 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 are not 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.
If the job runs on Amazon EKS resources, then you must not specify propagateTags.
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 are not 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.
If the job runs on Amazon EKS resources, then you must not specify propagateTags.
RegisterJobDefinitionRequest.Builder timeout(JobTimeout timeout)
The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.
timeout - The timeout configuration for jobs that are submitted with this job definition, after which Batch
terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't
retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified
during a SubmitJob operation overrides the timeout configuration defined here. For more
information, see Job
Timeouts in the Batch User Guide.default RegisterJobDefinitionRequest.Builder timeout(Consumer<JobTimeout.Builder> timeout)
The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.
This is a convenience method that creates an instance of theJobTimeout.Builder avoiding the need to
create one manually via JobTimeout.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to timeout(JobTimeout).
timeout - a consumer that will call methods on JobTimeout.Buildertimeout(JobTimeout)RegisterJobDefinitionRequest.Builder tags(Map<String,String> tags)
The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.
tags - The tags that you apply to the job definition to help you categorize and organize your resources. Each
tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services
Resources in Batch User Guide.RegisterJobDefinitionRequest.Builder platformCapabilitiesWithStrings(Collection<String> platformCapabilities)
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2. To run the job on Fargate resources, specify FARGATE.
If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.
platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2. To run the job on Fargate resources, specify FARGATE.
If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.
RegisterJobDefinitionRequest.Builder platformCapabilitiesWithStrings(String... platformCapabilities)
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2. To run the job on Fargate resources, specify FARGATE.
If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.
platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2. To run the job on Fargate resources, specify FARGATE.
If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.
RegisterJobDefinitionRequest.Builder platformCapabilities(Collection<PlatformCapability> platformCapabilities)
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2. To run the job on Fargate resources, specify FARGATE.
If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.
platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2. To run the job on Fargate resources, specify FARGATE.
If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.
RegisterJobDefinitionRequest.Builder platformCapabilities(PlatformCapability... platformCapabilities)
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2. To run the job on Fargate resources, specify FARGATE.
If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.
platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2. To run the job on Fargate resources, specify FARGATE.
If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.
RegisterJobDefinitionRequest.Builder eksProperties(EksProperties eksProperties)
An object with various properties that are specific to Amazon EKS based jobs. This must not be specified for Amazon ECS based job definitions.
eksProperties - An object with various properties that are specific to Amazon EKS based jobs. This must not be
specified for Amazon ECS based job definitions.default RegisterJobDefinitionRequest.Builder eksProperties(Consumer<EksProperties.Builder> eksProperties)
An object with various properties that are specific to Amazon EKS based jobs. This must not be specified for Amazon ECS based job definitions.
This is a convenience method that creates an instance of theEksProperties.Builder avoiding the need
to create one manually via EksProperties.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to eksProperties(EksProperties).
eksProperties - a consumer that will call methods on EksProperties.BuildereksProperties(EksProperties)RegisterJobDefinitionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderRegisterJobDefinitionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.