Package org.cdk8s.plus24

Class CronJob

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

org.cdk8s.plus24.Resource

org.cdk8s.plus24.AbstractPod

org.cdk8s.plus24.Workload

org.cdk8s.plus24.CronJob

All Implemented Interfaces:

IApiEndpoint, IApiResource, INetworkPolicyPeer, IPodSelector, IResource, ISubject, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-07-08T00:25:14.107Z")
@Stability(Stable)
public class CronJob
extends Workload

A CronJob is responsible for creating a Job and scheduling it based on provided cron schedule.

This helps running Jobs in a recurring manner.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CronJob.Builder	A fluent builder for CronJob.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface org.cdk8s.plus24.IApiEndpoint

IApiEndpoint.Jsii$Default

Nested classes/interfaces inherited from interface org.cdk8s.plus24.IApiResource

IApiResource.Jsii$Default

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface org.cdk8s.plus24.INetworkPolicyPeer

INetworkPolicyPeer.Jsii$Default

Nested classes/interfaces inherited from interface org.cdk8s.plus24.IPodSelector

IPodSelector.Jsii$Default

Nested classes/interfaces inherited from interface org.cdk8s.plus24.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface org.cdk8s.plus24.ISubject

ISubject.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected org.cdk8s.ApiObject	getApiObject()	The underlying cdk8s API object.
String	getConcurrencyPolicy()	The policy used by this cron job to determine the concurrency mode in which to schedule jobs.
Number	getFailedJobsRetained()	The number of failed jobs retained by this cron job.
String	getResourceType()	Represents the resource type.
org.cdk8s.Cron	getSchedule()	The schedule this cron job is scheduled to run in.
org.cdk8s.Duration	getStartingDeadline()	The time by which the running cron job needs to schedule the next job execution.
Number	getSuccessfulJobsRetained()	The number of successful jobs retained by this cron job.
Boolean	getSuspend()	Whether or not the cron job is currently suspended or not.
String	getTimeZone()	The timezone which this cron job would follow to schedule jobs.

Methods inherited from class org.cdk8s.plus24.Workload

getConnections, getMatchExpressions, getMatchLabels, getPodMetadata, getScheduling, select

Methods inherited from class org.cdk8s.plus24.AbstractPod

addContainer, addHostAlias, addInitContainer, addVolume, attachContainer, getAutomountServiceAccountToken, getContainers, getDns, getDockerRegistryAuth, getHostAliases, getHostNetwork, getInitContainers, getIsolate, getRestartPolicy, getSecurityContext, getServiceAccount, getTerminationGracePeriod, getVolumes, toNetworkPolicyPeerConfig, toPodSelector, toPodSelectorConfig, toSubjectConfiguration

Methods inherited from class org.cdk8s.plus24.Resource

asApiResource, asNonApiResource, getApiGroup, getApiVersion, getKind, getMetadata, getName, getPermissions, getResourceName

Methods inherited from class software.constructs.Construct

getNode, isConstruct, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CronJob

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

CronJob

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

CronJob

@Stability(Stable)
public CronJob(@NotNull
               software.constructs.Construct scope,
               @NotNull
               String id,
               @NotNull
               CronJobProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getApiObject

@Stability(Stable)
@NotNull
protected org.cdk8s.ApiObject getApiObject()

The underlying cdk8s API object.

Specified by:

getApiObject in class Resource

See Also:

base.Resource.apiObject

getConcurrencyPolicy

@Stability(Stable)
@NotNull
public String getConcurrencyPolicy()

The policy used by this cron job to determine the concurrency mode in which to schedule jobs.

getFailedJobsRetained

@Stability(Stable)
@NotNull
public Number getFailedJobsRetained()

The number of failed jobs retained by this cron job.

getResourceType

@Stability(Stable)
@NotNull
public String getResourceType()

Represents the resource type.

Specified by:

getResourceType in interface IApiResource

Specified by:

getResourceType in class Resource

See Also:

https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources

getSchedule

@Stability(Stable)
@NotNull
public org.cdk8s.Cron getSchedule()

The schedule this cron job is scheduled to run in.

getStartingDeadline

@Stability(Stable)
@NotNull
public org.cdk8s.Duration getStartingDeadline()

The time by which the running cron job needs to schedule the next job execution.

The job is considered as failed if it misses this deadline.

getSuccessfulJobsRetained

@Stability(Stable)
@NotNull
public Number getSuccessfulJobsRetained()

The number of successful jobs retained by this cron job.

getSuspend

@Stability(Stable)
@NotNull
public Boolean getSuspend()

Whether or not the cron job is currently suspended or not.

getTimeZone

@Stability(Stable)
@Nullable
public String getTimeZone()

The timezone which this cron job would follow to schedule jobs.