Package software.amazon.awscdk.services.batch

Interface IEksJobDefinition.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEksJobDefinition, IJobDefinition, IJobDefinition.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IEksJobDefinition.Jsii$Proxy

Enclosing interface:

IEksJobDefinition

@Internal
public static interface IEksJobDefinition.Jsii$Default
extends IEksJobDefinition, IJobDefinition.Jsii$Default

Internal default implementation for IEksJobDefinition.

Nested Class Summary

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

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

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

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

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

IEksJobDefinition.Jsii$Default, IEksJobDefinition.Jsii$Proxy

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.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	addRetryStrategy(RetryStrategy strategy)	Add a RetryStrategy to this JobDefinition.
default void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
default EksContainerDefinition	getContainer()	The container this Job Definition will run.
default DnsPolicy	getDnsPolicy()	The DNS Policy of the pod used by this Job Definition.
default ResourceEnvironment	getEnv()	The environment this resource belongs to.
default String	getJobDefinitionArn()	The ARN of this job definition.
default String	getJobDefinitionName()	The name of this job definition.
default software.constructs.Node	getNode()	The tree node.
default Map<String,Object>	getParameters()	The default parameters passed to the container These parameters can be referenced in the command that you give to the container.
default Number	getRetryAttempts()	The number of times to retry a job.
default List<RetryStrategy>	getRetryStrategies()	Defines the retry behavior for this job.
default Number	getSchedulingPriority()	The priority of this Job.
default String	getServiceAccount()	The name of the service account that's used to run the container.
default Stack	getStack()	The stack in which this resource is defined.
default Duration	getTimeout()	The timeout time for jobs that are submitted with this job definition.
default Boolean	getUseHostNetwork()	If specified, the Pod used by this Job Definition will use the host's network IP address.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNode

@Stability(Stable)
@NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IJobDefinition.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IJobDefinition.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IJobDefinition.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getJobDefinitionArn

@Stability(Stable)
@NotNull
default String getJobDefinitionArn()

The ARN of this job definition.

Specified by:

getJobDefinitionArn in interface IJobDefinition

Specified by:

getJobDefinitionArn in interface IJobDefinition.Jsii$Default

getJobDefinitionName

@Stability(Stable)
@NotNull
default String getJobDefinitionName()

The name of this job definition.

Specified by:

getJobDefinitionName in interface IJobDefinition

Specified by:

getJobDefinitionName in interface IJobDefinition.Jsii$Default

getRetryStrategies

@Stability(Stable)
@NotNull
default List<RetryStrategy> getRetryStrategies()

Defines the retry behavior for this job.

Default: - no `RetryStrategy`

Specified by:

getRetryStrategies in interface IJobDefinition

Specified by:

getRetryStrategies in interface IJobDefinition.Jsii$Default

getParameters

@Stability(Stable)
@Nullable
default Map<String,Object> getParameters()

The default parameters passed to the container These parameters can be referenced in the command that you give to the container.

Default: none

Specified by:

getParameters in interface IJobDefinition

Specified by:

getParameters in interface IJobDefinition.Jsii$Default

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html#parameters

getRetryAttempts

@Stability(Stable)
@Nullable
default Number getRetryAttempts()

The number of times to retry a job.

The job is retried on failure the same number of attempts as the value.

Default: 1

Specified by:

getRetryAttempts in interface IJobDefinition

Specified by:

getRetryAttempts in interface IJobDefinition.Jsii$Default

getSchedulingPriority

@Stability(Stable)
@Nullable
default Number getSchedulingPriority()

The priority of this Job.

Only used in Fairshare Scheduling to decide which job to run first when there are multiple jobs with the same share identifier.

Default: none

Specified by:

getSchedulingPriority in interface IJobDefinition

Specified by:

getSchedulingPriority in interface IJobDefinition.Jsii$Default

getTimeout

@Stability(Stable)
@Nullable
default Duration getTimeout()

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

After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.

Default: - no timeout

Specified by:

getTimeout in interface IJobDefinition

Specified by:

getTimeout in interface IJobDefinition.Jsii$Default

getContainer

@Stability(Stable)
@NotNull
default EksContainerDefinition getContainer()

The container this Job Definition will run.

Specified by:

getContainer in interface IEksJobDefinition

getDnsPolicy

@Stability(Stable)
@Nullable
default DnsPolicy getDnsPolicy()

The DNS Policy of the pod used by this Job Definition.

Default: `DnsPolicy.CLUSTER_FIRST`

Specified by:

getDnsPolicy in interface IEksJobDefinition

See Also:

• https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy

getServiceAccount

@Stability(Stable)
@Nullable
default String getServiceAccount()

The name of the service account that's used to run the container.

service accounts are Kubernetes method of identification and authentication, roughly analogous to IAM users.

Default: - the default service account of the container

Specified by:

getServiceAccount in interface IEksJobDefinition

See Also:

• https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html

getUseHostNetwork

@Stability(Stable)
@Nullable
default Boolean getUseHostNetwork()

If specified, the Pod used by this Job Definition will use the host's network IP address.

Otherwise, the Kubernetes pod networking model is enabled. Most AWS Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections.

Default: true

Specified by:

getUseHostNetwork in interface IEksJobDefinition

See Also:

• https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking

applyRemovalPolicy

@Stability(Stable)
default void applyRemovalPolicy(@NotNull
 RemovalPolicy policy)

Apply the given removal policy to this resource.

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).

Specified by:

applyRemovalPolicy in interface IJobDefinition.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

addRetryStrategy

@Stability(Stable)
default void addRetryStrategy(@NotNull
 RetryStrategy strategy)

Add a RetryStrategy to this JobDefinition.

Specified by:

addRetryStrategy in interface IJobDefinition

Specified by:

addRetryStrategy in interface IJobDefinition.Jsii$Default

Parameters:

strategy - This parameter is required.