CfnQueuePropsMixin

class aws_cdk.cfn_property_mixins.aws_deadline.CfnQueuePropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:

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

CloudformationResource:

AWS::Deadline::Queue

Mixin:

true

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.cfn_property_mixins import aws_deadline as deadline
import aws_cdk as cdk

# always_schedule_first: Any
# always_schedule_last: Any
# merge_strategy: cdk.IMergeStrategy
# priority_fifo: Any

cfn_queue_props_mixin = deadline.CfnQueuePropsMixin(deadline.CfnQueueMixinProps(
    allowed_storage_profile_ids=["allowedStorageProfileIds"],
    default_budget_action="defaultBudgetAction",
    description="description",
    display_name="displayName",
    farm_id="farmId",
    job_attachment_settings=deadline.CfnQueuePropsMixin.JobAttachmentSettingsProperty(
        root_prefix="rootPrefix",
        s3_bucket_name="s3BucketName"
    ),
    job_run_as_user=deadline.CfnQueuePropsMixin.JobRunAsUserProperty(
        posix=deadline.CfnQueuePropsMixin.PosixUserProperty(
            group="group",
            user="user"
        ),
        run_as="runAs",
        windows=deadline.CfnQueuePropsMixin.WindowsUserProperty(
            password_arn="passwordArn",
            user="user"
        )
    ),
    required_file_system_location_names=["requiredFileSystemLocationNames"],
    role_arn="roleArn",
    scheduling_configuration=deadline.CfnQueuePropsMixin.SchedulingConfigurationProperty(
        priority_balanced=deadline.CfnQueuePropsMixin.PriorityBalancedSchedulingConfigurationProperty(
            rendering_task_buffer=123
        ),
        priority_fifo=priority_fifo,
        weighted_balanced=deadline.CfnQueuePropsMixin.WeightedBalancedSchedulingConfigurationProperty(
            error_weight=123,
            max_priority_override=deadline.CfnQueuePropsMixin.SchedulingMaxPriorityOverrideProperty(
                always_schedule_first=always_schedule_first
            ),
            min_priority_override=deadline.CfnQueuePropsMixin.SchedulingMinPriorityOverrideProperty(
                always_schedule_last=always_schedule_last
            ),
            priority_weight=123,
            rendering_task_buffer=123,
            rendering_task_weight=123,
            submission_time_weight=123
        )
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Deadline::Queue.

Parameters:

  • props (Union[CfnQueueMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['allowedStorageProfileIds', 'defaultBudgetAction', 'description', 'displayName', 'farmId', 'jobAttachmentSettings', 'jobRunAsUser', 'requiredFileSystemLocationNames', 'roleArn', 'schedulingConfiguration', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

JobAttachmentSettingsProperty

class CfnQueuePropsMixin.JobAttachmentSettingsProperty(*, root_prefix=None, s3_bucket_name=None)

Bases: object

The job attachment settings.

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

Parameters:

  • root_prefix (Optional[str]) – The root prefix.

  • s3_bucket_name (Optional[str]) – The Amazon S3 bucket name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobattachmentsettings.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.cfn_property_mixins import aws_deadline as deadline

job_attachment_settings_property = deadline.CfnQueuePropsMixin.JobAttachmentSettingsProperty(
    root_prefix="rootPrefix",
    s3_bucket_name="s3BucketName"
)

Attributes

root_prefix

The root prefix.

See:

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

s3_bucket_name

The Amazon S3 bucket name.

See:

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

JobRunAsUserProperty

class CfnQueuePropsMixin.JobRunAsUserProperty(*, posix=None, run_as=None, windows=None)

Bases: object

Identifies the user for a job.

Parameters:

  • posix (Union[IResolvable, PosixUserProperty, Dict[str, Any], None]) – The user and group that the jobs in the queue run as.

  • run_as (Optional[str]) – Specifies whether the job should run using the queue’s system user or if the job should run using the worker agent system user.

  • windows (Union[IResolvable, WindowsUserProperty, Dict[str, Any], None]) – Identifies a Microsoft Windows user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobrunasuser.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.cfn_property_mixins import aws_deadline as deadline

job_run_as_user_property = deadline.CfnQueuePropsMixin.JobRunAsUserProperty(
    posix=deadline.CfnQueuePropsMixin.PosixUserProperty(
        group="group",
        user="user"
    ),
    run_as="runAs",
    windows=deadline.CfnQueuePropsMixin.WindowsUserProperty(
        password_arn="passwordArn",
        user="user"
    )
)

Attributes

posix

The user and group that the jobs in the queue run as.

See:

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

run_as

Specifies whether the job should run using the queue’s system user or if the job should run using the worker agent system user.

See:

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

windows

Identifies a Microsoft Windows user.

See:

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

PosixUserProperty

class CfnQueuePropsMixin.PosixUserProperty(*, group=None, user=None)

Bases: object

The POSIX user.

Parameters:

  • group (Optional[str]) – The name of the POSIX user’s group.

  • user (Optional[str]) – The name of the POSIX user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-posixuser.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.cfn_property_mixins import aws_deadline as deadline

posix_user_property = deadline.CfnQueuePropsMixin.PosixUserProperty(
    group="group",
    user="user"
)

Attributes

group

The name of the POSIX user’s group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-posixuser.html#cfn-deadline-queue-posixuser-group

user

The name of the POSIX user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-posixuser.html#cfn-deadline-queue-posixuser-user

PriorityBalancedSchedulingConfigurationProperty

class CfnQueuePropsMixin.PriorityBalancedSchedulingConfigurationProperty(*, rendering_task_buffer=None)

Bases: object

Parameters:

rendering_task_buffer (Union[int, float, None]) – Default: - 1

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-prioritybalancedschedulingconfiguration.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.cfn_property_mixins import aws_deadline as deadline

priority_balanced_scheduling_configuration_property = deadline.CfnQueuePropsMixin.PriorityBalancedSchedulingConfigurationProperty(
    rendering_task_buffer=123
)

Attributes

rendering_task_buffer

  • 1

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-prioritybalancedschedulingconfiguration.html#cfn-deadline-queue-prioritybalancedschedulingconfiguration-renderingtaskbuffer

Type:

default

SchedulingConfigurationProperty

class CfnQueuePropsMixin.SchedulingConfigurationProperty(*, priority_balanced=None, priority_fifo=None, weighted_balanced=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-schedulingconfiguration.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.cfn_property_mixins import aws_deadline as deadline

# always_schedule_first: Any
# always_schedule_last: Any
# priority_fifo: Any

scheduling_configuration_property = deadline.CfnQueuePropsMixin.SchedulingConfigurationProperty(
    priority_balanced=deadline.CfnQueuePropsMixin.PriorityBalancedSchedulingConfigurationProperty(
        rendering_task_buffer=123
    ),
    priority_fifo=priority_fifo,
    weighted_balanced=deadline.CfnQueuePropsMixin.WeightedBalancedSchedulingConfigurationProperty(
        error_weight=123,
        max_priority_override=deadline.CfnQueuePropsMixin.SchedulingMaxPriorityOverrideProperty(
            always_schedule_first=always_schedule_first
        ),
        min_priority_override=deadline.CfnQueuePropsMixin.SchedulingMinPriorityOverrideProperty(
            always_schedule_last=always_schedule_last
        ),
        priority_weight=123,
        rendering_task_buffer=123,
        rendering_task_weight=123,
        submission_time_weight=123
    )
)

Attributes

priority_balanced

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-schedulingconfiguration.html#cfn-deadline-queue-schedulingconfiguration-prioritybalanced

Type:

see

priority_fifo

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-schedulingconfiguration.html#cfn-deadline-queue-schedulingconfiguration-priorityfifo

Type:

see

weighted_balanced

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-schedulingconfiguration.html#cfn-deadline-queue-schedulingconfiguration-weightedbalanced

Type:

see

SchedulingMaxPriorityOverrideProperty

class CfnQueuePropsMixin.SchedulingMaxPriorityOverrideProperty(*, always_schedule_first=None)

Bases: object

Parameters:

always_schedule_first (Any)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-schedulingmaxpriorityoverride.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.cfn_property_mixins import aws_deadline as deadline

# always_schedule_first: Any

scheduling_max_priority_override_property = deadline.CfnQueuePropsMixin.SchedulingMaxPriorityOverrideProperty(
    always_schedule_first=always_schedule_first
)

Attributes

always_schedule_first

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-schedulingmaxpriorityoverride.html#cfn-deadline-queue-schedulingmaxpriorityoverride-alwaysschedulefirst

Type:

see

SchedulingMinPriorityOverrideProperty

class CfnQueuePropsMixin.SchedulingMinPriorityOverrideProperty(*, always_schedule_last=None)

Bases: object

Parameters:

always_schedule_last (Any)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-schedulingminpriorityoverride.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.cfn_property_mixins import aws_deadline as deadline

# always_schedule_last: Any

scheduling_min_priority_override_property = deadline.CfnQueuePropsMixin.SchedulingMinPriorityOverrideProperty(
    always_schedule_last=always_schedule_last
)

Attributes

always_schedule_last

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-schedulingminpriorityoverride.html#cfn-deadline-queue-schedulingminpriorityoverride-alwaysschedulelast

Type:

see

WeightedBalancedSchedulingConfigurationProperty

class CfnQueuePropsMixin.WeightedBalancedSchedulingConfigurationProperty(*, error_weight=None, max_priority_override=None, min_priority_override=None, priority_weight=None, rendering_task_buffer=None, rendering_task_weight=None, submission_time_weight=None)

Bases: object

Parameters:

  • error_weight (Union[int, float, None]) – Default: - -10

  • max_priority_override (Union[IResolvable, SchedulingMaxPriorityOverrideProperty, Dict[str, Any], None])

  • min_priority_override (Union[IResolvable, SchedulingMinPriorityOverrideProperty, Dict[str, Any], None])

  • priority_weight (Union[int, float, None]) – Default: - 100

  • rendering_task_buffer (Union[int, float, None]) – Default: - 1

  • rendering_task_weight (Union[int, float, None]) – Default: - -100

  • submission_time_weight (Union[int, float, None]) – Default: - 3

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-weightedbalancedschedulingconfiguration.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.cfn_property_mixins import aws_deadline as deadline

# always_schedule_first: Any
# always_schedule_last: Any

weighted_balanced_scheduling_configuration_property = deadline.CfnQueuePropsMixin.WeightedBalancedSchedulingConfigurationProperty(
    error_weight=123,
    max_priority_override=deadline.CfnQueuePropsMixin.SchedulingMaxPriorityOverrideProperty(
        always_schedule_first=always_schedule_first
    ),
    min_priority_override=deadline.CfnQueuePropsMixin.SchedulingMinPriorityOverrideProperty(
        always_schedule_last=always_schedule_last
    ),
    priority_weight=123,
    rendering_task_buffer=123,
    rendering_task_weight=123,
    submission_time_weight=123
)

Attributes

error_weight

  • -10

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-weightedbalancedschedulingconfiguration.html#cfn-deadline-queue-weightedbalancedschedulingconfiguration-errorweight

Type:

default

max_priority_override

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-weightedbalancedschedulingconfiguration.html#cfn-deadline-queue-weightedbalancedschedulingconfiguration-maxpriorityoverride

Type:

see

min_priority_override

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-weightedbalancedschedulingconfiguration.html#cfn-deadline-queue-weightedbalancedschedulingconfiguration-minpriorityoverride

Type:

see

priority_weight

  • 100

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-weightedbalancedschedulingconfiguration.html#cfn-deadline-queue-weightedbalancedschedulingconfiguration-priorityweight

Type:

default

rendering_task_buffer

  • 1

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-weightedbalancedschedulingconfiguration.html#cfn-deadline-queue-weightedbalancedschedulingconfiguration-renderingtaskbuffer

Type:

default

rendering_task_weight

  • -100

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-weightedbalancedschedulingconfiguration.html#cfn-deadline-queue-weightedbalancedschedulingconfiguration-renderingtaskweight

Type:

default

submission_time_weight

  • 3

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-weightedbalancedschedulingconfiguration.html#cfn-deadline-queue-weightedbalancedschedulingconfiguration-submissiontimeweight

Type:

default

WindowsUserProperty

class CfnQueuePropsMixin.WindowsUserProperty(*, password_arn=None, user=None)

Bases: object

The Windows user details.

Parameters:

  • password_arn (Optional[str]) – The password ARN for the Windows user.

  • user (Optional[str]) – The user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-windowsuser.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.cfn_property_mixins import aws_deadline as deadline

windows_user_property = deadline.CfnQueuePropsMixin.WindowsUserProperty(
    password_arn="passwordArn",
    user="user"
)

Attributes

password_arn

The password ARN for the Windows user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-windowsuser.html#cfn-deadline-queue-windowsuser-passwordarn

user

The user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-windowsuser.html#cfn-deadline-queue-windowsuser-user