Class CfnJobDefinitionProps
Properties for defining a CfnJobDefinition
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnJobDefinitionProps : Object, ICfnJobDefinitionProps
Syntax (vb)
Public Class CfnJobDefinitionProps
Inherits Object
Implements ICfnJobDefinitionProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html
ExampleMetadata: fixture=_generated
Synopsis
Constructors
CfnJobDefinitionProps() |
Properties
ContainerProperties | An object with properties specific to Amazon ECS-based jobs. |
EcsProperties | An object that contains the properties for the Amazon ECS resources of a job.When |
EksProperties | An object with properties that are specific to Amazon EKS-based jobs. |
JobDefinitionName | The name of the job definition. |
NodeProperties | An object with properties that are specific to multi-node parallel jobs. |
Parameters | Default parameters or parameter substitution placeholders that are set in the job definition. |
PlatformCapabilities | The platform capabilities required by the job definition. |
PropagateTags | Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. |
RetryStrategy | The retry strategy to use for failed jobs that are submitted with this job definition. |
SchedulingPriority | The scheduling priority of the job definition. |
Tags | The tags that are applied to the job definition. |
Timeout | The timeout time for jobs that are submitted with this job definition. |
Type | The type of job definition. |
Constructors
CfnJobDefinitionProps()
public CfnJobDefinitionProps()
Properties
ContainerProperties
An object with properties specific to Amazon ECS-based jobs.
public object ContainerProperties { get; set; }
Property Value
System.Object
Remarks
When containerProperties
is used in the job definition, it can't be used in addition to eksProperties
, ecsProperties
, or nodeProperties
.
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 to containerProperties
, eksProperties
, or nodeProperties
.
public object EcsProperties { get; set; }
Property Value
System.Object
Remarks
EksProperties
An object with properties that are specific to Amazon EKS-based jobs.
public object EksProperties { get; set; }
Property Value
System.Object
Remarks
When eksProperties
is used in the job definition, it can't be used in addition to containerProperties
, ecsProperties
, or nodeProperties
.
JobDefinitionName
The name of the job definition.
public string JobDefinitionName { get; set; }
Property Value
System.String
Remarks
NodeProperties
An object with properties that are specific to multi-node parallel jobs.
public object NodeProperties { get; set; }
Property Value
System.Object
Remarks
When nodeProperties
is used in the job definition, it can't be used in addition to containerProperties
, ecsProperties
, or eksProperties
.
If the job runs on Fargate resources, don't specify nodeProperties
. Use containerProperties
instead.
Parameters
Default parameters or parameter substitution placeholders that are set in the job definition.
public object Parameters { get; set; }
Property Value
System.Object
Remarks
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 .
PlatformCapabilities
The platform capabilities required by the job definition.
public string[] PlatformCapabilities { get; set; }
Property Value
System.String[]
Remarks
If no value is specified, it defaults to EC2
. Jobs run on Fargate resources specify FARGATE
.
PropagateTags
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
public object PropagateTags { get; set; }
Property Value
System.Object
Remarks
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.
RetryStrategy
The retry strategy to use for failed jobs that are submitted with this job definition.
public object RetryStrategy { get; set; }
Property Value
System.Object
Remarks
SchedulingPriority
The scheduling priority of the job definition.
public Nullable<double> SchedulingPriority { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
Tags
The tags that are applied to the job definition.
public object Tags { get; set; }
Property Value
System.Object
Remarks
Timeout
The timeout time for jobs that are submitted with this job definition.
public object Timeout { get; set; }
Property Value
System.Object
Remarks
After the amount of time you specify passes, AWS Batch terminates your jobs if they aren't finished.
Type
The type of job definition.
public string Type { get; set; }
Property Value
System.String
Remarks
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 <code>multinode</code> isn't supported.