Amazonka.IVS.Types.RecordingConfiguration

Documentation

data RecordingConfiguration

An object representing a configuration to record a channel stream.

See: newRecordingConfiguration smart constructor.

Constructors

RecordingConfiguration'

Fields

• name :: Maybe Text

  Recording-configuration name. The value does not need to be unique.

• recordingReconnectWindowSeconds :: Maybe Natural

  If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

• tags :: Maybe (HashMap Text Text)

  Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

• thumbnailConfiguration :: Maybe ThumbnailConfiguration

  A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

• arn :: Text

  Recording-configuration ARN.

• destinationConfiguration :: DestinationConfiguration

  A complex type that contains information about where recorded video will be stored.

• state :: RecordingConfigurationState

  Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

Instances

FromJSON RecordingConfiguration

Defined in Amazonka.IVS.Types.RecordingConfiguration

Methods

parseJSON :: Value -> Parser RecordingConfiguration

parseJSONList :: Value -> Parser [RecordingConfiguration]

Generic RecordingConfiguration

Defined in Amazonka.IVS.Types.RecordingConfiguration

Associated Types

type Rep RecordingConfiguration :: Type -> Type

Methods

from :: RecordingConfiguration -> Rep RecordingConfiguration x

to :: Rep RecordingConfiguration x -> RecordingConfiguration

Read RecordingConfiguration

Defined in Amazonka.IVS.Types.RecordingConfiguration

Methods

readsPrec :: Int -> ReadS RecordingConfiguration

readList :: ReadS [RecordingConfiguration]

readPrec :: ReadPrec RecordingConfiguration

readListPrec :: ReadPrec [RecordingConfiguration]

Show RecordingConfiguration

Defined in Amazonka.IVS.Types.RecordingConfiguration

Methods

showsPrec :: Int -> RecordingConfiguration -> ShowS

show :: RecordingConfiguration -> String

showList :: [RecordingConfiguration] -> ShowS

NFData RecordingConfiguration

Defined in Amazonka.IVS.Types.RecordingConfiguration

Methods

rnf :: RecordingConfiguration -> ()

Eq RecordingConfiguration

Defined in Amazonka.IVS.Types.RecordingConfiguration

Methods

(==) :: RecordingConfiguration -> RecordingConfiguration -> Bool

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

Hashable RecordingConfiguration

Defined in Amazonka.IVS.Types.RecordingConfiguration

Methods

hashWithSalt :: Int -> RecordingConfiguration -> Int

hash :: RecordingConfiguration -> Int

type Rep RecordingConfiguration

Defined in Amazonka.IVS.Types.RecordingConfiguration

type Rep RecordingConfiguration = D1 ('MetaData "RecordingConfiguration" "Amazonka.IVS.Types.RecordingConfiguration" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "RecordingConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "recordingReconnectWindowSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: ((S1 ('MetaSel ('Just "thumbnailConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThumbnailConfiguration)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "destinationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DestinationConfiguration) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RecordingConfigurationState)))))

newRecordingConfiguration

Arguments

:: Text

$sel:arn:RecordingConfiguration'

-> DestinationConfiguration

$sel:destinationConfiguration:RecordingConfiguration'

-> RecordingConfigurationState

$sel:state:RecordingConfiguration'

-> RecordingConfiguration

Create a value of RecordingConfiguration 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:name:RecordingConfiguration', recordingConfiguration_name - Recording-configuration name. The value does not need to be unique.

$sel:recordingReconnectWindowSeconds:RecordingConfiguration', recordingConfiguration_recordingReconnectWindowSeconds - If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

$sel:tags:RecordingConfiguration', recordingConfiguration_tags - Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

$sel:thumbnailConfiguration:RecordingConfiguration', recordingConfiguration_thumbnailConfiguration - A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

$sel:arn:RecordingConfiguration', recordingConfiguration_arn - Recording-configuration ARN.

$sel:destinationConfiguration:RecordingConfiguration', recordingConfiguration_destinationConfiguration - A complex type that contains information about where recorded video will be stored.

$sel:state:RecordingConfiguration', recordingConfiguration_state - Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

recordingConfiguration_name :: Lens' RecordingConfiguration (Maybe Text)

Recording-configuration name. The value does not need to be unique.

recordingConfiguration_recordingReconnectWindowSeconds :: Lens' RecordingConfiguration (Maybe Natural)

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

recordingConfiguration_tags :: Lens' RecordingConfiguration (Maybe (HashMap Text Text))

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

recordingConfiguration_thumbnailConfiguration :: Lens' RecordingConfiguration (Maybe ThumbnailConfiguration)

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

recordingConfiguration_arn :: Lens' RecordingConfiguration Text

Recording-configuration ARN.

recordingConfiguration_destinationConfiguration :: Lens' RecordingConfiguration DestinationConfiguration

A complex type that contains information about where recorded video will be stored.

recordingConfiguration_state :: Lens' RecordingConfiguration RecordingConfigurationState

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.