CfnQueueProps Struct
Properties for defining a CfnQueue.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_deadline as deadline } from 'aws-cdk-lib';
declare const alwaysScheduleFirst: any;
declare const alwaysScheduleLast: any;
declare const priorityFifo: any;
const cfnQueueProps: deadline.CfnQueueProps = {
displayName: 'displayName',
farmId: 'farmId',
// the properties below are optional
allowedStorageProfileIds: ['allowedStorageProfileIds'],
defaultBudgetAction: 'defaultBudgetAction',
description: 'description',
jobAttachmentSettings: {
rootPrefix: 'rootPrefix',
s3BucketName: 's3BucketName',
},
jobRunAsUser: {
runAs: 'runAs',
// the properties below are optional
posix: {
group: 'group',
user: 'user',
},
windows: {
passwordArn: 'passwordArn',
user: 'user',
},
},
requiredFileSystemLocationNames: ['requiredFileSystemLocationNames'],
roleArn: 'roleArn',
schedulingConfiguration: {
priorityBalanced: {
renderingTaskBuffer: 123,
},
priorityFifo: priorityFifo,
weightedBalanced: {
errorWeight: 123,
maxPriorityOverride: {
alwaysScheduleFirst: alwaysScheduleFirst,
},
minPriorityOverride: {
alwaysScheduleLast: alwaysScheduleLast,
},
priorityWeight: 123,
renderingTaskBuffer: 123,
renderingTaskWeight: 123,
submissionTimeWeight: 123,
},
},
tags: [{
key: 'key',
value: 'value',
}],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline
# always_schedule_first: Any
# always_schedule_last: Any
# priority_fifo: Any
cfn_queue_props = deadline.CfnQueueProps(
display_name="displayName",
farm_id="farmId",
# the properties below are optional
allowed_storage_profile_ids=["allowedStorageProfileIds"],
default_budget_action="defaultBudgetAction",
description="description",
job_attachment_settings=deadline.CfnQueue.JobAttachmentSettingsProperty(
root_prefix="rootPrefix",
s3_bucket_name="s3BucketName"
),
job_run_as_user=deadline.CfnQueue.JobRunAsUserProperty(
run_as="runAs",
# the properties below are optional
posix=deadline.CfnQueue.PosixUserProperty(
group="group",
user="user"
),
windows=deadline.CfnQueue.WindowsUserProperty(
password_arn="passwordArn",
user="user"
)
),
required_file_system_location_names=["requiredFileSystemLocationNames"],
role_arn="roleArn",
scheduling_configuration=deadline.CfnQueue.SchedulingConfigurationProperty(
priority_balanced=deadline.CfnQueue.PriorityBalancedSchedulingConfigurationProperty(
rendering_task_buffer=123
),
priority_fifo=priority_fifo,
weighted_balanced=deadline.CfnQueue.WeightedBalancedSchedulingConfigurationProperty(
error_weight=123,
max_priority_override=deadline.CfnQueue.SchedulingMaxPriorityOverrideProperty(
always_schedule_first=always_schedule_first
),
min_priority_override=deadline.CfnQueue.SchedulingMinPriorityOverrideProperty(
always_schedule_last=always_schedule_last
),
priority_weight=123,
rendering_task_buffer=123,
rendering_task_weight=123,
submission_time_weight=123
)
),
tags=[CfnTag(
key="key",
value="value"
)]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.deadline.*;
Object alwaysScheduleFirst;
Object alwaysScheduleLast;
Object priorityFifo;
CfnQueueProps cfnQueueProps = CfnQueueProps.builder()
.displayName("displayName")
.farmId("farmId")
// the properties below are optional
.allowedStorageProfileIds(List.of("allowedStorageProfileIds"))
.defaultBudgetAction("defaultBudgetAction")
.description("description")
.jobAttachmentSettings(JobAttachmentSettingsProperty.builder()
.rootPrefix("rootPrefix")
.s3BucketName("s3BucketName")
.build())
.jobRunAsUser(JobRunAsUserProperty.builder()
.runAs("runAs")
// the properties below are optional
.posix(PosixUserProperty.builder()
.group("group")
.user("user")
.build())
.windows(WindowsUserProperty.builder()
.passwordArn("passwordArn")
.user("user")
.build())
.build())
.requiredFileSystemLocationNames(List.of("requiredFileSystemLocationNames"))
.roleArn("roleArn")
.schedulingConfiguration(SchedulingConfigurationProperty.builder()
.priorityBalanced(PriorityBalancedSchedulingConfigurationProperty.builder()
.renderingTaskBuffer(123)
.build())
.priorityFifo(priorityFifo)
.weightedBalanced(WeightedBalancedSchedulingConfigurationProperty.builder()
.errorWeight(123)
.maxPriorityOverride(SchedulingMaxPriorityOverrideProperty.builder()
.alwaysScheduleFirst(alwaysScheduleFirst)
.build())
.minPriorityOverride(SchedulingMinPriorityOverrideProperty.builder()
.alwaysScheduleLast(alwaysScheduleLast)
.build())
.priorityWeight(123)
.renderingTaskBuffer(123)
.renderingTaskWeight(123)
.submissionTimeWeight(123)
.build())
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 alwaysScheduleFirst;
var alwaysScheduleLast;
var priorityFifo;
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",
SchedulingConfiguration = new SchedulingConfigurationProperty {
PriorityBalanced = new PriorityBalancedSchedulingConfigurationProperty {
RenderingTaskBuffer = 123
},
PriorityFifo = priorityFifo,
WeightedBalanced = new WeightedBalancedSchedulingConfigurationProperty {
ErrorWeight = 123,
MaxPriorityOverride = new SchedulingMaxPriorityOverrideProperty {
AlwaysScheduleFirst = alwaysScheduleFirst
},
MinPriorityOverride = new SchedulingMinPriorityOverrideProperty {
AlwaysScheduleLast = alwaysScheduleLast
},
PriorityWeight = 123,
RenderingTaskBuffer = 123,
RenderingTaskWeight = 123,
SubmissionTimeWeight = 123
}
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var alwaysScheduleFirst interface{}
var alwaysScheduleLast interface{}
var priorityFifo interface{}
cfnQueueProps := &CfnQueueProps{
DisplayName: jsii.String("displayName"),
FarmId: jsii.String("farmId"),
// the properties below are optional
AllowedStorageProfileIds: []*string{
jsii.String("allowedStorageProfileIds"),
},
DefaultBudgetAction: jsii.String("defaultBudgetAction"),
Description: jsii.String("description"),
JobAttachmentSettings: &JobAttachmentSettingsProperty{
RootPrefix: jsii.String("rootPrefix"),
S3BucketName: jsii.String("s3BucketName"),
},
JobRunAsUser: &JobRunAsUserProperty{
RunAs: jsii.String("runAs"),
// the properties below are optional
Posix: &PosixUserProperty{
Group: jsii.String("group"),
User: jsii.String("user"),
},
Windows: &WindowsUserProperty{
PasswordArn: jsii.String("passwordArn"),
User: jsii.String("user"),
},
},
RequiredFileSystemLocationNames: []*string{
jsii.String("requiredFileSystemLocationNames"),
},
RoleArn: jsii.String("roleArn"),
SchedulingConfiguration: &SchedulingConfigurationProperty{
PriorityBalanced: &PriorityBalancedSchedulingConfigurationProperty{
RenderingTaskBuffer: jsii.Number(123),
},
PriorityFifo: priorityFifo,
WeightedBalanced: &WeightedBalancedSchedulingConfigurationProperty{
ErrorWeight: jsii.Number(123),
MaxPriorityOverride: &SchedulingMaxPriorityOverrideProperty{
AlwaysScheduleFirst: alwaysScheduleFirst,
},
MinPriorityOverride: &SchedulingMinPriorityOverrideProperty{
AlwaysScheduleLast: alwaysScheduleLast,
},
PriorityWeight: jsii.Number(123),
RenderingTaskBuffer: jsii.Number(123),
RenderingTaskWeight: jsii.Number(123),
SubmissionTimeWeight: jsii.Number(123),
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Properties
allowedStorageProfileIdsoptionalstring[]allowed_storage_profile_idsoptionaltyping.List[str]allowedStorageProfileIdsoptionalList<String>AllowedStorageProfileIdsoptionalstring[]AllowedStorageProfileIdsoptional*[]*string#The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.
defaultBudgetActionoptionalstringdefault_budget_actionoptionalstrdefaultBudgetActionoptionalStringDefaultBudgetActionoptionalstringDefaultBudgetActionoptional*string= "NONE"#The default action taken on a queue summary if a budget wasn't configured.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= ""#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.
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.
The farm ID.
jobAttachmentSettingsoptionalIResolvable | CfnQueue.JobAttachmentSettingsPropertyjob_attachment_settingsoptionaltyping.Union[IResolvable, JobAttachmentSettingsProperty]jobAttachmentSettingsoptionalIResolvableJobAttachmentSettingsoptionalIResolvableJobAttachmentSettingsoptionalinterface{}#The job attachment settings.
These are the Amazon S3 bucket name and the Amazon S3 prefix.
jobRunAsUseroptionalIResolvable | CfnQueue.JobRunAsUserPropertyjob_run_as_useroptionaltyping.Union[IResolvable, JobRunAsUserProperty]jobRunAsUseroptionalIResolvableJobRunAsUseroptionalIResolvableJobRunAsUseroptionalinterface{}#Identifies the user for a job.
requiredFileSystemLocationNamesoptionalstring[]required_file_system_location_namesoptionaltyping.List[str]requiredFileSystemLocationNamesoptionalList<String>RequiredFileSystemLocationNamesoptionalstring[]RequiredFileSystemLocationNamesoptional*[]*string#The file system location that the queue uses.
roleArnoptionalstringrole_arnoptionalstrroleArnoptionalStringRoleArnoptionalstringRoleArnoptional*string#The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.
schedulingConfigurationoptionalIResolvable | CfnQueue.SchedulingConfigurationPropertyscheduling_configurationoptionaltyping.Union[IResolvable, SchedulingConfigurationProperty]schedulingConfigurationoptionalIResolvableSchedulingConfigurationoptionalIResolvableSchedulingConfigurationoptionalinterface{}#