CfnQueueProps

class aws_cdk.aws_deadline.CfnQueueProps(*, display_name, farm_id, allowed_storage_profile_ids=None, default_budget_action=None, description=None, job_attachment_settings=None, job_run_as_user=None, required_file_system_location_names=None, role_arn=None, tags=None)

Bases: object

Properties for defining a CfnQueue.

Parameters:
  • display_name (str) – The display name of the queue summary to update. .. epigraph:: 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.

  • farm_id (str) – The farm ID.

  • allowed_storage_profile_ids (Optional[Sequence[str]]) – The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.

  • default_budget_action (Optional[str]) – The default action taken on a queue summary if a budget wasn’t configured. Default: - “NONE”

  • description (Optional[str]) – A description of the queue that helps identify what the queue is used for. Default: - “”

  • job_attachment_settings (Union[IResolvable, JobAttachmentSettingsProperty, Dict[str, Any], None]) – The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.

  • job_run_as_user (Union[IResolvable, JobRunAsUserProperty, Dict[str, Any], None]) – Identifies the user for a job.

  • required_file_system_location_names (Optional[Sequence[str]]) – The file system location that the queue uses.

  • role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

cfn_queue_props = deadline.CfnQueueProps(
    display_name="displayName",
    farm_id="farmId",

    # the properties below are optional
    allowed_storage_profile_ids=["allowedStorageProfileIds"],
    default_budget_action="defaultBudgetAction",
    description="description",
    job_attachment_settings=deadline.CfnQueue.JobAttachmentSettingsProperty(
        root_prefix="rootPrefix",
        s3_bucket_name="s3BucketName"
    ),
    job_run_as_user=deadline.CfnQueue.JobRunAsUserProperty(
        run_as="runAs",

        # the properties below are optional
        posix=deadline.CfnQueue.PosixUserProperty(
            group="group",
            user="user"
        ),
        windows=deadline.CfnQueue.WindowsUserProperty(
            password_arn="passwordArn",
            user="user"
        )
    ),
    required_file_system_location_names=["requiredFileSystemLocationNames"],
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

allowed_storage_profile_ids

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

See:

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

default_budget_action

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

Default:
  • “NONE”

See:

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

description

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

Default:
  • “”

See:

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

display_name

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:

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

farm_id

The farm ID.

See:

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

job_attachment_settings

The job attachment settings.

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

See:

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

job_run_as_user

Identifies the user for a job.

See:

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

required_file_system_location_names

The file system location that the queue uses.

See:

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

role_arn

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

See:

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

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.

See:

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