Package software.amazon.awscdk.services.batch

Class JobDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.batch.JobDefinition

All Implemented Interfaces:

IConstruct, IDependable, IResource, IJobDefinition, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.661Z")
@Stability(Experimental)
public class JobDefinition
extends Resource
implements IJobDefinition

(experimental) Batch Job Definition.

Defines a batch job definition to execute a specific batch job.

Example:

 import software.amazon.awscdk.services.ecr.*;
 IRepository repo = Repository.fromRepositoryName(this, "batch-job-repo", "todo-list");
 JobDefinition.Builder.create(this, "batch-job-def-from-ecr")
         .container(JobDefinitionContainer.builder()
                 .image(new EcrImage(repo, "latest"))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JobDefinition.Builder	(experimental) A fluent builder for JobDefinition.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IJobDefinition

IJobDefinition.Jsii$Default, IJobDefinition.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	JobDefinition(software.amazon.jsii.JsiiObjectRef objRef)
	JobDefinition(software.constructs.Construct scope, String id, JobDefinitionProps props)

Method Summary

Modifier and Type	Method	Description
static IJobDefinition	fromJobDefinitionArn(software.constructs.Construct scope, String id, String jobDefinitionArn)	(experimental) Imports an existing batch job definition by its amazon resource name.
static IJobDefinition	fromJobDefinitionName(software.constructs.Construct scope, String id, String jobDefinitionName)	(experimental) Imports an existing batch job definition by its name.
String	getJobDefinitionArn()	(experimental) The ARN of this batch job definition.
String	getJobDefinitionName()	(experimental) The name of the batch job definition.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

JobDefinition

protected JobDefinition(software.amazon.jsii.JsiiObjectRef objRef)

JobDefinition

protected JobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

JobDefinition

@Stability(Experimental)
public JobDefinition(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 JobDefinitionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromJobDefinitionArn

@Stability(Experimental)
@NotNull
public static IJobDefinition fromJobDefinitionArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String jobDefinitionArn)

(experimental) Imports an existing batch job definition by its amazon resource name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

jobDefinitionArn - This parameter is required.

fromJobDefinitionName

@Stability(Experimental)
@NotNull
public static IJobDefinition fromJobDefinitionName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String jobDefinitionName)

(experimental) Imports an existing batch job definition by its name.

If name is specified without a revision then the latest active revision is used.

Parameters:

scope - This parameter is required.

id - This parameter is required.

jobDefinitionName - This parameter is required.

getJobDefinitionArn

@Stability(Experimental)
@NotNull
public String getJobDefinitionArn()

(experimental) The ARN of this batch job definition.

Specified by:

getJobDefinitionArn in interface IJobDefinition

getJobDefinitionName

@Stability(Experimental)
@NotNull
public String getJobDefinitionName()

(experimental) The name of the batch job definition.

Specified by:

getJobDefinitionName in interface IJobDefinition