Class CfnJobDefinition
The AWS::Batch::JobDefinition
resource specifies the parameters for an AWS Batch job definition.
Inherited Members
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnJobDefinition : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnJobDefinition
Inherits CfnResource
Implements IInspectable, 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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnJobDefinition(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnJobDefinition(Construct, String, ICfnJobDefinitionProps) |
Properties
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | 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
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnJobDefinition(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnJobDefinition(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnJobDefinition(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnJobDefinition(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnJobDefinition(Construct, String, ICfnJobDefinitionProps)
public CfnJobDefinition(Construct scope, string id, ICfnJobDefinitionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnJobDefinitionProps
Resource properties.
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ContainerProperties
An object with properties specific to Amazon ECS-based jobs.
public virtual object ContainerProperties { get; set; }
Property Value
System.Object
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
System.Object
EksProperties
An object with properties that are specific to Amazon EKS-based jobs.
public virtual object EksProperties { get; set; }
Property Value
System.Object
JobDefinitionName
The name of the job definition.
public virtual string JobDefinitionName { get; set; }
Property Value
System.String
NodeProperties
An object with properties that are specific to multi-node parallel jobs.
public virtual object NodeProperties { get; set; }
Property Value
System.Object
Parameters
Default parameters or parameter substitution placeholders that are set in the job definition.
public virtual object Parameters { get; set; }
Property Value
System.Object
PlatformCapabilities
The platform capabilities required by the job definition.
public virtual string[] PlatformCapabilities { get; set; }
Property Value
System.String[]
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
System.Object
RetryStrategy
The retry strategy to use for failed jobs that are submitted with this job definition.
public virtual object RetryStrategy { get; set; }
Property Value
System.Object
SchedulingPriority
The scheduling priority of the job definition.
public virtual Nullable<double> SchedulingPriority { get; set; }
Property Value
System.Nullable<System.Double>
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags that are applied to the job definition.
public virtual object TagsRaw { get; set; }
Property Value
System.Object
Timeout
The timeout time for jobs that are submitted with this job definition.
public virtual object Timeout { get; set; }
Property Value
System.Object
Type
The type of job definition.
public virtual string Type { get; set; }
Property Value
System.String
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>