IJobDefinition Interface
Represents a JobDefinition.
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
jobDefinitionArnstringjob_definition_arnstrjobDefinitionArnStringJobDefinitionArnstringJobDefinitionArn*string#jobDefinitionNamestringjob_definition_namestrjobDefinitionNameStringJobDefinitionNamestringJobDefinitionName*string#jobDefinitionRefJobDefinitionReferencejob_definition_refJobDefinitionReferencejobDefinitionRefJobDefinitionReferenceJobDefinitionRefJobDefinitionReferenceJobDefinitionRefJobDefinitionReference#parametersmay be undefined{ [key: string]: any }parametersmay be undefinedtyping.Mapping[str, Any]parametersmay be undefinedMap<String, Object>Parametersmay be undefinedIDictionary<string, object>Parametersmay be undefined*map[string]interface{}= none#retryAttemptsmay be undefinednumberretry_attemptsmay be undefinedint | floatretryAttemptsmay be undefinedNumberRetryAttemptsmay be undefineddoubleRetryAttemptsmay be undefined*float64= 1#The job is retried on failure the same number of attempts as the value.
retryStrategiesRetryStrategy[]retry_strategiestyping.List[RetryStrategy]retryStrategiesList<RetryStrategy>RetryStrategiesRetryStrategy[]RetryStrategies*[]RetryStrategy#Default: no RetryStrategy
schedulingPrioritymay be undefinednumberscheduling_prioritymay be undefinedint | floatschedulingPrioritymay be undefinedNumberSchedulingPrioritymay be undefineddoubleSchedulingPrioritymay be undefined*float64= none#Only used in Fairshare Scheduling to decide which job to run first when there are multiple jobs with the same share identifier.
timeoutmay be undefinedDurationtimeoutmay be undefinedDurationtimeoutmay be undefinedDurationTimeoutmay be undefinedDurationTimeoutmay be undefinedDuration#Default: no timeout
After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.
Methods
addRetryStrategy(strategy: RetryStrategy): voiddef add_retry_strategy(self, strategy: RetryStrategy) -> Nonepublic void addRetryStrategy(RetryStrategy strategy)public void AddRetryStrategy(RetryStrategy strategy)func AddRetryStrategy(Strategy RetryStrategy)#applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining