Class CfnJobDefinitionProps

Properties for defining a CfnJobDefinition.

Inheritance

object

CfnJobDefinitionProps

Implements

ICfnJobDefinitionProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Batch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnJobDefinitionProps : ICfnJobDefinitionProps

Syntax (vb)

Public Class CfnJobDefinitionProps Implements ICfnJobDefinitionProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html

ExampleMetadata: fixture=_generated

Synopsis

Constructors

CfnJobDefinitionProps()

Properties for defining a CfnJobDefinition.

Properties

ConsumableResourceProperties	Contains a list of consumable resources required by the job.
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 ecsProperties is used in the job definition, it can't be used in addition to containerProperties , eksProperties , or nodeProperties .
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()

Properties for defining a CfnJobDefinition.

public CfnJobDefinitionProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html

ExampleMetadata: fixture=_generated

Properties

ConsumableResourceProperties

Contains a list of consumable resources required by the job.

public object? ConsumableResourceProperties { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-consumableresourceproperties

Type union: either IResolvable or CfnJobDefinition.IConsumableResourcePropertiesProperty

ContainerProperties

An object with properties specific to Amazon ECS-based jobs.

public object? ContainerProperties { get; set; }

Property Value

object

Remarks

When containerProperties is used in the job definition, it can't be used in addition to eksProperties , ecsProperties , or nodeProperties .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-containerproperties

Type union: either IResolvable or CfnJobDefinition.IContainerPropertiesProperty

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

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-ecsproperties

Type union: either IResolvable or CfnJobDefinition.IEcsPropertiesProperty

EksProperties

An object with properties that are specific to Amazon EKS-based jobs.

public object? EksProperties { get; set; }

Property Value

object

Remarks

When eksProperties is used in the job definition, it can't be used in addition to containerProperties , ecsProperties , or nodeProperties .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-eksproperties

Type union: either IResolvable or CfnJobDefinition.IEksPropertiesProperty

JobDefinitionName

The name of the job definition.

public string? JobDefinitionName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-jobdefinitionname

NodeProperties

An object with properties that are specific to multi-node parallel jobs.

public object? NodeProperties { get; set; }

Property Value

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 <code>nodeProperties</code> . Use <code>containerProperties</code> instead.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-nodeproperties

Type union: either IResolvable or CfnJobDefinition.INodePropertiesProperty

Parameters

Default parameters or parameter substitution placeholders that are set in the job definition.

public object? Parameters { get; set; }

Property Value

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-parameters

PlatformCapabilities

The platform capabilities required by the job definition.

public string[]? PlatformCapabilities { get; set; }

Property Value

string[]

Remarks

If no value is specified, it defaults to EC2 . Jobs run on Fargate resources specify FARGATE .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-platformcapabilities

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

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-propagatetags

Type union: either bool or IResolvable

RetryStrategy

The retry strategy to use for failed jobs that are submitted with this job definition.

public object? RetryStrategy { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-retrystrategy

Type union: either IResolvable or CfnJobDefinition.IRetryStrategyProperty

SchedulingPriority

The scheduling priority of the job definition.

public double? SchedulingPriority { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-schedulingpriority

Tags

The tags that are applied to the job definition.

public object? Tags { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-tags

Timeout

The timeout time for jobs that are submitted with this job definition.

public object? Timeout { get; set; }

Property Value

object

Remarks

After the amount of time you specify passes, AWS Batch terminates your jobs if they aren't finished.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-timeout

Type union: either IResolvable or CfnJobDefinition.ITimeoutProperty

Type

The type of job definition.

public string Type { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-type

Implements

ICfnJobDefinitionProps