Flow
The settings for a flow, including its source, outputs, and entitlements.
Contents
- availabilityZone
-
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.
Type: String
Required: Yes
- entitlements
-
The entitlements in this flow.
Type: Array of Entitlement objects
Required: Yes
- flowArn
-
The Amazon Resource Name (ARN) of the flow.
Type: String
Required: Yes
- name
-
The name of the flow.
Type: String
Required: Yes
- outputs
-
The outputs in this flow.
Type: Array of Output objects
Required: Yes
- source
-
The source for the flow.
Type: Source object
Required: Yes
- status
-
The current status of the flow.
Type: String
Valid Values:
STANDBY | ACTIVE | UPDATING | DELETING | STARTING | STOPPING | ERRORRequired: Yes
- description
-
A description of the flow. This value is not used or seen outside of the current MediaConnect account.
Type: String
Required: No
- egressIp
-
The IP address from which video will be sent to output destinations.
Type: String
Required: No
- flowSize
-
Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
Type: String
Valid Values:
MEDIUM | LARGERequired: No
- maintenance
-
The maintenance settings for the flow.
Type: Maintenance object
Required: No
- 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.
Type: Array of MediaStream objects
Required: No
- ndiConfig
-
Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.
Type: NdiConfig object
Required: No
- sourceFailoverConfig
-
The settings for the source failover.
Type: FailoverConfig object
Required: No
- sourceMonitoringConfig
-
The settings for source monitoring.
Type: MonitoringConfig object
Required: No
- sources
-
The settings for the sources that are assigned to the flow.
Type: Array of Source objects
Required: No
- vpcInterfaces
-
The VPC Interfaces for this flow.
Type: Array of VpcInterface objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
