Class CfnJobQueue
A CloudFormation AWS::Batch::JobQueue
.
Inherited Members
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.AWS.Batch.dll
Syntax (csharp)
public class CfnJobQueue : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnJobQueue
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Batch::JobQueue
resource specifies the parameters for an AWS Batch job queue definition. For more information, see Job Queues in the ** .
CloudformationResource: AWS::Batch::JobQueue
Link: 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 cfnJobQueue = new CfnJobQueue(this, "MyCfnJobQueue", new CfnJobQueueProps {
ComputeEnvironmentOrder = new [] { new ComputeEnvironmentOrderProperty {
ComputeEnvironment = "computeEnvironment",
Order = 123
} },
Priority = 123,
// the properties below are optional
JobQueueName = "jobQueueName",
SchedulingPolicyArn = "schedulingPolicyArn",
State = "state",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});
Synopsis
Constructors
CfnJobQueue(Construct, String, ICfnJobQueueProps) | Create a new |
CfnJobQueue(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnJobQueue(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrJobQueueArn | Returns the job queue ARN, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnJobQueue(Construct, String, ICfnJobQueueProps)
Create a new AWS::Batch::JobQueue
.
public CfnJobQueue(Construct scope, string id, ICfnJobQueueProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnJobQueueProps
- resource properties.
CfnJobQueue(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnJobQueue(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnJobQueue(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnJobQueue(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrJobQueueArn
Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName*
.
public virtual string AttrJobQueueArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: JobQueueArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ComputeEnvironmentOrder
The set of compute environments mapped to a job queue and their order relative to each other.
public virtual object ComputeEnvironmentOrder { get; set; }
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.
public virtual string JobQueueName { get; set; }
Property Value
System.String
Remarks
It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Priority
The priority of the job queue.
public virtual double Priority { get; set; }
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.
public virtual string SchedulingPolicyArn { get; set; }
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.
public virtual string State { get; set; }
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.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tagging your AWS Batch resources in AWS Batch User Guide .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>