Interface CfnQueueProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQueueProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-05-15T23:29:06.641Z")
@Stability(Stable)
public interface CfnQueueProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnQueue.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediaconvert.*;
 Object tags;
 CfnQueueProps cfnQueueProps = CfnQueueProps.builder()
         .concurrentJobs(123)
         .description("description")
         .name("name")
         .pricingPlan("pricingPlan")
         .status("status")
         .tags(tags)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnQueueProps.Builder	A builder for CfnQueueProps
static final class	CfnQueueProps.Jsii$Proxy	An implementation for CfnQueueProps

Method Summary

Modifier and Type	Method	Description
static CfnQueueProps.Builder	builder()
default Number	getConcurrentJobs()	Specify the maximum number of jobs your queue can process concurrently.
default String	getDescription()	Optional.
default String	getName()	The name of the queue that you are creating.
default String	getPricingPlan()	When you use AWS CloudFormation , you can create only on-demand queues.
default String	getStatus()	Initial state of the queue.
default Object	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConcurrentJobs

@Stability(Stable)
@Nullable
default Number getConcurrentJobs()

Specify the maximum number of jobs your queue can process concurrently.

For on-demand queues, the value you enter is constrained by your service quotas for Maximum concurrent jobs, per on-demand queue and Maximum concurrent jobs, per account. For reserved queues, specify the number of jobs you can process concurrently in your reservation plan instead.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-concurrentjobs

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Optional.

A description of the queue that you are creating.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-description

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the queue that you are creating.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-name

getPricingPlan

@Stability(Stable)
@Nullable
default String getPricingPlan()

When you use AWS CloudFormation , you can create only on-demand queues.

Therefore, always set PricingPlan to the value "ON_DEMAND" when declaring an AWS::MediaConvert::Queue in your AWS CloudFormation template.

To create a reserved queue, use the AWS Elemental MediaConvert console at https://console.aws.amazon.com/mediaconvert to set up a contract. For more information, see Working with AWS Elemental MediaConvert Queues in the ** .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-pricingplan

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

Initial state of the queue.

Queues can be either ACTIVE or PAUSED. If you create a paused queue, then jobs that you send to that queue won't begin.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-status

getTags

@Stability(Stable)
@Nullable
default Object getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html#cfn-mediaconvert-queue-tags

builder

@Stability(Stable)
static CfnQueueProps.Builder builder()

Returns:

a CfnQueueProps.Builder of CfnQueueProps