Class CfnJobQueue
The AWS::Batch::JobQueue
resource specifies the parameters for an AWS Batch job queue definition.
Inherited Members
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnJobQueue : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnJobQueue
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For more information, see Job Queues in the ** .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html
CloudformationResource: AWS::Batch::JobQueue
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",
JobStateTimeLimitActions = new [] { new JobStateTimeLimitActionProperty {
Action = "action",
MaxTimeSeconds = 123,
Reason = "reason",
State = "state"
} },
SchedulingPolicyArn = "schedulingPolicyArn",
State = "state",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});
Synopsis
Constructors
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 |
CfnJobQueue(Construct, String, ICfnJobQueueProps) |
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. |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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(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
CfnJobQueue(Construct, String, ICfnJobQueueProps)
public CfnJobQueue(Construct scope, string id, ICfnJobQueueProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnJobQueueProps
Resource properties.
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
JobQueueName
The name of the job queue.
public virtual string JobQueueName { get; set; }
Property Value
System.String
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.
public virtual object JobStateTimeLimitActions { get; set; }
Property Value
System.Object
Priority
The priority of the job queue.
public virtual double Priority { get; set; }
Property Value
System.Double
SchedulingPolicyArn
The Amazon Resource Name (ARN) of the scheduling policy.
public virtual string SchedulingPolicyArn { get; set; }
Property Value
System.String
State
The state of the job queue.
public virtual string State { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags that are applied to the job queue.
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
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>