RegisterJobDefinitionRequest Class

Container for the parameters to the RegisterJobDefinition operation. Registers an Batch job definition.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Batch.AmazonBatchRequest
      Amazon.Batch.Model.RegisterJobDefinitionRequest

Namespace: Amazon.Batch.Model
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

public class RegisterJobDefinitionRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The RegisterJobDefinitionRequest type exposes the following members

Constructors

	Name	Description
	RegisterJobDefinitionRequest()

Properties

Name	Type	Description
ContainerProperties	Amazon.Batch.Model.ContainerProperties	Gets and sets the property ContainerProperties. An object with 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`.
EcsProperties	Amazon.Batch.Model.EcsProperties	Gets and sets the property EcsProperties. An object with properties that are specific to Amazon ECS-based jobs. This must not be specified for Amazon EKS-based job definitions.
EksProperties	Amazon.Batch.Model.EksProperties	Gets and sets the property EksProperties. An object with properties that are specific to Amazon EKS-based jobs. This must not be specified for Amazon ECS based job definitions.
JobDefinitionName	System.String	Gets and sets the property 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 (_).
NodeProperties	Amazon.Batch.Model.NodeProperties	Gets and sets the property NodeProperties. An object with 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 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`.
Parameters	System.Collections.Generic.Dictionary<System.String, System.String>	Gets and sets the property 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.
PlatformCapabilities	System.Collections.Generic.List<System.String>	Gets and sets the property 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`.
PropagateTags	System.Boolean	Gets and sets the property 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`.
RetryStrategy	Amazon.Batch.Model.RetryStrategy	Gets and sets the property 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.
SchedulingPriority	System.Int32	Gets and sets the property 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.
Tags	System.Collections.Generic.Dictionary<System.String, System.String>	Gets and sets the property 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.
Timeout	Amazon.Batch.Model.JobTimeout	Gets and sets the property 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.
Type	Amazon.Batch.JobDefinitionType	Gets and sets the property 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 value is `container`, then one of the following is required: `containerProperties`, `ecsProperties`, or `eksProperties`. If the value is `multinode`, then `nodeProperties` is required. If the job is run on Fargate resources, then `multinode` isn't supported.

Examples

This example registers a job definition for a simple container job.

To register a job definition


var client = new AmazonBatchClient();
var response = client.RegisterJobDefinition(new RegisterJobDefinitionRequest 
{
    Type = "container",
    ContainerProperties = new ContainerProperties {
        Command = new List<string> {
            "sleep",
            "10"
        },
        Image = "busybox",
        ResourceRequirements = new List<ResourceRequirement> {
            new ResourceRequirement {
                Type = "MEMORY",
                Value = "128"
            },
            new ResourceRequirement {
                Type = "VCPU",
                Value = "1"
            }
        }
    },
    JobDefinitionName = "sleep10"
});

string jobDefinitionArn = response.JobDefinitionArn;
string jobDefinitionName = response.JobDefinitionName;
int revision = response.Revision;

This demonstrates calling the RegisterJobDefinition action, including tags.

RegisterJobDefinition with tags


var client = new AmazonBatchClient();
var response = client.RegisterJobDefinition(new RegisterJobDefinitionRequest 
{
    Type = "container",
    ContainerProperties = new ContainerProperties {
        Command = new List<string> {
            "sleep",
            "30"
        },
        Image = "busybox",
        ResourceRequirements = new List<ResourceRequirement> {
            new ResourceRequirement {
                Type = "MEMORY",
                Value = "128"
            },
            new ResourceRequirement {
                Type = "VCPU",
                Value = "1"
            }
        }
    },
    JobDefinitionName = "sleep30",
    Tags = new Dictionary<string, string> {
        { "Department", "Engineering" },
        { "User", "JaneDoe" }
    }
});

string jobDefinitionArn = response.JobDefinitionArn;
string jobDefinitionName = response.JobDefinitionName;
int revision = response.Revision;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5