Interface ICfnJobQueueProps
Properties for defining a CfnJobQueue
.
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnJobQueueProps
Syntax (vb)
Public Interface ICfnJobQueueProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Batch;
var cfnJobQueueProps = new CfnJobQueueProps {
ComputeEnvironmentOrder = new [] { new ComputeEnvironmentOrderProperty {
ComputeEnvironment = "computeEnvironment",
Order = 123
} },
Priority = 123,
// the properties below are optional
JobQueueName = "jobQueueName",
JobStateTimeLimitActions = new [] { new JobStateTimeLimitActionProperty {
Action = "action",
MaxTimeSeconds = 123,
Reason = "reason",
State = "state"
} },
SchedulingPolicyArn = "schedulingPolicyArn",
State = "state",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
};
Synopsis
Properties
ComputeEnvironmentOrder | The set of compute environments mapped to a job queue and their order relative to each other. |
JobQueueName | The name of the job queue. |
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. |
Priority | The priority of the job queue. |
SchedulingPolicyArn | The Amazon Resource Name (ARN) of the scheduling policy. |
State | The state of the job queue. |
Tags | The tags that are applied to the job queue. |
Properties
ComputeEnvironmentOrder
The set of compute environments mapped to a job queue and their order relative to each other.
object ComputeEnvironmentOrder { get; }
Property Value
System.Object
Remarks
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.
JobQueueName
The name of the job queue.
virtual string JobQueueName { get; }
Property Value
System.String
Remarks
It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
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.
virtual object JobStateTimeLimitActions { get; }
Property Value
System.Object
Remarks
AWS Batch will perform each action after maxTimeSeconds
has passed.
Priority
The priority of the job queue.
double Priority { get; }
Property Value
System.Double
Remarks
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.
SchedulingPolicyArn
The Amazon Resource Name (ARN) of the scheduling policy.
virtual string SchedulingPolicyArn { get; }
Property Value
System.String
Remarks
The format is aws: Partition :batch: Region : Account :scheduling-policy/ Name
. For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy
.
State
The state of the job queue.
virtual string State { get; }
Property Value
System.String
Remarks
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.
Tags
The tags that are applied to the job queue.
virtual IDictionary<string, string> Tags { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
For more information, see Tagging your AWS Batch resources in AWS Batch User Guide .