Amazonka.MediaConvert.Types.AutomatedAbrRule

Documentation

data AutomatedAbrRule

Specify one or more Automated ABR rule types. Note: Force include and Allowed renditions are mutually exclusive.

See: newAutomatedAbrRule smart constructor.

Constructors

AutomatedAbrRule'

Fields

• allowedRenditions :: Maybe [AllowedRenditionSize]

  When customer adds the allowed renditions rule for auto ABR ladder, they are required to add at leat one rendition to allowedRenditions list

• forceIncludeRenditions :: Maybe [ForceIncludeRenditionSize]

  When customer adds the force include renditions rule for auto ABR ladder, they are required to add at leat one rendition to forceIncludeRenditions list

• minBottomRenditionSize :: Maybe MinBottomRenditionSize

  Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size.

• minTopRenditionSize :: Maybe MinTopRenditionSize

  Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution.

• type' :: Maybe RuleType

  Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution. Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size. Use Force include renditions to specify one or more resolutions to include your ABR stack. * (Recommended) To optimize automated ABR, specify as few resolutions as possible. * (Required) The number of resolutions that you specify must be equal to, or less than, the Max renditions setting. * If you specify a Min top rendition size rule, specify at least one resolution that is equal to, or greater than, Min top rendition size. * If you specify a Min bottom rendition size rule, only specify resolutions that are equal to, or greater than, Min bottom rendition size. * If you specify a Force include renditions rule, do not specify a separate rule for Allowed renditions. * Note: The ABR stack may include other resolutions that you do not specify here, depending on the Max renditions setting. Use Allowed renditions to specify a list of possible resolutions in your ABR stack. * (Required) The number of resolutions that you specify must be equal to, or greater than, the Max renditions setting. * MediaConvert will create an ABR stack exclusively from the list of resolutions that you specify. * Some resolutions in the Allowed renditions list may not be included, however you can force a resolution to be included by setting Required to ENABLED. * You must specify at least one resolution that is greater than or equal to any resolutions that you specify in Min top rendition size or Min bottom rendition size. * If you specify Allowed renditions, you must not specify a separate rule for Force include renditions.

Instances

FromJSON AutomatedAbrRule

Defined in Amazonka.MediaConvert.Types.AutomatedAbrRule

Methods

parseJSON :: Value -> Parser AutomatedAbrRule

parseJSONList :: Value -> Parser [AutomatedAbrRule]

ToJSON AutomatedAbrRule

Defined in Amazonka.MediaConvert.Types.AutomatedAbrRule

Methods

toJSON :: AutomatedAbrRule -> Value

toEncoding :: AutomatedAbrRule -> Encoding

toJSONList :: [AutomatedAbrRule] -> Value

toEncodingList :: [AutomatedAbrRule] -> Encoding

Generic AutomatedAbrRule

Defined in Amazonka.MediaConvert.Types.AutomatedAbrRule

Associated Types

type Rep AutomatedAbrRule :: Type -> Type

Methods

from :: AutomatedAbrRule -> Rep AutomatedAbrRule x

to :: Rep AutomatedAbrRule x -> AutomatedAbrRule

Read AutomatedAbrRule

Defined in Amazonka.MediaConvert.Types.AutomatedAbrRule

Methods

readsPrec :: Int -> ReadS AutomatedAbrRule

readList :: ReadS [AutomatedAbrRule]

readPrec :: ReadPrec AutomatedAbrRule

readListPrec :: ReadPrec [AutomatedAbrRule]

Show AutomatedAbrRule

Defined in Amazonka.MediaConvert.Types.AutomatedAbrRule

Methods

showsPrec :: Int -> AutomatedAbrRule -> ShowS

show :: AutomatedAbrRule -> String

showList :: [AutomatedAbrRule] -> ShowS

NFData AutomatedAbrRule

Defined in Amazonka.MediaConvert.Types.AutomatedAbrRule

Methods

rnf :: AutomatedAbrRule -> ()

Eq AutomatedAbrRule

Defined in Amazonka.MediaConvert.Types.AutomatedAbrRule

Methods

(==) :: AutomatedAbrRule -> AutomatedAbrRule -> Bool

(/=) :: AutomatedAbrRule -> AutomatedAbrRule -> Bool

Hashable AutomatedAbrRule

Defined in Amazonka.MediaConvert.Types.AutomatedAbrRule

Methods

hashWithSalt :: Int -> AutomatedAbrRule -> Int

hash :: AutomatedAbrRule -> Int

type Rep AutomatedAbrRule

Defined in Amazonka.MediaConvert.Types.AutomatedAbrRule

type Rep AutomatedAbrRule = D1 ('MetaData "AutomatedAbrRule" "Amazonka.MediaConvert.Types.AutomatedAbrRule" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "AutomatedAbrRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowedRenditions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AllowedRenditionSize])) :*: S1 ('MetaSel ('Just "forceIncludeRenditions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ForceIncludeRenditionSize]))) :*: (S1 ('MetaSel ('Just "minBottomRenditionSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MinBottomRenditionSize)) :*: (S1 ('MetaSel ('Just "minTopRenditionSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MinTopRenditionSize)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleType))))))

newAutomatedAbrRule :: AutomatedAbrRule

Create a value of AutomatedAbrRule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allowedRenditions:AutomatedAbrRule', automatedAbrRule_allowedRenditions - When customer adds the allowed renditions rule for auto ABR ladder, they are required to add at leat one rendition to allowedRenditions list

$sel:forceIncludeRenditions:AutomatedAbrRule', automatedAbrRule_forceIncludeRenditions - When customer adds the force include renditions rule for auto ABR ladder, they are required to add at leat one rendition to forceIncludeRenditions list

$sel:minBottomRenditionSize:AutomatedAbrRule', automatedAbrRule_minBottomRenditionSize - Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size.

$sel:minTopRenditionSize:AutomatedAbrRule', automatedAbrRule_minTopRenditionSize - Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution.

$sel:type':AutomatedAbrRule', automatedAbrRule_type - Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution. Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size. Use Force include renditions to specify one or more resolutions to include your ABR stack. * (Recommended) To optimize automated ABR, specify as few resolutions as possible. * (Required) The number of resolutions that you specify must be equal to, or less than, the Max renditions setting. * If you specify a Min top rendition size rule, specify at least one resolution that is equal to, or greater than, Min top rendition size. * If you specify a Min bottom rendition size rule, only specify resolutions that are equal to, or greater than, Min bottom rendition size. * If you specify a Force include renditions rule, do not specify a separate rule for Allowed renditions. * Note: The ABR stack may include other resolutions that you do not specify here, depending on the Max renditions setting. Use Allowed renditions to specify a list of possible resolutions in your ABR stack. * (Required) The number of resolutions that you specify must be equal to, or greater than, the Max renditions setting. * MediaConvert will create an ABR stack exclusively from the list of resolutions that you specify. * Some resolutions in the Allowed renditions list may not be included, however you can force a resolution to be included by setting Required to ENABLED. * You must specify at least one resolution that is greater than or equal to any resolutions that you specify in Min top rendition size or Min bottom rendition size. * If you specify Allowed renditions, you must not specify a separate rule for Force include renditions.

automatedAbrRule_allowedRenditions :: Lens' AutomatedAbrRule (Maybe [AllowedRenditionSize])

When customer adds the allowed renditions rule for auto ABR ladder, they are required to add at leat one rendition to allowedRenditions list

automatedAbrRule_forceIncludeRenditions :: Lens' AutomatedAbrRule (Maybe [ForceIncludeRenditionSize])

When customer adds the force include renditions rule for auto ABR ladder, they are required to add at leat one rendition to forceIncludeRenditions list

automatedAbrRule_minBottomRenditionSize :: Lens' AutomatedAbrRule (Maybe MinBottomRenditionSize)

Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size.

automatedAbrRule_minTopRenditionSize :: Lens' AutomatedAbrRule (Maybe MinTopRenditionSize)

Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution.

automatedAbrRule_type :: Lens' AutomatedAbrRule (Maybe RuleType)

Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution. Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size. Use Force include renditions to specify one or more resolutions to include your ABR stack. * (Recommended) To optimize automated ABR, specify as few resolutions as possible. * (Required) The number of resolutions that you specify must be equal to, or less than, the Max renditions setting. * If you specify a Min top rendition size rule, specify at least one resolution that is equal to, or greater than, Min top rendition size. * If you specify a Min bottom rendition size rule, only specify resolutions that are equal to, or greater than, Min bottom rendition size. * If you specify a Force include renditions rule, do not specify a separate rule for Allowed renditions. * Note: The ABR stack may include other resolutions that you do not specify here, depending on the Max renditions setting. Use Allowed renditions to specify a list of possible resolutions in your ABR stack. * (Required) The number of resolutions that you specify must be equal to, or greater than, the Max renditions setting. * MediaConvert will create an ABR stack exclusively from the list of resolutions that you specify. * Some resolutions in the Allowed renditions list may not be included, however you can force a resolution to be included by setting Required to ENABLED. * You must specify at least one resolution that is greater than or equal to any resolutions that you specify in Min top rendition size or Min bottom rendition size. * If you specify Allowed renditions, you must not specify a separate rule for Force include renditions.