amazonka-mediaconnect-2.0: Amazon MediaConnect SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MediaConnect.Types.SetSourceRequest

Description

 
Synopsis

Documentation

data SetSourceRequest Source #

The settings for the source of the flow.

See: newSetSourceRequest smart constructor.

Constructors

SetSourceRequest' 

Fields

  • decryption :: Maybe Encryption

    The type of encryption that is used on the content ingested from this source.

  • description :: Maybe Text

    A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

  • entitlementArn :: Maybe Text

    The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.

  • ingestPort :: Maybe Int

    The port that the flow will be listening on for incoming content.

  • maxBitrate :: Maybe Int

    The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.

  • maxLatency :: Maybe Int

    The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.

  • maxSyncBuffer :: Maybe Int

    The size of the buffer (in milliseconds) to use to sync incoming source data.

  • mediaStreamSourceConfigurations :: Maybe [MediaStreamSourceConfigurationRequest]

    The media streams that are associated with the source, and the parameters for those associations.

  • minLatency :: Maybe Int

    The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.

  • name :: Maybe Text

    The name of the source.

  • protocol :: Maybe Protocol

    The protocol that is used by the source.

  • senderControlPort :: Maybe Int

    The port that the flow uses to send outbound requests to initiate connection with the sender.

  • senderIpAddress :: Maybe Text

    The IP address that the flow communicates with to initiate connection with the sender.

  • sourceListenerAddress :: Maybe Text

    Source IP or domain name for SRT-caller protocol.

  • sourceListenerPort :: Maybe Int

    Source port for SRT-caller protocol.

  • streamId :: Maybe Text

    The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.

  • vpcInterfaceName :: Maybe Text

    The name of the VPC interface to use for this source.

  • whitelistCidr :: Maybe Text

    The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Instances

Instances details
ToJSON SetSourceRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.SetSourceRequest

Generic SetSourceRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.SetSourceRequest

Associated Types

type Rep SetSourceRequest :: Type -> Type #

Read SetSourceRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.SetSourceRequest

Show SetSourceRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.SetSourceRequest

NFData SetSourceRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.SetSourceRequest

Methods

rnf :: SetSourceRequest -> () #

Eq SetSourceRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.SetSourceRequest

Hashable SetSourceRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.SetSourceRequest

type Rep SetSourceRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.SetSourceRequest

type Rep SetSourceRequest = D1 ('MetaData "SetSourceRequest" "Amazonka.MediaConnect.Types.SetSourceRequest" "amazonka-mediaconnect-2.0-KNF7B97aPsN1PZ2vBYFgux" 'False) (C1 ('MetaCons "SetSourceRequest'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "decryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Encryption)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "entitlementArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ingestPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "maxBitrate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "maxLatency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "maxSyncBuffer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "mediaStreamSourceConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MediaStreamSourceConfigurationRequest])) :*: S1 ('MetaSel ('Just "minLatency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :*: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Protocol))) :*: (S1 ('MetaSel ('Just "senderControlPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "senderIpAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "sourceListenerAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceListenerPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "vpcInterfaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "whitelistCidr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newSetSourceRequest :: SetSourceRequest Source #

Create a value of SetSourceRequest 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:decryption:SetSourceRequest', setSourceRequest_decryption - The type of encryption that is used on the content ingested from this source.

$sel:description:SetSourceRequest', setSourceRequest_description - A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

$sel:entitlementArn:SetSourceRequest', setSourceRequest_entitlementArn - The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.

$sel:ingestPort:SetSourceRequest', setSourceRequest_ingestPort - The port that the flow will be listening on for incoming content.

$sel:maxBitrate:SetSourceRequest', setSourceRequest_maxBitrate - The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.

$sel:maxLatency:SetSourceRequest', setSourceRequest_maxLatency - The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.

$sel:maxSyncBuffer:SetSourceRequest', setSourceRequest_maxSyncBuffer - The size of the buffer (in milliseconds) to use to sync incoming source data.

$sel:mediaStreamSourceConfigurations:SetSourceRequest', setSourceRequest_mediaStreamSourceConfigurations - The media streams that are associated with the source, and the parameters for those associations.

$sel:minLatency:SetSourceRequest', setSourceRequest_minLatency - The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.

$sel:name:SetSourceRequest', setSourceRequest_name - The name of the source.

$sel:protocol:SetSourceRequest', setSourceRequest_protocol - The protocol that is used by the source.

$sel:senderControlPort:SetSourceRequest', setSourceRequest_senderControlPort - The port that the flow uses to send outbound requests to initiate connection with the sender.

$sel:senderIpAddress:SetSourceRequest', setSourceRequest_senderIpAddress - The IP address that the flow communicates with to initiate connection with the sender.

$sel:sourceListenerAddress:SetSourceRequest', setSourceRequest_sourceListenerAddress - Source IP or domain name for SRT-caller protocol.

$sel:sourceListenerPort:SetSourceRequest', setSourceRequest_sourceListenerPort - Source port for SRT-caller protocol.

$sel:streamId:SetSourceRequest', setSourceRequest_streamId - The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.

$sel:vpcInterfaceName:SetSourceRequest', setSourceRequest_vpcInterfaceName - The name of the VPC interface to use for this source.

$sel:whitelistCidr:SetSourceRequest', setSourceRequest_whitelistCidr - The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

setSourceRequest_decryption :: Lens' SetSourceRequest (Maybe Encryption) Source #

The type of encryption that is used on the content ingested from this source.

setSourceRequest_description :: Lens' SetSourceRequest (Maybe Text) Source #

A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

setSourceRequest_entitlementArn :: Lens' SetSourceRequest (Maybe Text) Source #

The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.

setSourceRequest_ingestPort :: Lens' SetSourceRequest (Maybe Int) Source #

The port that the flow will be listening on for incoming content.

setSourceRequest_maxBitrate :: Lens' SetSourceRequest (Maybe Int) Source #

The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.

setSourceRequest_maxLatency :: Lens' SetSourceRequest (Maybe Int) Source #

The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.

setSourceRequest_maxSyncBuffer :: Lens' SetSourceRequest (Maybe Int) Source #

The size of the buffer (in milliseconds) to use to sync incoming source data.

setSourceRequest_mediaStreamSourceConfigurations :: Lens' SetSourceRequest (Maybe [MediaStreamSourceConfigurationRequest]) Source #

The media streams that are associated with the source, and the parameters for those associations.

setSourceRequest_minLatency :: Lens' SetSourceRequest (Maybe Int) Source #

The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.

setSourceRequest_protocol :: Lens' SetSourceRequest (Maybe Protocol) Source #

The protocol that is used by the source.

setSourceRequest_senderControlPort :: Lens' SetSourceRequest (Maybe Int) Source #

The port that the flow uses to send outbound requests to initiate connection with the sender.

setSourceRequest_senderIpAddress :: Lens' SetSourceRequest (Maybe Text) Source #

The IP address that the flow communicates with to initiate connection with the sender.

setSourceRequest_sourceListenerAddress :: Lens' SetSourceRequest (Maybe Text) Source #

Source IP or domain name for SRT-caller protocol.

setSourceRequest_streamId :: Lens' SetSourceRequest (Maybe Text) Source #

The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.

setSourceRequest_vpcInterfaceName :: Lens' SetSourceRequest (Maybe Text) Source #

The name of the VPC interface to use for this source.

setSourceRequest_whitelistCidr :: Lens' SetSourceRequest (Maybe Text) Source #

The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.