Package software.amazon.awscdk.services.deadline

Interface CfnQueueProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQueueProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:24:56.289Z")
@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.deadline.*;
 CfnQueueProps cfnQueueProps = CfnQueueProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-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()
default List<String>	getAllowedStorageProfileIds()	The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
default String	getDefaultBudgetAction()	The default action taken on a queue summary if a budget wasn't configured.
default String	getDescription()	A description of the queue that helps identify what the queue is used for.
String	getDisplayName()	The display name of the queue summary to update.
String	getFarmId()	The farm ID.
default Object	getJobAttachmentSettings()	The job attachment settings.
default Object	getJobRunAsUser()	Identifies the user for a job.
default List<String>	getRequiredFileSystemLocationNames()	The file system location that the queue uses.
default String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.
default List<CfnTag>	getTags()	The tags to add to your queue.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDisplayName

@Stability(Stable)
@NotNull
String getDisplayName()

The display name of the queue summary to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

See Also:

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

getFarmId

@Stability(Stable)
@NotNull
String getFarmId()

The farm ID.

See Also:

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

getAllowedStorageProfileIds

@Stability(Stable)
@Nullable
default List<String> getAllowedStorageProfileIds()

The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.

See Also:

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

getDefaultBudgetAction

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

The default action taken on a queue summary if a budget wasn't configured.

Default: - "NONE"

See Also:

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

getDescription

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

A description of the queue that helps identify what the queue is used for.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Default: - ""

See Also:

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

getJobAttachmentSettings

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

The job attachment settings.

These are the Amazon S3 bucket name and the Amazon S3 prefix.

See Also:

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

getJobRunAsUser

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

Identifies the user for a job.

See Also:

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

getRequiredFileSystemLocationNames

@Stability(Stable)
@Nullable
default List<String> getRequiredFileSystemLocationNames()

The file system location that the queue uses.

See Also:

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

getRoleArn

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

The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to add to your queue.

Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

See Also:

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

builder

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

Returns:

a CfnQueueProps.Builder of CfnQueueProps