Package software.amazon.awscdk.services.pcs

Class CfnQueue

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.pcs.CfnQueue
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IQueueRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:41.257Z") @Stability(Stable) public class CfnQueue extends CfnResource implements IInspectable, IQueueRef, ITaggableV2
Creates an AWS PCS queue resource.

For more information, see Creating a queue in AWS PCS in the AWS PCS User Guide .

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.pcs.*;
 CfnQueue cfnQueue = CfnQueue.Builder.create(this, "MyCfnQueue")
         .clusterId("clusterId")
         // the properties below are optional
         .computeNodeGroupConfigurations(List.of(ComputeNodeGroupConfigurationProperty.builder()
                 .computeNodeGroupId("computeNodeGroupId")
                 .build()))
         .name("name")
         .slurmConfiguration(SlurmConfigurationProperty.builder()
                 .slurmCustomSettings(List.of(SlurmCustomSettingProperty.builder()
                         .parameterName("parameterName")
                         .parameterValue("parameterValue")
                         .build()))
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnQueue

      protected CfnQueue(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnQueue

      protected CfnQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnQueue

      @Stability(Stable) public CfnQueue(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnQueueProps props)
      Create a new AWS::PCS::Queue.

      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

    • arnForQueue

      @Stability(Stable) @NotNull public static String arnForQueue(@NotNull IQueueRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnQueue

      @Stability(Stable) @NotNull public static Boolean isCfnQueue(@NotNull Object x)
      Checks whether the given object is a CfnQueue.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      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 class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The unique Amazon Resource Name (ARN) of the queue.

    • getAttrErrorInfo

      @Stability(Stable) @NotNull public IResolvable getAttrErrorInfo()
      The list of errors that occurred during queue provisioning.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The generated unique ID of the queue.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The provisioning status of the queue.

      The provisioning status doesn't indicate the overall health of the queue. > The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED . For more information, see Frequently asked questions about Slurm versions in AWS PCS in the AWS PCS User Guide .

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getQueueRef

      @Stability(Stable) @NotNull public QueueReference getQueueRef()
      A reference to a Queue resource.
      Specified by:
      getQueueRef in interface IQueueRef

    • getClusterId

      @Stability(Stable) @NotNull public String getClusterId()
      The ID of the cluster of the queue.

    • setClusterId

      @Stability(Stable) public void setClusterId(@NotNull String value)
      The ID of the cluster of the queue.

    • getComputeNodeGroupConfigurations

      @Stability(Stable) @Nullable public Object getComputeNodeGroupConfigurations()
      The list of compute node group configurations associated with the queue.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnQueue.ComputeNodeGroupConfigurationProperty>

    • setComputeNodeGroupConfigurations

      @Stability(Stable) public void setComputeNodeGroupConfigurations(@Nullable IResolvable value)
      The list of compute node group configurations associated with the queue.

    • setComputeNodeGroupConfigurations

      @Stability(Stable) public void setComputeNodeGroupConfigurations(@Nullable List<Object> value)
      The list of compute node group configurations associated with the queue.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name that identifies the queue.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name that identifies the queue.

    • getSlurmConfiguration

      @Stability(Stable) @Nullable public Object getSlurmConfiguration()
      Additional options related to the Slurm scheduler.

      Returns union: either IResolvable or CfnQueue.SlurmConfigurationProperty

    • setSlurmConfiguration

      @Stability(Stable) public void setSlurmConfiguration(@Nullable IResolvable value)
      Additional options related to the Slurm scheduler.

    • setSlurmConfiguration

      @Stability(Stable) public void setSlurmConfiguration(@Nullable CfnQueue.SlurmConfigurationProperty value)
      Additional options related to the Slurm scheduler.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      1 or more tags added to the resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      1 or more tags added to the resource.