Package software.amazon.awscdk.services.deadline

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.deadline.CfnQueue
All Implemented Interfaces:
IInspectable, IQueueRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:18.182Z") @Stability(Stable) public class CfnQueue extends CfnResource implements IInspectable, IQueueRef, ITaggableV2
Creates a queue to coordinate the order in which jobs run on a farm.

A queue can also specify where to pull resources and indicate where to output completed jobs.

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.deadline.*;
 CfnQueue cfnQueue = CfnQueue.Builder.create(this, "MyCfnQueue")
         .displayName("displayName")
         .farmId("farmId")
         // the properties below are optional
         .allowedStorageProfileIds(List.of("allowedStorageProfileIds"))
         .defaultBudgetAction("defaultBudgetAction")
         .description("description")
         .jobAttachmentSettings(JobAttachmentSettingsProperty.builder()
                 .rootPrefix("rootPrefix")
                 .s3BucketName("s3BucketName")
                 .build())
         .jobRunAsUser(JobRunAsUserProperty.builder()
                 .runAs("runAs")
                 // the properties below are optional
                 .posix(PosixUserProperty.builder()
                         .group("group")
                         .user("user")
                         .build())
                 .windows(WindowsUserProperty.builder()
                         .passwordArn("passwordArn")
                         .user("user")
                         .build())
                 .build())
         .requiredFileSystemLocationNames(List.of("requiredFileSystemLocationNames"))
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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::Deadline::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 Amazon Resource Name (ARN) of the queue.

    • getAttrQueueId

      @Stability(Stable) @NotNull public String getAttrQueueId()
      The queue ID.

    • 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

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The display name of the queue summary to update.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The display name of the queue summary to update.

    • getFarmId

      @Stability(Stable) @NotNull public String getFarmId()
      The farm ID.

    • setFarmId

      @Stability(Stable) public void setFarmId(@NotNull String value)
      The farm ID.

    • getAllowedStorageProfileIds

      @Stability(Stable) @Nullable public List<String> getAllowedStorageProfileIds()
      The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.

    • setAllowedStorageProfileIds

      @Stability(Stable) public void setAllowedStorageProfileIds(@Nullable List<String> value)
      The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.

    • getDefaultBudgetAction

      @Stability(Stable) @Nullable public String getDefaultBudgetAction()
      The default action taken on a queue summary if a budget wasn't configured.

    • setDefaultBudgetAction

      @Stability(Stable) public void setDefaultBudgetAction(@Nullable String value)
      The default action taken on a queue summary if a budget wasn't configured.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the queue that helps identify what the queue is used for.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the queue that helps identify what the queue is used for.

    • getJobAttachmentSettings

      @Stability(Stable) @Nullable public Object getJobAttachmentSettings()
      The job attachment settings.

      Returns union: either IResolvable or CfnQueue.JobAttachmentSettingsProperty

    • setJobAttachmentSettings

      @Stability(Stable) public void setJobAttachmentSettings(@Nullable IResolvable value)
      The job attachment settings.

    • setJobAttachmentSettings

      @Stability(Stable) public void setJobAttachmentSettings(@Nullable CfnQueue.JobAttachmentSettingsProperty value)
      The job attachment settings.

    • getJobRunAsUser

      @Stability(Stable) @Nullable public Object getJobRunAsUser()
      Identifies the user for a job.

      Returns union: either IResolvable or CfnQueue.JobRunAsUserProperty

    • setJobRunAsUser

      @Stability(Stable) public void setJobRunAsUser(@Nullable IResolvable value)
      Identifies the user for a job.

    • setJobRunAsUser

      @Stability(Stable) public void setJobRunAsUser(@Nullable CfnQueue.JobRunAsUserProperty value)
      Identifies the user for a job.

    • getRequiredFileSystemLocationNames

      @Stability(Stable) @Nullable public List<String> getRequiredFileSystemLocationNames()
      The file system location that the queue uses.

    • setRequiredFileSystemLocationNames

      @Stability(Stable) public void setRequiredFileSystemLocationNames(@Nullable List<String> value)
      The file system location that the queue uses.

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to add to your queue.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to add to your queue.