interface CfnFlowProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.MediaConnect.CfnFlowProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsmediaconnect#CfnFlowProps |
![]() | software.amazon.awscdk.services.mediaconnect.CfnFlowProps |
![]() | aws_cdk.aws_mediaconnect.CfnFlowProps |
![]() | aws-cdk-lib » aws_mediaconnect » CfnFlowProps |
Properties for defining a CfnFlow
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html
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 cfnFlowProps: mediaconnect.CfnFlowProps = {
name: 'name',
source: {
decryption: {
roleArn: 'roleArn',
// the properties below are optional
algorithm: 'algorithm',
constantInitializationVector: 'constantInitializationVector',
deviceId: 'deviceId',
keyType: 'keyType',
region: 'region',
resourceId: 'resourceId',
secretArn: 'secretArn',
url: 'url',
},
description: 'description',
entitlementArn: 'entitlementArn',
gatewayBridgeSource: {
bridgeArn: 'bridgeArn',
// the properties below are optional
vpcInterfaceAttachment: {
vpcInterfaceName: 'vpcInterfaceName',
},
},
ingestIp: 'ingestIp',
ingestPort: 123,
maxBitrate: 123,
maxLatency: 123,
maxSyncBuffer: 123,
mediaStreamSourceConfigurations: [{
encodingName: 'encodingName',
mediaStreamName: 'mediaStreamName',
// the properties below are optional
inputConfigurations: [{
inputPort: 123,
interface: {
name: 'name',
},
}],
}],
minLatency: 123,
name: 'name',
protocol: 'protocol',
senderControlPort: 123,
senderIpAddress: 'senderIpAddress',
sourceArn: 'sourceArn',
sourceIngestPort: 'sourceIngestPort',
sourceListenerAddress: 'sourceListenerAddress',
sourceListenerPort: 123,
streamId: 'streamId',
vpcInterfaceName: 'vpcInterfaceName',
whitelistCidr: 'whitelistCidr',
},
// the properties below are optional
availabilityZone: 'availabilityZone',
maintenance: {
maintenanceDay: 'maintenanceDay',
maintenanceStartHour: 'maintenanceStartHour',
},
mediaStreams: [{
mediaStreamId: 123,
mediaStreamName: 'mediaStreamName',
mediaStreamType: 'mediaStreamType',
// the properties below are optional
attributes: {
fmtp: {
channelOrder: 'channelOrder',
colorimetry: 'colorimetry',
exactFramerate: 'exactFramerate',
par: 'par',
range: 'range',
scanMode: 'scanMode',
tcs: 'tcs',
},
lang: 'lang',
},
clockRate: 123,
description: 'description',
fmt: 123,
videoFormat: 'videoFormat',
}],
sourceFailoverConfig: {
failoverMode: 'failoverMode',
recoveryWindow: 123,
sourcePriority: {
primarySource: 'primarySource',
},
state: 'state',
},
sourceMonitoringConfig: {
audioMonitoringSettings: [{
silentAudio: {
state: 'state',
thresholdSeconds: 123,
},
}],
contentQualityAnalysisState: 'contentQualityAnalysisState',
thumbnailState: 'thumbnailState',
videoMonitoringSettings: [{
blackFrames: {
state: 'state',
thresholdSeconds: 123,
},
frozenFrames: {
state: 'state',
thresholdSeconds: 123,
},
}],
},
vpcInterfaces: [{
name: 'name',
roleArn: 'roleArn',
securityGroupIds: ['securityGroupIds'],
subnetId: 'subnetId',
// the properties below are optional
networkInterfaceIds: ['networkInterfaceIds'],
networkInterfaceType: 'networkInterfaceType',
}],
};
Properties
Name | Type | Description |
---|---|---|
name | string | The name of the flow. |
source | IResolvable | Source | The settings for the source that you want to use for the new flow. |
availability | string | The Availability Zone that you want to create the flow in. |
maintenance? | IResolvable | Maintenance | The maintenance settings you want to use for the flow. |
media | IResolvable | IResolvable | Media [] | The media streams associated with the flow. |
source | IResolvable | Failover | The settings for source failover. |
source | IResolvable | Source | The settings for source monitoring. |
vpc | IResolvable | IResolvable | Vpc [] | The VPC interfaces that you added to this flow. |
name
Type:
string
The name of the flow.
source
Type:
IResolvable
|
Source
The settings for the source that you want to use for the new flow.
availabilityZone?
Type:
string
(optional)
The Availability Zone that you want to create the flow in.
These options are limited to the Availability Zones within the current AWS Region.
maintenance?
Type:
IResolvable
|
Maintenance
(optional)
The maintenance settings you want to use for the flow.
mediaStreams?
Type:
IResolvable
|
IResolvable
|
Media
[]
(optional)
The media streams associated with the flow.
You can associate any of these media streams with sources and outputs on the flow.
sourceFailoverConfig?
Type:
IResolvable
|
Failover
(optional)
The settings for source failover.
sourceMonitoringConfig?
Type:
IResolvable
|
Source
(optional)
The settings for source monitoring.
vpcInterfaces?
Type:
IResolvable
|
IResolvable
|
Vpc
[]
(optional)
The VPC interfaces that you added to this flow.