1. Packages
  2. AWS
  3. API Docs
  4. mediaconvert
  5. Queue
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.mediaconvert.Queue

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Provides an AWS Elemental MediaConvert Queue.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = new aws.mediaconvert.Queue("test", {name: "tf-test-queue"});
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.mediaconvert.Queue("test", name="tf-test-queue")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/mediaconvert"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mediaconvert.NewQueue(ctx, "test", &mediaconvert.QueueArgs{
    			Name: pulumi.String("tf-test-queue"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Aws.MediaConvert.Queue("test", new()
        {
            Name = "tf-test-queue",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.mediaconvert.Queue;
    import com.pulumi.aws.mediaconvert.QueueArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test = new Queue("test", QueueArgs.builder()
                .name("tf-test-queue")
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:mediaconvert:Queue
        properties:
          name: tf-test-queue
    

    Create Queue Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Queue(name: string, args?: QueueArgs, opts?: CustomResourceOptions);
    @overload
    def Queue(resource_name: str,
              args: Optional[QueueArgs] = None,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Queue(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              pricing_plan: Optional[str] = None,
              reservation_plan_settings: Optional[QueueReservationPlanSettingsArgs] = None,
              status: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None)
    func NewQueue(ctx *Context, name string, args *QueueArgs, opts ...ResourceOption) (*Queue, error)
    public Queue(string name, QueueArgs? args = null, CustomResourceOptions? opts = null)
    public Queue(String name, QueueArgs args)
    public Queue(String name, QueueArgs args, CustomResourceOptions options)
    
    type: aws:mediaconvert:Queue
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var awsQueueResource = new Aws.MediaConvert.Queue("awsQueueResource", new()
    {
        Description = "string",
        Name = "string",
        PricingPlan = "string",
        ReservationPlanSettings = new Aws.MediaConvert.Inputs.QueueReservationPlanSettingsArgs
        {
            Commitment = "string",
            RenewalType = "string",
            ReservedSlots = 0,
        },
        Status = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := mediaconvert.NewQueue(ctx, "awsQueueResource", &mediaconvert.QueueArgs{
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	PricingPlan: pulumi.String("string"),
    	ReservationPlanSettings: &mediaconvert.QueueReservationPlanSettingsArgs{
    		Commitment:    pulumi.String("string"),
    		RenewalType:   pulumi.String("string"),
    		ReservedSlots: pulumi.Int(0),
    	},
    	Status: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var awsQueueResource = new Queue("awsQueueResource", QueueArgs.builder()
        .description("string")
        .name("string")
        .pricingPlan("string")
        .reservationPlanSettings(QueueReservationPlanSettingsArgs.builder()
            .commitment("string")
            .renewalType("string")
            .reservedSlots(0)
            .build())
        .status("string")
        .tags(Map.of("string", "string"))
        .build());
    
    aws_queue_resource = aws.mediaconvert.Queue("awsQueueResource",
        description="string",
        name="string",
        pricing_plan="string",
        reservation_plan_settings={
            "commitment": "string",
            "renewal_type": "string",
            "reserved_slots": 0,
        },
        status="string",
        tags={
            "string": "string",
        })
    
    const awsQueueResource = new aws.mediaconvert.Queue("awsQueueResource", {
        description: "string",
        name: "string",
        pricingPlan: "string",
        reservationPlanSettings: {
            commitment: "string",
            renewalType: "string",
            reservedSlots: 0,
        },
        status: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:mediaconvert:Queue
    properties:
        description: string
        name: string
        pricingPlan: string
        reservationPlanSettings:
            commitment: string
            renewalType: string
            reservedSlots: 0
        status: string
        tags:
            string: string
    

    Queue Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Queue resource accepts the following input properties:

    Description string
    A description of the queue
    Name string
    A unique identifier describing the queue
    PricingPlan string
    Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are ON_DEMAND or RESERVED. Default to ON_DEMAND.
    ReservationPlanSettings QueueReservationPlanSettings
    A detail pricing plan of the reserved queue. See below.
    Status string
    A status of the queue. Valid values are ACTIVE or RESERVED. Default to PAUSED.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Description string
    A description of the queue
    Name string
    A unique identifier describing the queue
    PricingPlan string
    Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are ON_DEMAND or RESERVED. Default to ON_DEMAND.
    ReservationPlanSettings QueueReservationPlanSettingsArgs
    A detail pricing plan of the reserved queue. See below.
    Status string
    A status of the queue. Valid values are ACTIVE or RESERVED. Default to PAUSED.
    Tags map[string]string
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description String
    A description of the queue
    name String
    A unique identifier describing the queue
    pricingPlan String
    Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are ON_DEMAND or RESERVED. Default to ON_DEMAND.
    reservationPlanSettings QueueReservationPlanSettings
    A detail pricing plan of the reserved queue. See below.
    status String
    A status of the queue. Valid values are ACTIVE or RESERVED. Default to PAUSED.
    tags Map<String,String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description string
    A description of the queue
    name string
    A unique identifier describing the queue
    pricingPlan string
    Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are ON_DEMAND or RESERVED. Default to ON_DEMAND.
    reservationPlanSettings QueueReservationPlanSettings
    A detail pricing plan of the reserved queue. See below.
    status string
    A status of the queue. Valid values are ACTIVE or RESERVED. Default to PAUSED.
    tags {[key: string]: string}
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description str
    A description of the queue
    name str
    A unique identifier describing the queue
    pricing_plan str
    Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are ON_DEMAND or RESERVED. Default to ON_DEMAND.
    reservation_plan_settings QueueReservationPlanSettingsArgs
    A detail pricing plan of the reserved queue. See below.
    status str
    A status of the queue. Valid values are ACTIVE or RESERVED. Default to PAUSED.
    tags Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description String
    A description of the queue
    name String
    A unique identifier describing the queue
    pricingPlan String
    Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are ON_DEMAND or RESERVED. Default to ON_DEMAND.
    reservationPlanSettings Property Map
    A detail pricing plan of the reserved queue. See below.
    status String
    A status of the queue. Valid values are ACTIVE or RESERVED. Default to PAUSED.
    tags Map<String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Queue resource produces the following output properties:

    Arn string
    The Arn of the queue
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Arn of the queue
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Arn of the queue
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Arn of the queue
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Arn of the queue
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Arn of the queue
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Queue Resource

    Get an existing Queue resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: QueueState, opts?: CustomResourceOptions): Queue
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            pricing_plan: Optional[str] = None,
            reservation_plan_settings: Optional[QueueReservationPlanSettingsArgs] = None,
            status: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Queue
    func GetQueue(ctx *Context, name string, id IDInput, state *QueueState, opts ...ResourceOption) (*Queue, error)
    public static Queue Get(string name, Input<string> id, QueueState? state, CustomResourceOptions? opts = null)
    public static Queue get(String name, Output<String> id, QueueState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Arn of the queue
    Description string
    A description of the queue
    Name string
    A unique identifier describing the queue
    PricingPlan string
    Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are ON_DEMAND or RESERVED. Default to ON_DEMAND.
    ReservationPlanSettings QueueReservationPlanSettings
    A detail pricing plan of the reserved queue. See below.
    Status string
    A status of the queue. Valid values are ACTIVE or RESERVED. Default to PAUSED.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Arn of the queue
    Description string
    A description of the queue
    Name string
    A unique identifier describing the queue
    PricingPlan string
    Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are ON_DEMAND or RESERVED. Default to ON_DEMAND.
    ReservationPlanSettings QueueReservationPlanSettingsArgs
    A detail pricing plan of the reserved queue. See below.
    Status string
    A status of the queue. Valid values are ACTIVE or RESERVED. Default to PAUSED.
    Tags map[string]string
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Arn of the queue
    description String
    A description of the queue
    name String
    A unique identifier describing the queue
    pricingPlan String
    Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are ON_DEMAND or RESERVED. Default to ON_DEMAND.
    reservationPlanSettings QueueReservationPlanSettings
    A detail pricing plan of the reserved queue. See below.
    status String
    A status of the queue. Valid values are ACTIVE or RESERVED. Default to PAUSED.
    tags Map<String,String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Arn of the queue
    description string
    A description of the queue
    name string
    A unique identifier describing the queue
    pricingPlan string
    Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are ON_DEMAND or RESERVED. Default to ON_DEMAND.
    reservationPlanSettings QueueReservationPlanSettings
    A detail pricing plan of the reserved queue. See below.
    status string
    A status of the queue. Valid values are ACTIVE or RESERVED. Default to PAUSED.
    tags {[key: string]: string}
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Arn of the queue
    description str
    A description of the queue
    name str
    A unique identifier describing the queue
    pricing_plan str
    Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are ON_DEMAND or RESERVED. Default to ON_DEMAND.
    reservation_plan_settings QueueReservationPlanSettingsArgs
    A detail pricing plan of the reserved queue. See below.
    status str
    A status of the queue. Valid values are ACTIVE or RESERVED. Default to PAUSED.
    tags Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Arn of the queue
    description String
    A description of the queue
    name String
    A unique identifier describing the queue
    pricingPlan String
    Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are ON_DEMAND or RESERVED. Default to ON_DEMAND.
    reservationPlanSettings Property Map
    A detail pricing plan of the reserved queue. See below.
    status String
    A status of the queue. Valid values are ACTIVE or RESERVED. Default to PAUSED.
    tags Map<String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    QueueReservationPlanSettings, QueueReservationPlanSettingsArgs

    Commitment string
    The length of the term of your reserved queue pricing plan commitment. Valid value is ONE_YEAR.
    RenewalType string
    Specifies whether the term of your reserved queue pricing plan. Valid values are AUTO_RENEW or EXPIRE.
    ReservedSlots int
    Specifies the number of reserved transcode slots (RTS) for queue.
    Commitment string
    The length of the term of your reserved queue pricing plan commitment. Valid value is ONE_YEAR.
    RenewalType string
    Specifies whether the term of your reserved queue pricing plan. Valid values are AUTO_RENEW or EXPIRE.
    ReservedSlots int
    Specifies the number of reserved transcode slots (RTS) for queue.
    commitment String
    The length of the term of your reserved queue pricing plan commitment. Valid value is ONE_YEAR.
    renewalType String
    Specifies whether the term of your reserved queue pricing plan. Valid values are AUTO_RENEW or EXPIRE.
    reservedSlots Integer
    Specifies the number of reserved transcode slots (RTS) for queue.
    commitment string
    The length of the term of your reserved queue pricing plan commitment. Valid value is ONE_YEAR.
    renewalType string
    Specifies whether the term of your reserved queue pricing plan. Valid values are AUTO_RENEW or EXPIRE.
    reservedSlots number
    Specifies the number of reserved transcode slots (RTS) for queue.
    commitment str
    The length of the term of your reserved queue pricing plan commitment. Valid value is ONE_YEAR.
    renewal_type str
    Specifies whether the term of your reserved queue pricing plan. Valid values are AUTO_RENEW or EXPIRE.
    reserved_slots int
    Specifies the number of reserved transcode slots (RTS) for queue.
    commitment String
    The length of the term of your reserved queue pricing plan commitment. Valid value is ONE_YEAR.
    renewalType String
    Specifies whether the term of your reserved queue pricing plan. Valid values are AUTO_RENEW or EXPIRE.
    reservedSlots Number
    Specifies the number of reserved transcode slots (RTS) for queue.

    Import

    Using pulumi import, import Media Convert Queue using the queue name. For example:

    $ pulumi import aws:mediaconvert/queue:Queue test tf-test-queue
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi