Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MediaConnect.Types.Flow

Description

Synopsis

data Flow = Flow' {
- description :: Maybe Text
- egressIp :: Maybe Text
- maintenance :: Maybe Maintenance
- mediaStreams :: Maybe [MediaStream]
- sourceFailoverConfig :: Maybe FailoverConfig
- sources :: Maybe [Source]
- vpcInterfaces :: Maybe [VpcInterface]
- status :: Status
- entitlements :: [Entitlement]
- outputs :: [Output]
- availabilityZone :: Text
- flowArn :: Text
- source :: Source
- name :: Text
}
newFlow :: Status -> Text -> Text -> Source -> Text -> Flow
flow_description :: Lens' Flow (Maybe Text)
flow_egressIp :: Lens' Flow (Maybe Text)
flow_maintenance :: Lens' Flow (Maybe Maintenance)
flow_mediaStreams :: Lens' Flow (Maybe [MediaStream])
flow_sourceFailoverConfig :: Lens' Flow (Maybe FailoverConfig)
flow_sources :: Lens' Flow (Maybe [Source])
flow_vpcInterfaces :: Lens' Flow (Maybe [VpcInterface])
flow_status :: Lens' Flow Status
flow_entitlements :: Lens' Flow [Entitlement]
flow_outputs :: Lens' Flow [Output]
flow_availabilityZone :: Lens' Flow Text
flow_flowArn :: Lens' Flow Text
flow_source :: Lens' Flow Source
flow_name :: Lens' Flow Text

Documentation

data Flow Source #

The settings for a flow, including its source, outputs, and entitlements.

See: newFlow smart constructor.

Constructors

Flow'

Fields

description :: Maybe Text
A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
egressIp :: Maybe Text
The IP address from which video will be sent to output destinations.
maintenance :: Maybe Maintenance
mediaStreams :: Maybe [MediaStream]
The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
sourceFailoverConfig :: Maybe FailoverConfig
sources :: Maybe [Source]
vpcInterfaces :: Maybe [VpcInterface]
The VPC Interfaces for this flow.
status :: Status
The current status of the flow.
entitlements :: [Entitlement]
The entitlements in this flow.
outputs :: [Output]
The outputs in this flow.
availabilityZone :: Text
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
flowArn :: Text
The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
source :: Source
name :: Text
The name of the flow.

Instances

Instances details

FromJSON Flow Source #
Instance details Defined in Amazonka.MediaConnect.Types.Flow Methods parseJSON :: Value -> Parser Flow # parseJSONList :: Value -> Parser [Flow] #
Generic Flow Source #
Instance details Defined in Amazonka.MediaConnect.Types.Flow Associated Types type Rep Flow :: Type -> Type # Methods from :: Flow -> Rep Flow x # to :: Rep Flow x -> Flow #
Read Flow Source #
Instance details Defined in Amazonka.MediaConnect.Types.Flow Methods readsPrec :: Int -> ReadS Flow # readList :: ReadS [Flow] # readPrec :: ReadPrec Flow # readListPrec :: ReadPrec [Flow] #
Show Flow Source #
Instance details Defined in Amazonka.MediaConnect.Types.Flow Methods showsPrec :: Int -> Flow -> ShowS # show :: Flow -> String # showList :: [Flow] -> ShowS #
NFData Flow Source #
Instance details Defined in Amazonka.MediaConnect.Types.Flow Methods rnf :: Flow -> () #
Eq Flow Source #
Instance details Defined in Amazonka.MediaConnect.Types.Flow Methods (==) :: Flow -> Flow -> Bool # (/=) :: Flow -> Flow -> Bool #
Hashable Flow Source #
Instance details Defined in Amazonka.MediaConnect.Types.Flow Methods hashWithSalt :: Int -> Flow -> Int # hash :: Flow -> Int #
type Rep Flow Source #
Instance details Defined in Amazonka.MediaConnect.Types.Flow type Rep Flow = D1 ('MetaData "Flow" "Amazonka.MediaConnect.Types.Flow" "amazonka-mediaconnect-2.0-KNF7B97aPsN1PZ2vBYFgux" 'False) (C1 ('MetaCons "Flow'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "egressIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maintenance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Maintenance)))) :: ((S1 ('MetaSel ('Just "mediaStreams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MediaStream])) :: S1 ('MetaSel ('Just "sourceFailoverConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailoverConfig))) :: (S1 ('MetaSel ('Just "sources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Source])) :: S1 ('MetaSel ('Just "vpcInterfaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcInterface]))))) :: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Status) :: (S1 ('MetaSel ('Just "entitlements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Entitlement]) :: S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Output]))) :: ((S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "flowArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Source) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newFlow Source #

Arguments

:: Status	`$sel:status:Flow'`
-> Text	`$sel:availabilityZone:Flow'`
-> Text	`$sel:flowArn:Flow'`
-> Source	`$sel:source:Flow'`
-> Text	`Flow`
-> Flow

Create a value of Flow 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:

Flow, flow_description - A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

$sel:egressIp:Flow', flow_egressIp - The IP address from which video will be sent to output destinations.

$sel:maintenance:Flow', flow_maintenance - Undocumented member.

$sel:mediaStreams:Flow', flow_mediaStreams - The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.

$sel:sourceFailoverConfig:Flow', flow_sourceFailoverConfig - Undocumented member.

$sel:sources:Flow', flow_sources - Undocumented member.

$sel:vpcInterfaces:Flow', flow_vpcInterfaces - The VPC Interfaces for this flow.

$sel:status:Flow', flow_status - The current status of the flow.

$sel:entitlements:Flow', flow_entitlements - The entitlements in this flow.

$sel:outputs:Flow', flow_outputs - The outputs in this flow.

$sel:availabilityZone:Flow', flow_availabilityZone - The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.

$sel:flowArn:Flow', flow_flowArn - The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.

$sel:source:Flow', flow_source - Undocumented member.

Flow, flow_name - The name of the flow.

flow_description :: Lens' Flow (Maybe Text) Source #

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

flow_egressIp :: Lens' Flow (Maybe Text) Source #

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

flow_maintenance :: Lens' Flow (Maybe Maintenance) Source #

Undocumented member.

flow_mediaStreams :: Lens' Flow (Maybe [MediaStream]) Source #

The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.

flow_sourceFailoverConfig :: Lens' Flow (Maybe FailoverConfig) Source #

Undocumented member.

flow_sources :: Lens' Flow (Maybe [Source]) Source #

Undocumented member.

flow_vpcInterfaces :: Lens' Flow (Maybe [VpcInterface]) Source #

The VPC Interfaces for this flow.

flow_status :: Lens' Flow Status Source #

The current status of the flow.

flow_entitlements :: Lens' Flow [Entitlement] Source #

The entitlements in this flow.

flow_outputs :: Lens' Flow [Output] Source #

The outputs in this flow.