Class CfnFlow
The AWS::MediaConnect::Flow resource defines a connection between one or more video sources and one or more outputs.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.MediaConnect
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFlow : CfnResource, IInspectable
Syntax (vb)
Public Class CfnFlow
Inherits CfnResource
Implements IInspectable
Remarks
For each flow, you specify the transport protocol to use, encryption information, and details for any outputs or entitlements that you want. AWS Elemental MediaConnect returns an ingest endpoint where you can send your live video as a single unicast stream. The service replicates and distributes the video to every output that you specify, whether inside or outside the AWS Cloud. You can also set up entitlements on a flow to allow other AWS accounts to access your content.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html
CloudformationResource: AWS::MediaConnect::Flow
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaConnect;
var cfnFlow = new CfnFlow(this, "MyCfnFlow", new CfnFlowProps {
Name = "name",
Source = new SourceProperty {
Decryption = new EncryptionProperty {
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 = new GatewayBridgeSourceProperty {
BridgeArn = "bridgeArn",
// the properties below are optional
VpcInterfaceAttachment = new VpcInterfaceAttachmentProperty {
VpcInterfaceName = "vpcInterfaceName"
}
},
IngestIp = "ingestIp",
IngestPort = 123,
MaxBitrate = 123,
MaxLatency = 123,
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",
SourceFailoverConfig = new FailoverConfigProperty {
FailoverMode = "failoverMode",
RecoveryWindow = 123,
SourcePriority = new SourcePriorityProperty {
PrimarySource = "primarySource"
},
State = "state"
}
});
Synopsis
Constructors
CfnFlow(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFlow(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnFlow(Construct, String, ICfnFlowProps) |
Properties
AttrFlowArn | The Amazon Resource Name (ARN) of the flow. |
AttrFlowAvailabilityZone | The Availability Zone that the flow was created in. |
AttrSourceIngestIp | The IP address that the flow listens on for incoming content. |
AttrSourceSourceArn | The ARN of the source. |
AttrSourceSourceIngestPort | The port that the flow listens on for incoming content. |
AvailabilityZone | The Availability Zone that you want to create the flow in. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Name | The name of the flow. |
Source | The settings for the source that you want to use for the new flow. |
SourceFailoverConfig | The settings for source failover. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFlow(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFlow(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFlow(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFlow(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnFlow(Construct, String, ICfnFlowProps)
public CfnFlow(Construct scope, string id, ICfnFlowProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnFlowProps
Resource properties.
Properties
AttrFlowArn
The Amazon Resource Name (ARN) of the flow.
public virtual string AttrFlowArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: FlowArn
AttrFlowAvailabilityZone
The Availability Zone that the flow was created in.
public virtual string AttrFlowAvailabilityZone { get; }
Property Value
System.String
Remarks
These options are limited to the Availability Zones within the current AWS Region.
CloudformationAttribute: FlowAvailabilityZone
AttrSourceIngestIp
The IP address that the flow listens on for incoming content.
public virtual string AttrSourceIngestIp { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Source.IngestIp
AttrSourceSourceArn
The ARN of the source.
public virtual string AttrSourceSourceArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Source.SourceArn
AttrSourceSourceIngestPort
The port that the flow listens on for incoming content.
public virtual string AttrSourceSourceIngestPort { get; }
Property Value
System.String
Remarks
If the protocol of the source is Zixi, the port must be set to 2088.
CloudformationAttribute: Source.SourceIngestPort
AvailabilityZone
The Availability Zone that you want to create the flow in.
public virtual string AvailabilityZone { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Name
The name of the flow.
public virtual string Name { get; set; }
Property Value
System.String
Source
The settings for the source that you want to use for the new flow.
public virtual object Source { get; set; }
Property Value
System.Object
SourceFailoverConfig
The settings for source failover.
public virtual object SourceFailoverConfig { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>