interface CfnFlowOutputProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.MediaConnect.CfnFlowOutputProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsmediaconnect#CfnFlowOutputProps |
![]() | software.amazon.awscdk.services.mediaconnect.CfnFlowOutputProps |
![]() | aws_cdk.aws_mediaconnect.CfnFlowOutputProps |
![]() | aws-cdk-lib » aws_mediaconnect » CfnFlowOutputProps |
Properties for defining a CfnFlowOutput
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediaconnect as mediaconnect } from 'aws-cdk-lib';
const cfnFlowOutputProps: mediaconnect.CfnFlowOutputProps = {
flowArn: 'flowArn',
protocol: 'protocol',
// the properties below are optional
cidrAllowList: ['cidrAllowList'],
description: 'description',
destination: 'destination',
encryption: {
roleArn: 'roleArn',
secretArn: 'secretArn',
// the properties below are optional
algorithm: 'algorithm',
keyType: 'keyType',
},
maxLatency: 123,
mediaStreamOutputConfigurations: [{
encodingName: 'encodingName',
mediaStreamName: 'mediaStreamName',
// the properties below are optional
destinationConfigurations: [{
destinationIp: 'destinationIp',
destinationPort: 123,
interface: {
name: 'name',
},
}],
encodingParameters: {
compressionFactor: 123,
// the properties below are optional
encoderProfile: 'encoderProfile',
},
}],
minLatency: 123,
name: 'name',
outputStatus: 'outputStatus',
port: 123,
remoteId: 'remoteId',
smoothingLatency: 123,
streamId: 'streamId',
vpcInterfaceAttachment: {
vpcInterfaceName: 'vpcInterfaceName',
},
};
Properties
Name | Type | Description |
---|---|---|
flow | string | The Amazon Resource Name (ARN) of the flow this output is attached to. |
protocol | string | The protocol to use for the output. |
cidr | string[] | The range of IP addresses that are allowed to initiate output requests to this flow. |
description? | string | A description of the output. |
destination? | string | The IP address where you want to send the output. |
encryption? | IResolvable | Encryption | The encryption credentials that you want to use for the output. |
max | number | The maximum latency in milliseconds. |
media | IResolvable | IResolvable | Media [] | The definition for each media stream that is associated with the output. |
min | number | The minimum latency in milliseconds for SRT-based streams. |
name? | string | The name of the output. |
output | string | An indication of whether the new output should be enabled or disabled as soon as it is created. |
port? | number | The port to use when MediaConnect distributes content to the output. |
remote | string | The identifier that is assigned to the Zixi receiver. |
smoothing | number | The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams. |
stream | string | The stream ID that you want to use for this transport. |
vpc | IResolvable | Vpc | The VPC interface that you want to send your output to. |
flowArn
Type:
string
The Amazon Resource Name (ARN) of the flow this output is attached to.
protocol
Type:
string
The protocol to use for the output.
AWS Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
cidrAllowList?
Type:
string[]
(optional)
The range of IP addresses that are allowed to initiate output requests to this flow.
Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
description?
Type:
string
(optional)
A description of the output.
This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.
destination?
Type:
string
(optional)
The IP address where you want to send the output.
encryption?
Type:
IResolvable
|
Encryption
(optional)
The encryption credentials that you want to use for the output.
maxLatency?
Type:
number
(optional)
The maximum latency in milliseconds.
This parameter applies only to RIST-based and Zixi-based streams.
mediaStreamOutputConfigurations?
Type:
IResolvable
|
IResolvable
|
Media
[]
(optional)
The definition for each media stream that is associated with the output.
minLatency?
Type:
number
(optional)
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?
Type:
string
(optional)
The name of the output.
This value must be unique within the current flow.
outputStatus?
Type:
string
(optional)
An indication of whether the new output should be enabled or disabled as soon as it is created.
If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.
port?
Type:
number
(optional)
The port to use when MediaConnect distributes content to the output.
remoteId?
Type:
string
(optional)
The identifier that is assigned to the Zixi receiver.
This parameter applies only to outputs that use Zixi pull.
smoothingLatency?
Type:
number
(optional)
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
streamId?
Type:
string
(optional)
The stream ID that you want to use for this transport.
This parameter applies only to Zixi and SRT caller-based streams.
vpcInterfaceAttachment?
Type:
IResolvable
|
Vpc
(optional)
The VPC interface that you want to send your output to.