Package software.amazon.awscdk.services.batch

Class CfnJobQueue.Builder

java.lang.Object

software.amazon.awscdk.services.batch.CfnJobQueue.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobQueue>

Enclosing class:

CfnJobQueue

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

A fluent builder for CfnJobQueue.

Method Summary

Modifier and Type	Method	Description
CfnJobQueue	build()
CfnJobQueue.Builder	computeEnvironmentOrder(List<? extends Object> computeEnvironmentOrder)	The set of compute environments mapped to a job queue and their order relative to each other.
CfnJobQueue.Builder	computeEnvironmentOrder(IResolvable computeEnvironmentOrder)	The set of compute environments mapped to a job queue and their order relative to each other.
static CfnJobQueue.Builder	create(software.constructs.Construct scope, String id)
CfnJobQueue.Builder	jobQueueName(String jobQueueName)	The name of the job queue.
CfnJobQueue.Builder	jobStateTimeLimitActions(List<? extends Object> jobStateTimeLimitActions)	The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times.
CfnJobQueue.Builder	jobStateTimeLimitActions(IResolvable jobStateTimeLimitActions)	The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times.
CfnJobQueue.Builder	priority(Number priority)	The priority of the job queue.
CfnJobQueue.Builder	schedulingPolicyArn(String schedulingPolicyArn)	The Amazon Resource Name (ARN) of the scheduling policy.
CfnJobQueue.Builder	state(String state)	The state of the job queue.
CfnJobQueue.Builder	tags(Map<String,String> tags)	The tags that are applied to the job queue.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnJobQueue.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnJobQueue.Builder.

computeEnvironmentOrder

@Stability(Stable)
public CfnJobQueue.Builder computeEnvironmentOrder(IResolvable computeEnvironmentOrder)

The set of compute environments mapped to a job queue and their order relative to each other.

The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 ( EC2 or SPOT ) or Fargate ( FARGATE or FARGATE_SPOT ); EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

Parameters:

computeEnvironmentOrder - The set of compute environments mapped to a job queue and their order relative to each other. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-computeenvironmentorder

computeEnvironmentOrder

@Stability(Stable)
public CfnJobQueue.Builder computeEnvironmentOrder(List<? extends Object> computeEnvironmentOrder)

The set of compute environments mapped to a job queue and their order relative to each other.

The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 ( EC2 or SPOT ) or Fargate ( FARGATE or FARGATE_SPOT ); EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

Parameters:

computeEnvironmentOrder - The set of compute environments mapped to a job queue and their order relative to each other. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-computeenvironmentorder

priority

@Stability(Stable)
public CfnJobQueue.Builder priority(Number priority)

The priority of the job queue.

Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1 . All of the compute environments must be either EC2 ( EC2 or SPOT ) or Fargate ( FARGATE or FARGATE_SPOT ); EC2 and Fargate compute environments can't be mixed.

Parameters:

priority - The priority of the job queue. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-priority

jobQueueName

@Stability(Stable)
public CfnJobQueue.Builder jobQueueName(String jobQueueName)

The name of the job queue.

It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Parameters:

jobQueueName - The name of the job queue. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobqueuename

jobStateTimeLimitActions

@Stability(Stable)
public CfnJobQueue.Builder jobStateTimeLimitActions(IResolvable jobStateTimeLimitActions)

The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times.

AWS Batch will perform each action after maxTimeSeconds has passed.

Parameters:

jobStateTimeLimitActions - The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobstatetimelimitactions

jobStateTimeLimitActions

@Stability(Stable)
public CfnJobQueue.Builder jobStateTimeLimitActions(List<? extends Object> jobStateTimeLimitActions)

The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times.

AWS Batch will perform each action after maxTimeSeconds has passed.

Parameters:

jobStateTimeLimitActions - The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobstatetimelimitactions

schedulingPolicyArn

@Stability(Stable)
public CfnJobQueue.Builder schedulingPolicyArn(String schedulingPolicyArn)

The Amazon Resource Name (ARN) of the scheduling policy.

The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy .

Parameters:

schedulingPolicyArn - The Amazon Resource Name (ARN) of the scheduling policy. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-schedulingpolicyarn

state

@Stability(Stable)
public CfnJobQueue.Builder state(String state)

The state of the job queue.

If the job queue state is ENABLED , it is able to accept jobs. If the job queue state is DISABLED , new jobs can't be added to the queue, but jobs already in the queue can finish.

Parameters:

state - The state of the job queue. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-state

tags

@Stability(Stable)
public CfnJobQueue.Builder tags(Map<String,String> tags)

The tags that are applied to the job queue.

For more information, see Tagging your AWS Batch resources in AWS Batch User Guide .

Parameters:

tags - The tags that are applied to the job queue. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-tags

build

@Stability(Stable)
public CfnJobQueue build()

Specified by:

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

Returns:

a newly built instance of CfnJobQueue.