Package software.amazon.awscdk.services.batch

Class EksJobDefinitionProps.Builder

java.lang.Object

software.amazon.awscdk.services.batch.EksJobDefinitionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EksJobDefinitionProps>

Enclosing interface:

EksJobDefinitionProps

@Stability(Stable)
public static final class EksJobDefinitionProps.Builder
extends Object
implements software.amazon.jsii.Builder<EksJobDefinitionProps>

A builder for EksJobDefinitionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EksJobDefinitionProps	build()	Builds the configured instance.
EksJobDefinitionProps.Builder	container(EksContainerDefinition container)	Sets the value of EksJobDefinitionProps.getContainer()
EksJobDefinitionProps.Builder	dnsPolicy(DnsPolicy dnsPolicy)	Sets the value of EksJobDefinitionProps.getDnsPolicy()
EksJobDefinitionProps.Builder	jobDefinitionName(String jobDefinitionName)	Sets the value of JobDefinitionProps.getJobDefinitionName()
EksJobDefinitionProps.Builder	parameters(Map<String,? extends Object> parameters)	Sets the value of JobDefinitionProps.getParameters()
EksJobDefinitionProps.Builder	retryAttempts(Number retryAttempts)	Sets the value of JobDefinitionProps.getRetryAttempts()
EksJobDefinitionProps.Builder	retryStrategies(List<? extends RetryStrategy> retryStrategies)	Sets the value of JobDefinitionProps.getRetryStrategies()
EksJobDefinitionProps.Builder	schedulingPriority(Number schedulingPriority)	Sets the value of JobDefinitionProps.getSchedulingPriority()
EksJobDefinitionProps.Builder	serviceAccount(String serviceAccount)	Sets the value of EksJobDefinitionProps.getServiceAccount()
EksJobDefinitionProps.Builder	skipDeregisterOnUpdate(Boolean skipDeregisterOnUpdate)	Sets the value of JobDefinitionProps.getSkipDeregisterOnUpdate()
EksJobDefinitionProps.Builder	timeout(Duration timeout)	Sets the value of JobDefinitionProps.getTimeout()
EksJobDefinitionProps.Builder	useHostNetwork(Boolean useHostNetwork)	Sets the value of EksJobDefinitionProps.getUseHostNetwork()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

container

@Stability(Stable)
public EksJobDefinitionProps.Builder container(EksContainerDefinition container)

Sets the value of EksJobDefinitionProps.getContainer()

Parameters:

container - The container this Job Definition will run. This parameter is required.

Returns:

this

dnsPolicy

@Stability(Stable)
public EksJobDefinitionProps.Builder dnsPolicy(DnsPolicy dnsPolicy)

Sets the value of EksJobDefinitionProps.getDnsPolicy()

Parameters:

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

Returns:

this

serviceAccount

@Stability(Stable)
public EksJobDefinitionProps.Builder serviceAccount(String serviceAccount)

Sets the value of EksJobDefinitionProps.getServiceAccount()

Parameters:

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

Returns:

this

useHostNetwork

@Stability(Stable)
public EksJobDefinitionProps.Builder useHostNetwork(Boolean useHostNetwork)

Sets the value of EksJobDefinitionProps.getUseHostNetwork()

Parameters:

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

Returns:

this

jobDefinitionName

@Stability(Stable)
public EksJobDefinitionProps.Builder jobDefinitionName(String jobDefinitionName)

Sets the value of JobDefinitionProps.getJobDefinitionName()

Parameters:

jobDefinitionName - The name of this job definition.

Returns:

this

parameters

@Stability(Stable)
public EksJobDefinitionProps.Builder parameters(Map<String,? extends Object> parameters)

Sets the value of JobDefinitionProps.getParameters()

Parameters:

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

Returns:

this

retryAttempts

@Stability(Stable)
public EksJobDefinitionProps.Builder retryAttempts(Number retryAttempts)

Sets the value of JobDefinitionProps.getRetryAttempts()

Parameters:

retryAttempts - The number of times to retry a job. The job is retried on failure the same number of attempts as the value.

Returns:

this

retryStrategies

@Stability(Stable)
public EksJobDefinitionProps.Builder retryStrategies(List<? extends RetryStrategy> retryStrategies)

Sets the value of JobDefinitionProps.getRetryStrategies()

Parameters:

retryStrategies - Defines the retry behavior for this job.

Returns:

this

schedulingPriority

@Stability(Stable)
public EksJobDefinitionProps.Builder schedulingPriority(Number schedulingPriority)

Sets the value of JobDefinitionProps.getSchedulingPriority()

Parameters:

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

Returns:

this

skipDeregisterOnUpdate

@Stability(Stable)
public EksJobDefinitionProps.Builder skipDeregisterOnUpdate(Boolean skipDeregisterOnUpdate)

Sets the value of JobDefinitionProps.getSkipDeregisterOnUpdate()

Parameters:

skipDeregisterOnUpdate - Specifies whether the previous revision of the job definition is retained in an active status after UPDATE events for the resource. When the property is set to false, the previous revision of the job definition is de-registered after a new revision is created. When the property is set to true, the previous revision of the job definition is not de-registered.

Returns:

this

timeout

@Stability(Stable)
public EksJobDefinitionProps.Builder timeout(Duration timeout)

Sets the value of JobDefinitionProps.getTimeout()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public EksJobDefinitionProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<EksJobDefinitionProps>

Returns:

a new instance of EksJobDefinitionProps

Throws:

NullPointerException - if any required attribute was not provided