Class CfnJobQueue

The AWS::Batch::JobQueue resource specifies the parameters for an AWS Batch job queue definition.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnJobQueue

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

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(Construct, string, ICfnJobQueueProps)

The AWS::Batch::JobQueue resource specifies the parameters for an AWS Batch job queue definition.

Properties

AttrJobQueueArn	Returns the job queue ARN, such as `batch: us-east-1 : 111122223333 :job-queue/ JobQueueName` .
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The `AWS::Batch::JobQueue` resource specifies the parameters for an AWS Batch job queue definition.
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>)	The `AWS::Batch::JobQueue` resource specifies the parameters for an AWS Batch job queue definition.

Constructors

CfnJobQueue(Construct, string, ICfnJobQueueProps)

The AWS::Batch::JobQueue resource specifies the parameters for an AWS Batch job queue definition.

public CfnJobQueue(Construct scope, string id, ICfnJobQueueProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnJobQueueProps: Resource properties.

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

Properties

AttrJobQueueArn

Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .

public virtual string AttrJobQueueArn { get; }

Property Value

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

string

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

CfnProperties

The AWS::Batch::JobQueue resource specifies the parameters for an AWS Batch job queue definition.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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

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

object

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

JobQueueName

The name of the job queue.

public virtual string? JobQueueName { get; set; }

Property Value

string

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

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

object

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

Priority

The priority of the job queue.

public virtual double Priority { get; set; }

Property Value

double

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

SchedulingPolicyArn

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

public virtual string? SchedulingPolicyArn { get; set; }

Property Value

string

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

State

The state of the job queue.

public virtual string? State { get; set; }

Property Value

string

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

TagsRaw

The tags that are applied to the job queue.

public virtual IDictionary<string, string>? TagsRaw { get; set; }

Property Value

IDictionary<string, string>

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

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.

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

RenderProperties(IDictionary<string, object>)

The AWS::Batch::JobQueue resource specifies the parameters for an AWS Batch job queue definition.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

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

Implements

IInspectable

ITaggable