{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.ElasticTranscoder.Types.JobWatermark -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) module Amazonka.ElasticTranscoder.Types.JobWatermark where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.ElasticTranscoder.Types.Encryption import qualified Amazonka.Prelude as Prelude -- | Watermarks can be in .png or .jpg format. If you want to display a -- watermark that is not rectangular, use the .png format, which supports -- transparency. -- -- /See:/ 'newJobWatermark' smart constructor. data JobWatermark = JobWatermark' { -- | The encryption settings, if any, that you want Elastic Transcoder to -- apply to your watermarks. encryption :: Prelude.Maybe Encryption, -- | The name of the .png or .jpg file that you want to use for the -- watermark. To determine which Amazon S3 bucket contains the specified -- file, Elastic Transcoder checks the pipeline specified by @Pipeline@; -- the @Input Bucket@ object in that pipeline identifies the bucket. -- -- If the file name includes a prefix, for example, __logos\/128x64.png__, -- include the prefix in the key. If the file isn\'t in the specified -- bucket, Elastic Transcoder returns an error. inputKey :: Prelude.Maybe Prelude.Text, -- | The ID of the watermark settings that Elastic Transcoder uses to add -- watermarks to the video during transcoding. The settings are in the -- preset specified by Preset for the current output. In that preset, the -- value of Watermarks Id tells Elastic Transcoder which settings to use. presetWatermarkId :: Prelude.Maybe Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'JobWatermark' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'encryption', 'jobWatermark_encryption' - The encryption settings, if any, that you want Elastic Transcoder to -- apply to your watermarks. -- -- 'inputKey', 'jobWatermark_inputKey' - The name of the .png or .jpg file that you want to use for the -- watermark. To determine which Amazon S3 bucket contains the specified -- file, Elastic Transcoder checks the pipeline specified by @Pipeline@; -- the @Input Bucket@ object in that pipeline identifies the bucket. -- -- If the file name includes a prefix, for example, __logos\/128x64.png__, -- include the prefix in the key. If the file isn\'t in the specified -- bucket, Elastic Transcoder returns an error. -- -- 'presetWatermarkId', 'jobWatermark_presetWatermarkId' - The ID of the watermark settings that Elastic Transcoder uses to add -- watermarks to the video during transcoding. The settings are in the -- preset specified by Preset for the current output. In that preset, the -- value of Watermarks Id tells Elastic Transcoder which settings to use. newJobWatermark :: JobWatermark newJobWatermark = JobWatermark' { encryption = Prelude.Nothing, inputKey = Prelude.Nothing, presetWatermarkId = Prelude.Nothing } -- | The encryption settings, if any, that you want Elastic Transcoder to -- apply to your watermarks. jobWatermark_encryption :: Lens.Lens' JobWatermark (Prelude.Maybe Encryption) jobWatermark_encryption = Lens.lens (\JobWatermark' {encryption} -> encryption) (\s@JobWatermark' {} a -> s {encryption = a} :: JobWatermark) -- | The name of the .png or .jpg file that you want to use for the -- watermark. To determine which Amazon S3 bucket contains the specified -- file, Elastic Transcoder checks the pipeline specified by @Pipeline@; -- the @Input Bucket@ object in that pipeline identifies the bucket. -- -- If the file name includes a prefix, for example, __logos\/128x64.png__, -- include the prefix in the key. If the file isn\'t in the specified -- bucket, Elastic Transcoder returns an error. jobWatermark_inputKey :: Lens.Lens' JobWatermark (Prelude.Maybe Prelude.Text) jobWatermark_inputKey = Lens.lens (\JobWatermark' {inputKey} -> inputKey) (\s@JobWatermark' {} a -> s {inputKey = a} :: JobWatermark) -- | The ID of the watermark settings that Elastic Transcoder uses to add -- watermarks to the video during transcoding. The settings are in the -- preset specified by Preset for the current output. In that preset, the -- value of Watermarks Id tells Elastic Transcoder which settings to use. jobWatermark_presetWatermarkId :: Lens.Lens' JobWatermark (Prelude.Maybe Prelude.Text) jobWatermark_presetWatermarkId = Lens.lens (\JobWatermark' {presetWatermarkId} -> presetWatermarkId) (\s@JobWatermark' {} a -> s {presetWatermarkId = a} :: JobWatermark) instance Data.FromJSON JobWatermark where parseJSON = Data.withObject "JobWatermark" ( \x -> JobWatermark' Prelude.<$> (x Data..:? "Encryption") Prelude.<*> (x Data..:? "InputKey") Prelude.<*> (x Data..:? "PresetWatermarkId") ) instance Prelude.Hashable JobWatermark where hashWithSalt _salt JobWatermark' {..} = _salt `Prelude.hashWithSalt` encryption `Prelude.hashWithSalt` inputKey `Prelude.hashWithSalt` presetWatermarkId instance Prelude.NFData JobWatermark where rnf JobWatermark' {..} = Prelude.rnf encryption `Prelude.seq` Prelude.rnf inputKey `Prelude.seq` Prelude.rnf presetWatermarkId instance Data.ToJSON JobWatermark where toJSON JobWatermark' {..} = Data.object ( Prelude.catMaybes [ ("Encryption" Data..=) Prelude.<$> encryption, ("InputKey" Data..=) Prelude.<$> inputKey, ("PresetWatermarkId" Data..=) Prelude.<$> presetWatermarkId ] )