Package software.amazon.awscdk.services.pcs

Interface CfnQueueProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQueueProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:10.206Z")
@Stability(Stable)
public interface CfnQueueProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnQueue.

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.*;
 CfnQueueProps cfnQueueProps = CfnQueueProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnQueueProps.Builder	A builder for CfnQueueProps
static final class	CfnQueueProps.Jsii$Proxy	An implementation for CfnQueueProps

Method Summary

Modifier and Type	Method	Description
static CfnQueueProps.Builder	builder()
String	getClusterId()	The ID of the cluster of the queue.
default Object	getComputeNodeGroupConfigurations()	The list of compute node group configurations associated with the queue.
default String	getName()	The name that identifies the queue.
default Object	getSlurmConfiguration()	Additional options related to the Slurm scheduler.
default Map<String,String>	getTags()	1 or more tags added to the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterId

@Stability(Stable)
@NotNull
String getClusterId()

The ID of the cluster of the queue.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#cfn-pcs-queue-clusterid

getComputeNodeGroupConfigurations

@Stability(Stable)
@Nullable
default Object getComputeNodeGroupConfigurations()

The list of compute node group configurations associated with the queue.

Queues assign jobs to associated compute node groups.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#cfn-pcs-queue-computenodegroupconfigurations

getName

@Stability(Stable)
@Nullable
default String getName()

The name that identifies the queue.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#cfn-pcs-queue-name

getSlurmConfiguration

@Stability(Stable)
@Nullable
default Object getSlurmConfiguration()

Additional options related to the Slurm scheduler.

Returns union: either IResolvable or CfnQueue.SlurmConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#cfn-pcs-queue-slurmconfiguration

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

1 or more tags added to the resource.

Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html#cfn-pcs-queue-tags

builder

@Stability(Stable)
static CfnQueueProps.Builder builder()

Returns:

a CfnQueueProps.Builder of CfnQueueProps