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.AddOutputRequest

Description

 
Synopsis

Documentation

data AddOutputRequest Source #

The output that you want to add to this flow.

See: newAddOutputRequest smart constructor.

Constructors

AddOutputRequest' 

Fields

  • cidrAllowList :: Maybe [Text]

    The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

  • description :: Maybe Text

    A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.

  • destination :: Maybe Text

    The IP address from which video will be sent to output destinations.

  • encryption :: Maybe Encryption

    The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

  • maxLatency :: Maybe Int

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

  • mediaStreamOutputConfigurations :: Maybe [MediaStreamOutputConfigurationRequest]

    The media streams that are associated with the output, 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 output. This value must be unique within the current flow.

  • port :: Maybe Int

    The port to use when content is distributed to this output.

  • remoteId :: Maybe Text

    The remote ID for the Zixi-pull output stream.

  • senderControlPort :: Maybe Int

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

  • smoothingLatency :: Maybe Int

    The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

  • streamId :: Maybe Text

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

  • vpcInterfaceAttachment :: Maybe VpcInterfaceAttachment

    The name of the VPC interface attachment to use for this output.

  • protocol :: Protocol

    The protocol to use for the output.

Instances

Instances details
ToJSON AddOutputRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.AddOutputRequest

Generic AddOutputRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.AddOutputRequest

Associated Types

type Rep AddOutputRequest :: Type -> Type #

Read AddOutputRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.AddOutputRequest

Show AddOutputRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.AddOutputRequest

NFData AddOutputRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.AddOutputRequest

Methods

rnf :: AddOutputRequest -> () #

Eq AddOutputRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.AddOutputRequest

Hashable AddOutputRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.AddOutputRequest

type Rep AddOutputRequest Source # 
Instance details

Defined in Amazonka.MediaConnect.Types.AddOutputRequest

type Rep AddOutputRequest = D1 ('MetaData "AddOutputRequest" "Amazonka.MediaConnect.Types.AddOutputRequest" "amazonka-mediaconnect-2.0-KNF7B97aPsN1PZ2vBYFgux" 'False) (C1 ('MetaCons "AddOutputRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cidrAllowList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "encryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Encryption)) :*: S1 ('MetaSel ('Just "maxLatency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "mediaStreamOutputConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MediaStreamOutputConfigurationRequest])) :*: S1 ('MetaSel ('Just "minLatency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "remoteId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "senderControlPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "smoothingLatency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "vpcInterfaceAttachment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcInterfaceAttachment)) :*: S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Protocol))))))

newAddOutputRequest Source #

Create a value of AddOutputRequest 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:cidrAllowList:AddOutputRequest', addOutputRequest_cidrAllowList - The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

$sel:description:AddOutputRequest', addOutputRequest_description - A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.

$sel:destination:AddOutputRequest', addOutputRequest_destination - The IP address from which video will be sent to output destinations.

$sel:encryption:AddOutputRequest', addOutputRequest_encryption - The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

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

$sel:mediaStreamOutputConfigurations:AddOutputRequest', addOutputRequest_mediaStreamOutputConfigurations - The media streams that are associated with the output, and the parameters for those associations.

$sel:minLatency:AddOutputRequest', addOutputRequest_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:AddOutputRequest', addOutputRequest_name - The name of the output. This value must be unique within the current flow.

$sel:port:AddOutputRequest', addOutputRequest_port - The port to use when content is distributed to this output.

$sel:remoteId:AddOutputRequest', addOutputRequest_remoteId - The remote ID for the Zixi-pull output stream.

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

$sel:smoothingLatency:AddOutputRequest', addOutputRequest_smoothingLatency - The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

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

$sel:vpcInterfaceAttachment:AddOutputRequest', addOutputRequest_vpcInterfaceAttachment - The name of the VPC interface attachment to use for this output.

$sel:protocol:AddOutputRequest', addOutputRequest_protocol - The protocol to use for the output.

addOutputRequest_cidrAllowList :: Lens' AddOutputRequest (Maybe [Text]) Source #

The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

addOutputRequest_description :: Lens' AddOutputRequest (Maybe Text) Source #

A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.

addOutputRequest_destination :: Lens' AddOutputRequest (Maybe Text) Source #

The IP address from which video will be sent to output destinations.

addOutputRequest_encryption :: Lens' AddOutputRequest (Maybe Encryption) Source #

The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

addOutputRequest_maxLatency :: Lens' AddOutputRequest (Maybe Int) Source #

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

addOutputRequest_mediaStreamOutputConfigurations :: Lens' AddOutputRequest (Maybe [MediaStreamOutputConfigurationRequest]) Source #

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

addOutputRequest_minLatency :: Lens' AddOutputRequest (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.

addOutputRequest_name :: Lens' AddOutputRequest (Maybe Text) Source #

The name of the output. This value must be unique within the current flow.

addOutputRequest_port :: Lens' AddOutputRequest (Maybe Int) Source #

The port to use when content is distributed to this output.

addOutputRequest_remoteId :: Lens' AddOutputRequest (Maybe Text) Source #

The remote ID for the Zixi-pull output stream.

addOutputRequest_senderControlPort :: Lens' AddOutputRequest (Maybe Int) Source #

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

addOutputRequest_smoothingLatency :: Lens' AddOutputRequest (Maybe Int) Source #

The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

addOutputRequest_streamId :: Lens' AddOutputRequest (Maybe Text) Source #

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

addOutputRequest_vpcInterfaceAttachment :: Lens' AddOutputRequest (Maybe VpcInterfaceAttachment) Source #

The name of the VPC interface attachment to use for this output.

addOutputRequest_protocol :: Lens' AddOutputRequest Protocol Source #

The protocol to use for the output.