Class CfnPreset
A CloudFormation AWS::MediaConvert::Preset.
Inherited Members
Namespace: Amazon.CDK.AWS.MediaConvert
Assembly: Amazon.CDK.AWS.MediaConvert.dll
Syntax (csharp)
public class CfnPreset : CfnResource, IConstruct, IDependable, IInspectableSyntax (vb)
Public Class CfnPreset
Inherits CfnResource
Implements IConstruct, IDependable, IInspectableRemarks
The AWS::MediaConvert::Preset resource is an AWS Elemental MediaConvert resource type that you can use to specify encoding settings for a single output in a transcoding job.
When you declare this entity in your AWS CloudFormation template, you pass in your transcoding job settings in JSON or YAML format. This settings specification must be formed in a particular way that conforms to AWS Elemental MediaConvert job validation. For more information about creating an output preset model for the SettingsJson property, see the Remarks section later in this topic.
For more information about output MediaConvert presets, see Working with AWS Elemental MediaConvert Output Presets in the ** .
CloudformationResource: AWS::MediaConvert::Preset
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconvert-preset.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 settingsJson;
var tags;
var cfnPreset = new CfnPreset(this, "MyCfnPreset", new CfnPresetProps {
SettingsJson = settingsJson,
// the properties below are optional
Category = "category",
Description = "description",
Name = "name",
Tags = tags
});Synopsis
Constructors
| CfnPreset(Construct, String, ICfnPresetProps) | Create a new |
| CfnPreset(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
| CfnPreset(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
| AttrArn | The Amazon Resource Name (ARN) of the output preset, such as |
| AttrName | The name of the output preset, such as |
| Category | The new category for the preset, if you are changing it. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | |
| Description | The new description for the preset, if you are changing it. |
| Name | The name of the preset that you are modifying. |
| SettingsJson | Specify, in JSON format, the transcoding job settings for this output preset. |
| 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
CfnPreset(Construct, String, ICfnPresetProps)
Create a new AWS::MediaConvert::Preset.
public CfnPreset(Construct scope, string id, ICfnPresetProps props)Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnPresetProps
- resource properties.
CfnPreset(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnPreset(ByRefValue reference)Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnPreset(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnPreset(DeputyBase.DeputyProps props)Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the output preset, 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 output preset, such as HEVC high res .
public virtual string AttrName { get; }Property Value
System.String
Remarks
CloudformationAttribute: Name
Category
The new category for the preset, if you are changing it.
public virtual string Category { get; set; }Property Value
System.String
Remarks
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
The new description for the preset, if you are changing it.
public virtual string Description { get; set; }Property Value
System.String
Remarks
Name
The name of the preset that you are modifying.
public virtual string Name { get; set; }Property Value
System.String
Remarks
SettingsJson
Specify, in JSON format, the transcoding job settings for this output preset.
public virtual object SettingsJson { get; set; }Property Value
System.Object
Remarks
This specification must conform to the AWS Elemental MediaConvert job validation. For information about forming this specification, see the Remarks section later in this topic.
For more information about MediaConvert output presets, see Working with AWS Elemental MediaConvert Output Presets in the ** .
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>