Class CfnQueueProps

Properties for defining a CfnQueue.

Inheritance

object

CfnQueueProps

Implements

ICfnQueueProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Deadline

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnQueueProps : ICfnQueueProps

Syntax (vb)

Public Class CfnQueueProps Implements ICfnQueueProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Deadline;

             var cfnQueueProps = new CfnQueueProps {
                 DisplayName = "displayName",
                 FarmId = "farmId",

                 // the properties below are optional
                 AllowedStorageProfileIds = new [] { "allowedStorageProfileIds" },
                 DefaultBudgetAction = "defaultBudgetAction",
                 Description = "description",
                 JobAttachmentSettings = new JobAttachmentSettingsProperty {
                     RootPrefix = "rootPrefix",
                     S3BucketName = "s3BucketName"
                 },
                 JobRunAsUser = new JobRunAsUserProperty {
                     RunAs = "runAs",

                     // the properties below are optional
                     Posix = new PosixUserProperty {
                         Group = "group",
                         User = "user"
                     },
                     Windows = new WindowsUserProperty {
                         PasswordArn = "passwordArn",
                         User = "user"
                     }
                 },
                 RequiredFileSystemLocationNames = new [] { "requiredFileSystemLocationNames" },
                 RoleArn = "roleArn",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnQueueProps()

Properties for defining a CfnQueue.

Properties

AllowedStorageProfileIds	The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
DefaultBudgetAction	The default action taken on a queue summary if a budget wasn't configured.
Description	A description of the queue that helps identify what the queue is used for.
DisplayName	The display name of the queue summary to update.
FarmId	The farm ID.
JobAttachmentSettings	The job attachment settings.
JobRunAsUser	Identifies the user for a job.
RequiredFileSystemLocationNames	The file system location that the queue uses.
RoleArn	The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.
Tags	The tags to add to your queue.

Constructors

CfnQueueProps()

Properties for defining a CfnQueue.

public CfnQueueProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Deadline;

             var cfnQueueProps = new CfnQueueProps {
                 DisplayName = "displayName",
                 FarmId = "farmId",

                 // the properties below are optional
                 AllowedStorageProfileIds = new [] { "allowedStorageProfileIds" },
                 DefaultBudgetAction = "defaultBudgetAction",
                 Description = "description",
                 JobAttachmentSettings = new JobAttachmentSettingsProperty {
                     RootPrefix = "rootPrefix",
                     S3BucketName = "s3BucketName"
                 },
                 JobRunAsUser = new JobRunAsUserProperty {
                     RunAs = "runAs",

                     // the properties below are optional
                     Posix = new PosixUserProperty {
                         Group = "group",
                         User = "user"
                     },
                     Windows = new WindowsUserProperty {
                         PasswordArn = "passwordArn",
                         User = "user"
                     }
                 },
                 RequiredFileSystemLocationNames = new [] { "requiredFileSystemLocationNames" },
                 RoleArn = "roleArn",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

AllowedStorageProfileIds

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

public string[]? AllowedStorageProfileIds { get; set; }

Property Value

string[]

Remarks

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

DefaultBudgetAction

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

public string? DefaultBudgetAction { get; set; }

Property Value

string

Remarks

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.

public string? Description { get; set; }

Property Value

string

Remarks

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

DisplayName

The display name of the queue summary to update.

public string DisplayName { get; set; }

Property Value

string

Remarks

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

FarmId

The farm ID.

public string FarmId { get; set; }

Property Value

string

Remarks

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

JobAttachmentSettings

The job attachment settings.

public object? JobAttachmentSettings { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnQueue.IJobAttachmentSettingsProperty

JobRunAsUser

Identifies the user for a job.

public object? JobRunAsUser { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnQueue.IJobRunAsUserProperty

RequiredFileSystemLocationNames

The file system location that the queue uses.

public string[]? RequiredFileSystemLocationNames { get; set; }

Property Value

string[]

Remarks

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

RoleArn

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

public string? RoleArn { get; set; }