Package software.amazon.awscdk.services.deadline

Class CfnQueue.Builder

java.lang.Object

software.amazon.awscdk.services.deadline.CfnQueue.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnQueue>

Enclosing class:

CfnQueue

@Stability(Stable)
public static final class CfnQueue.Builder
extends Object
implements software.amazon.jsii.Builder<CfnQueue>

A fluent builder for CfnQueue.

Method Summary

Modifier and Type	Method	Description
CfnQueue.Builder	allowedStorageProfileIds(List<String> allowedStorageProfileIds)	The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
CfnQueue	build()
static CfnQueue.Builder	create(software.constructs.Construct scope, String id)
CfnQueue.Builder	defaultBudgetAction(String defaultBudgetAction)	The default action taken on a queue summary if a budget wasn't configured.
CfnQueue.Builder	description(String description)	A description of the queue that helps identify what the queue is used for.
CfnQueue.Builder	displayName(String displayName)	The display name of the queue summary to update.
CfnQueue.Builder	farmId(String farmId)	The farm ID.
CfnQueue.Builder	jobAttachmentSettings(IResolvable jobAttachmentSettings)	The job attachment settings.
CfnQueue.Builder	jobAttachmentSettings(CfnQueue.JobAttachmentSettingsProperty jobAttachmentSettings)	The job attachment settings.
CfnQueue.Builder	jobRunAsUser(IResolvable jobRunAsUser)	Identifies the user for a job.
CfnQueue.Builder	jobRunAsUser(CfnQueue.JobRunAsUserProperty jobRunAsUser)	Identifies the user for a job.
CfnQueue.Builder	requiredFileSystemLocationNames(List<String> requiredFileSystemLocationNames)	The file system location that the queue uses.
CfnQueue.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.
CfnQueue.Builder	tags(List<? extends CfnTag> tags)	The tags to add to your queue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnQueue.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnQueue.Builder.

displayName

@Stability(Stable)
public CfnQueue.Builder displayName(String displayName)

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.

Parameters:

displayName - The display name of the queue summary to update. This parameter is required.

Returns:

this

See Also:

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

farmId

@Stability(Stable)
public CfnQueue.Builder farmId(String farmId)

The farm ID.

Parameters:

farmId - The farm ID. This parameter is required.

Returns:

this

See Also:

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

allowedStorageProfileIds

@Stability(Stable)
public CfnQueue.Builder allowedStorageProfileIds(List<String> allowedStorageProfileIds)

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

Parameters:

allowedStorageProfileIds - The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems. This parameter is required.

Returns:

this

See Also:

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

defaultBudgetAction

@Stability(Stable)
public CfnQueue.Builder defaultBudgetAction(String defaultBudgetAction)

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

Default: - "NONE"

Parameters:

defaultBudgetAction - The default action taken on a queue summary if a budget wasn't configured. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnQueue.Builder description(String description)

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: - ""

Parameters:

description - A description of the queue that helps identify what the queue is used for. This parameter is required.

Returns:

this

See Also:

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

jobAttachmentSettings

@Stability(Stable)
public CfnQueue.Builder jobAttachmentSettings(IResolvable jobAttachmentSettings)

The job attachment settings.

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

Parameters:

jobAttachmentSettings - The job attachment settings. This parameter is required.

Returns:

this

See Also:

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

jobAttachmentSettings

@Stability(Stable)
public CfnQueue.Builder jobAttachmentSettings(CfnQueue.JobAttachmentSettingsProperty jobAttachmentSettings)

The job attachment settings.

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

Parameters:

jobAttachmentSettings - The job attachment settings. This parameter is required.

Returns:

this

See Also:

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

jobRunAsUser

@Stability(Stable)
public CfnQueue.Builder jobRunAsUser(IResolvable jobRunAsUser)

Identifies the user for a job.

Parameters:

jobRunAsUser - Identifies the user for a job. This parameter is required.

Returns:

this

See Also:

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

jobRunAsUser

@Stability(Stable)
public CfnQueue.Builder jobRunAsUser(CfnQueue.JobRunAsUserProperty jobRunAsUser)

Identifies the user for a job.

Parameters:

jobRunAsUser - Identifies the user for a job. This parameter is required.

Returns:

this

See Also:

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

requiredFileSystemLocationNames

@Stability(Stable)
public CfnQueue.Builder requiredFileSystemLocationNames(List<String> requiredFileSystemLocationNames)

The file system location that the queue uses.

Parameters:

requiredFileSystemLocationNames - The file system location that the queue uses. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnQueue.Builder roleArn(String roleArn)

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

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnQueue.Builder tags(List<? extends CfnTag> tags)

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.

Parameters:

tags - The tags to add to your queue. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnQueue build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnQueue>

Returns:

a newly built instance of CfnQueue.