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:

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:08:48.101Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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
	CfnPreset(Construct scope, String id, CfnPresetProps props) Create a new `AWS::MediaConvert::Preset`.
protected	CfnPreset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPreset(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the output preset, such as `arn:aws:mediaconvert:us-west-2:123456789012` .
String	getAttrName() The name of the output preset, such as `HEVC high res` .
String	getCategory() The new category for the preset, if you are changing it.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The new description for the preset, if you are changing it.
String	getName() The name of the preset that you are modifying.
Object	getSettingsJson() Specify, in JSON format, the transcoding job settings for this output preset.
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	setCategory(String value) The new category for the preset, if you are changing it.
void	setDescription(String value) The new description for the preset, if you are changing it.
void	setName(String value) The name of the preset that you are modifying.
void	setSettingsJson(Object value) Specify, in JSON format, the transcoding job settings for this output preset.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

CfnPreset

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

CfnPreset

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

CfnPreset

@Stability(value=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 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 output preset, such as `arn:aws:mediaconvert:us-west-2:123456789012` .

getAttrName

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

The name of the output preset, such as `HEVC high res` .

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 .

getSettingsJson

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

The new category for the preset, if you are changing it.

setCategory

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

The new category for the preset, if you are changing it.

getDescription

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

The new description for the preset, if you are changing it.

setDescription

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

The new description for the preset, if you are changing it.

getName

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

The name of the preset that you are modifying.

setName

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

The name of the preset that you are modifying.