CfnQueueMixinProps

class aws_cdk.mixins_preview.aws_deadline.mixins.CfnQueueMixinProps(*, allowed_storage_profile_ids=None, default_budget_action=None, description=None, display_name=None, farm_id=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 CfnQueuePropsMixin.

Parameters:

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. .. 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. Default: - “”
display_name (Optional[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 (Optional[str]) – The farm ID.
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.mixins_preview.aws_deadline import mixins as deadline_mixins

cfn_queue_mixin_props = deadline_mixins.CfnQueueMixinProps(
    allowed_storage_profile_ids=["allowedStorageProfileIds"],
    default_budget_action="defaultBudgetAction",
    description="description",
    display_name="displayName",
    farm_id="farmId",
    job_attachment_settings=deadline_mixins.CfnQueuePropsMixin.JobAttachmentSettingsProperty(
        root_prefix="rootPrefix",
        s3_bucket_name="s3BucketName"
    ),
    job_run_as_user=deadline_mixins.CfnQueuePropsMixin.JobRunAsUserProperty(
        posix=deadline_mixins.CfnQueuePropsMixin.PosixUserProperty(
            group="group",
            user="user"
        ),
        run_as="runAs",
        windows=deadline_mixins.CfnQueuePropsMixin.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.

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:

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.