software.amazon.awscdk.services.mediaconvert

Class CfnQueue

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.mediaconvert.CfnQueue

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.780Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnQueue.Builder A fluent builder for CfnQueue.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnQueue(software.constructs.Construct scope, String id) Create a new `AWS::MediaConvert::Queue`.
	CfnQueue(software.constructs.Construct scope, String id, CfnQueueProps props) Create a new `AWS::MediaConvert::Queue`.
protected	CfnQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnQueue(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the queue, such as `arn:aws:mediaconvert:us-west-2:123456789012` .
String	getAttrName() The name of the queue, such as `Queue 2` .
protected Map<String,Object>	getCfnProperties()
String	getDescription() Optional.
String	getName() The name of the queue that you are creating.
String	getPricingPlan() When you use AWS CloudFormation , you can create only on-demand queues.
String	getStatus() Initial state of the queue.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) Optional.
void	setName(String value) The name of the queue that you are creating.
void	setPricingPlan(String value) When you use AWS CloudFormation , you can create only on-demand queues.
void	setStatus(String value) Initial state of the queue.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnQueue

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

CfnQueue

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

CfnQueue

@Stability(value=Stable)
public CfnQueue(@NotNull
                                         software.constructs.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(value=Stable)
public CfnQueue(@NotNull
                                         software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the queue, such as `arn:aws:mediaconvert:us-west-2:123456789012` .

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

The name of the queue, such as `Queue 2` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

Optional.

A description of the queue that you are creating.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

Optional.

A description of the queue that you are creating.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the queue that you are creating.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the queue that you are creating.

getPricingPlan

@Stability(value=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(value=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(value=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(value=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.