Class CfnQueue
A CloudFormation AWS::MediaConvert::Queue
.
Inherited Members
Namespace: Amazon.CDK.AWS.MediaConvert
Assembly: Amazon.CDK.AWS.MediaConvert.dll
Syntax (csharp)
public class CfnQueue : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnQueue
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 ** .
CloudformationResource: AWS::MediaConvert::Queue
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-queue.html
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.MediaConvert;
var tags;
var cfnQueue = new CfnQueue(this, "MyCfnQueue", new CfnQueueProps {
Description = "description",
Name = "name",
PricingPlan = "pricingPlan",
Status = "status",
Tags = tags
});
Synopsis
Constructors
CfnQueue(Construct, String, ICfnQueueProps) | Create a new |
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 |
Properties
AttrArn | The Amazon Resource Name (ARN) of the queue, such as |
AttrName | The name of the queue, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | Optional. |
Name | The name of the queue that you are creating. |
PricingPlan | When you use AWS CloudFormation , you can create only on-demand queues. |
Status | Initial state of the queue. |
Tags | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnQueue(Construct, String, ICfnQueueProps)
Create a new AWS::MediaConvert::Queue
.
public CfnQueue(Construct scope, string id, ICfnQueueProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnQueueProps
- resource properties.
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
Properties
AttrArn
The Amazon Resource Name (ARN) of the queue, such as arn:aws:mediaconvert:us-west-2:123456789012
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrName
The name of the queue, such as Queue 2
.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
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
Description
Optional.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
A description of the queue that you are creating.
Name
The name of the queue that you are creating.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
PricingPlan
When you use AWS CloudFormation , you can create only on-demand queues.
public virtual string PricingPlan { get; set; }
Property Value
System.String
Remarks
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 ** .
Status
Initial state of the queue.
public virtual string Status { get; set; }
Property Value
System.String
Remarks
Queues can be either ACTIVE or PAUSED. If you create a paused queue, then jobs that you send to that queue won't begin.
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
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>