Package software.amazon.awscdk.services.mediaconvert

Class CfnQueue

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.mediaconvert.CfnQueue
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.921Z") @Stability(Stable) public class CfnQueue extends CfnResource implements IInspectable
A CloudFormation AWS::MediaConvert::Queue.

The AWS::MediaConvert::Queue resource is an AWS Elemental MediaConvert resource type that you can use to manage the resources that are available to your account for parallel processing of jobs. For more information about queues, see Working with AWS Elemental MediaConvert Queues in the ** .

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;
 CfnQueue cfnQueue = CfnQueue.Builder.create(this, "MyCfnQueue")
         .description("description")
         .name("name")
         .pricingPlan("pricingPlan")
         .status("status")
         .tags(tags)
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnQueue

      protected CfnQueue(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnQueue

      protected CfnQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnQueue

      @Stability(Stable) public CfnQueue(@NotNull Construct scope, @NotNull String id, @Nullable CfnQueueProps props)
      Create a new AWS::MediaConvert::Queue.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnQueue

      @Stability(Stable) public CfnQueue(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::MediaConvert::Queue.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the queue, such as arn:aws:mediaconvert:us-west-2:123456789012 .

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The name of the queue, such as Queue 2 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      Optional.

      A description of the queue that you are creating.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      Optional.

      A description of the queue that you are creating.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the queue that you are creating.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the queue that you are creating.

    • getPricingPlan

      @Stability(Stable) @Nullable public 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 ** .

    • setPricingPlan

      @Stability(Stable) public void setPricingPlan(@Nullable String value)
      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 ** .

    • getStatus

      @Stability(Stable) @Nullable public 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.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      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.