Class CfnJobQueue
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.batch.CfnJobQueue
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:39.367Z")
@Stability(Stable)
public class CfnJobQueue
extends CfnResource
implements IInspectable, ITaggable
The
AWS::Batch::JobQueue
resource specifies the parameters for an AWS Batch job queue definition.
For more information, see Job Queues in the ** .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.batch.*; CfnJobQueue cfnJobQueue = CfnJobQueue.Builder.create(this, "MyCfnJobQueue") .computeEnvironmentOrder(List.of(ComputeEnvironmentOrderProperty.builder() .computeEnvironment("computeEnvironment") .order(123) .build())) .priority(123) // the properties below are optional .jobQueueName("jobQueueName") .jobStateTimeLimitActions(List.of(JobStateTimeLimitActionProperty.builder() .action("action") .maxTimeSeconds(123) .reason("reason") .state("state") .build())) .schedulingPolicyArn("schedulingPolicyArn") .state("state") .tags(Map.of( "tagsKey", "tags")) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnJobQueue
.static interface
The order that compute environments are tried in for job placement within a queue.static interface
Specifies an action that AWS Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnJobQueue
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnJobQueue
(software.amazon.jsii.JsiiObjectRef objRef) CfnJobQueue
(software.constructs.Construct scope, String id, CfnJobQueueProps props) -
Method Summary
Modifier and TypeMethodDescriptionReturns the job queue ARN, such asbatch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName*
.The set of compute environments mapped to a job queue and their order relative to each other.The name of the job queue.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.The priority of the job queue.The Amazon Resource Name (ARN) of the scheduling policy.getState()
The state of the job queue.getTags()
Tag Manager which manages the tags for this resource.The tags that are applied to the job queue.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setComputeEnvironmentOrder
(List<Object> value) The set of compute environments mapped to a job queue and their order relative to each other.void
The set of compute environments mapped to a job queue and their order relative to each other.void
setJobQueueName
(String value) The name of the job queue.void
setJobStateTimeLimitActions
(List<Object> value) 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.void
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.void
setPriority
(Number value) The priority of the job queue.void
setSchedulingPolicyArn
(String value) The Amazon Resource Name (ARN) of the scheduling policy.void
The state of the job queue.void
setTagsRaw
(Map<String, String> value) The tags that are applied to the job queue.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnJobQueue
protected CfnJobQueue(software.amazon.jsii.JsiiObjectRef objRef) -
CfnJobQueue
protected CfnJobQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnJobQueue
@Stability(Stable) public CfnJobQueue(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnJobQueueProps props) - 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.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrJobQueueArn
Returns the job queue ARN, such asbatch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName*
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getComputeEnvironmentOrder
The set of compute environments mapped to a job queue and their order relative to each other. -
setComputeEnvironmentOrder
The set of compute environments mapped to a job queue and their order relative to each other. -
setComputeEnvironmentOrder
The set of compute environments mapped to a job queue and their order relative to each other. -
getPriority
The priority of the job queue. -
setPriority
The priority of the job queue. -
getJobQueueName
The name of the job queue. -
setJobQueueName
The name of the job queue. -
getJobStateTimeLimitActions
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. -
setJobStateTimeLimitActions
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. -
setJobStateTimeLimitActions
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. -
getSchedulingPolicyArn
The Amazon Resource Name (ARN) of the scheduling policy. -
setSchedulingPolicyArn
The Amazon Resource Name (ARN) of the scheduling policy. -
getState
The state of the job queue. -
setState
The state of the job queue. -
getTagsRaw
The tags that are applied to the job queue. -
setTagsRaw
The tags that are applied to the job queue.
-