Package software.amazon.awscdk.services.mediaconvert

Class CfnPreset

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.CfnPreset
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.919Z") @Stability(Stable) public class CfnPreset extends CfnResource implements IInspectable
A CloudFormation AWS::MediaConvert::Preset.

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 ** .

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 settingsJson;
 Object tags;
 CfnPreset cfnPreset = CfnPreset.Builder.create(this, "MyCfnPreset")
         .settingsJson(settingsJson)
         // the properties below are optional
         .category("category")
         .description("description")
         .name("name")
         .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

    • CfnPreset

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

    • CfnPreset

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

    • CfnPreset

      @Stability(Stable) public CfnPreset(@NotNull Construct scope, @NotNull String id, @NotNull CfnPresetProps props)
      Create a new AWS::MediaConvert::Preset.

      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.
      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 output preset, such as arn:aws:mediaconvert:us-west-2:123456789012 .

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The name of the output preset, such as HEVC high res .

    • 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 .

    • getSettingsJson

      @Stability(Stable) @NotNull public Object getSettingsJson()
      Specify, in JSON format, the transcoding job settings for this output preset.

      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 ** .

    • setSettingsJson

      @Stability(Stable) public void setSettingsJson(@NotNull Object value)
      Specify, in JSON format, the transcoding job settings for this output preset.

      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 ** .

    • getCategory

      @Stability(Stable) @Nullable public String getCategory()
      The new category for the preset, if you are changing it.

    • setCategory

      @Stability(Stable) public void setCategory(@Nullable String value)
      The new category for the preset, if you are changing it.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The new description for the preset, if you are changing it.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The new description for the preset, if you are changing it.

    • getName

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

    • setName

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