Class CfnQueue
Creates a queue to coordinate the order in which jobs run on a farm.
Implements
Inherited Members
Namespace: Amazon.CDK.AwsDeadline
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnQueue : CfnResource, IInspectable
Syntax (vb)
Public Class CfnQueue
Inherits CfnResource
Implements IInspectable
Remarks
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
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 cfnQueue = new CfnQueue(this, "MyCfnQueue", new CfnQueueProps {
DisplayName = "displayName",
// the properties below are optional
AllowedStorageProfileIds = new [] { "allowedStorageProfileIds" },
DefaultBudgetAction = "defaultBudgetAction",
Description = "description",
FarmId = "farmId",
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"
});
Synopsis
Constructors
CfnQueue(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnQueue(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnQueue(Construct, String, ICfnQueueProps) |
Properties
AllowedStorageProfileIds | The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems. |
AttrArn | The Amazon Resource Name (ARN) of the queue. |
AttrQueueId | The queue ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnQueue(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnQueue(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnQueue(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnQueue(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnQueue(Construct, String, ICfnQueueProps)
public CfnQueue(Construct scope, string id, ICfnQueueProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnQueueProps
Resource properties.
Properties
AllowedStorageProfileIds
The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
public virtual string[] AllowedStorageProfileIds { get; set; }
Property Value
System.String[]
AttrArn
The Amazon Resource Name (ARN) of the queue.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrQueueId
The queue ID.
public virtual string AttrQueueId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: QueueId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DefaultBudgetAction
The default action taken on a queue summary if a budget wasn't configured.
public virtual string DefaultBudgetAction { get; set; }
Property Value
System.String
Description
A description of the queue that helps identify what the queue is used for.
public virtual string Description { get; set; }
Property Value
System.String
DisplayName
The display name of the queue summary to update.
public virtual string DisplayName { get; set; }
Property Value
System.String
FarmId
The farm ID.
public virtual string FarmId { get; set; }
Property Value
System.String
JobAttachmentSettings
The job attachment settings.
public virtual object JobAttachmentSettings { get; set; }
Property Value
System.Object
JobRunAsUser
Identifies the user for a job.
public virtual object JobRunAsUser { get; set; }
Property Value
System.Object
RequiredFileSystemLocationNames
The file system location that the queue uses.
public virtual string[] RequiredFileSystemLocationNames { get; set; }
Property Value
System.String[]
RoleArn
The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.
public virtual string RoleArn { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>