CfnQueuePropsMixin

class aws_cdk.mixins_preview.aws_deadline.mixins.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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_deadline import mixins as deadline_mixins

cfn_queue_props_mixin = deadline_mixins.CfnQueuePropsMixin(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"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnQueueMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

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', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

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.mixins_preview.aws_deadline import mixins as deadline_mixins

job_attachment_settings_property = deadline_mixins.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.mixins_preview.aws_deadline import mixins as deadline_mixins

job_run_as_user_property = 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"
    )
)

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.mixins_preview.aws_deadline import mixins as deadline_mixins

posix_user_property = deadline_mixins.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

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.mixins_preview.aws_deadline import mixins as deadline_mixins

windows_user_property = deadline_mixins.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