Class CfnJobDefinition

The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnJobDefinition

Implements

IInspectable

IJobDefinitionRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Batch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnJobDefinition : CfnResource, IInspectable, IJobDefinitionRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnJobDefinition Inherits CfnResource Implements IInspectable, IJobDefinitionRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

Synopsis

Constructors

CfnJobDefinition(Construct, string, ICfnJobDefinitionProps)

Create a new AWS::Batch::JobDefinition.

Properties

AttrJobDefinitionArn	The job definition ARN, such as batch: *us-east-1* : *111122223333* :job-definition/ *test-gpu* : *2* .
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition.
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.
JobDefinitionRef	A reference to a JobDefinition resource.
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.
ResourceRetentionPolicy	Specifies the resource retention policy settings for the job definition.
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	Tag Manager which manages the tags for this resource.
TagsRaw	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.

Methods

ArnForJobDefinition(IJobDefinitionRef)	The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition.
FromJobDefinitionArn(Construct, string, string)	Creates a new IJobDefinitionRef from an ARN.
FromJobDefinitionName(Construct, string, string)	Creates a new IJobDefinitionRef from a jobDefinitionName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnJobDefinition(object)	Checks whether the given object is a CfnJobDefinition.
RenderProperties(IDictionary<string, object>)	The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition.

Constructors

CfnJobDefinition(Construct, string, ICfnJobDefinitionProps)

Create a new AWS::Batch::JobDefinition.

public CfnJobDefinition(Construct scope, string id, ICfnJobDefinitionProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnJobDefinitionProps

Resource properties.

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

Properties

AttrJobDefinitionArn

The job definition ARN, such as batch: *us-east-1* : *111122223333* :job-definition/ *test-gpu* : *2* .

public virtual string AttrJobDefinitionArn { get; }

Property Value

string

Remarks

CloudformationAttribute: JobDefinitionArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

ConsumableResourceProperties

Contains a list of consumable resources required by the job.

public virtual object? ConsumableResourceProperties { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnJobDefinition.IConsumableResourcePropertiesProperty

ContainerProperties

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

public virtual object? ContainerProperties { get; set; }

Property Value

object

Remarks

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 virtual object? EcsProperties { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnJobDefinition.IEcsPropertiesProperty

EksProperties

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

public virtual object? EksProperties { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnJobDefinition.IEksPropertiesProperty

JobDefinitionName

The name of the job definition.

public virtual string? JobDefinitionName { get; set; }

Property Value

string

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

JobDefinitionRef

A reference to a JobDefinition resource.

public virtual IJobDefinitionReference JobDefinitionRef { get; }

Property Value

IJobDefinitionReference

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

NodeProperties

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

public virtual object? NodeProperties { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnJobDefinition.INodePropertiesProperty

Parameters

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

public virtual object? Parameters { get; set; }

Property Value

object

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

PlatformCapabilities

The platform capabilities required by the job definition.

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

Property Value

string[]

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

PropagateTags

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.

public virtual object? PropagateTags { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

ResourceRetentionPolicy

Specifies the resource retention policy settings for the job definition.

public virtual object? ResourceRetentionPolicy { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnJobDefinition.IResourceRetentionPolicyProperty

RetryStrategy

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

public virtual object? RetryStrategy { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnJobDefinition.IRetryStrategyProperty

SchedulingPriority

The scheduling priority of the job definition.

public virtual double? SchedulingPriority { get; set; }

Property Value

double?

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

TagsRaw

The tags that are applied to the job definition.

public virtual object? TagsRaw { get; set; }

Property Value

object

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

Timeout

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

public virtual object? Timeout { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnJobDefinition.ITimeoutProperty

Type

The type of job definition.

public virtual string Type { get; set; }

Property Value

string

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

Methods

ArnForJobDefinition(IJobDefinitionRef)

The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition.

public static string ArnForJobDefinition(IJobDefinitionRef resource)

Parameters

resource IJobDefinitionRef

Returns

string

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

FromJobDefinitionArn(Construct, string, string)

Creates a new IJobDefinitionRef from an ARN.

public static IJobDefinitionRef FromJobDefinitionArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IJobDefinitionRef

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

FromJobDefinitionName(Construct, string, string)

Creates a new IJobDefinitionRef from a jobDefinitionName.

public static IJobDefinitionRef FromJobDefinitionName(Construct scope, string id, string jobDefinitionName)

Parameters

scope Construct

id string

jobDefinitionName string

Returns

IJobDefinitionRef

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

IsCfnJobDefinition(object)

Checks whether the given object is a CfnJobDefinition.

public static bool IsCfnJobDefinition(object x)

Parameters

x object

Returns

bool

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

For more information, see Job Definitions in the ** .

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

CloudformationResource: AWS::Batch::JobDefinition

ExampleMetadata: fixture=_generated

Implements

IInspectable

IJobDefinitionRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable