@aws-cdk/aws-mediaconnect-alpha.IFlow

Experimental

@aws-cdk/aws-mediaconnect-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IFlow Interface

Interface for Flow.

IFlow

extends

• IResource,
• IFlowRef

implemented by

• Flow

Stability

Experimental

Source

lib/flow.ts

Properties

egressIpstringegress_ipstregressIpStringEgressIpstringEgressIp*string#

The IP address that the flow uses to send outbound content.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

flowArnstringflow_arnstrflowArnStringFlowArnstringFlowArn*string#

The Amazon Resource Name (ARN) of the flow.

flowAvailabilityZone?may be undefinedstringflow_availability_zone?may be undefinedstrflowAvailabilityZone?may be undefinedStringFlowAvailabilityZone?may be undefinedstringFlowAvailabilityZone?may be undefined*string#

The Availability Zone that the flow was created in.

flowRefFlowReferenceflow_refFlowReferenceflowRefFlowReferenceFlowRefFlowReferenceFlowRefFlowReference#

A reference to a Flow resource.

grantsFlowGrantsgrantsFlowGrantsgrantsFlowGrantsGrantsFlowGrantsGrantsFlowGrants#

Collection of grant methods for this flow.

isFailoverEnabled?may be undefinedbooleanis_failover_enabled?may be undefinedboolisFailoverEnabled?may be undefinedBooleanIsFailoverEnabled?may be undefinedboolIsFailoverEnabled?may be undefined*bool#

Failover Configuration for flow.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

sourceArnstringsource_arnstrsourceArnStringSourceArnstringSourceArn*string#

The Amazon Resource Name (ARN) of the source defined on the flow.

sourceIngestIpstringsource_ingest_ipstrsourceIngestIpStringSourceIngestIpstringSourceIngestIp*string#

The IP address that the flow listens on for incoming content.

notes

Available for listener-style source protocols (RTP, RTP-FEC, RIST, SRT listener, Zixi push). Accessing this on SRT caller, entitlement, gateway bridge, router, CDI, JPEG XS, or imported flows throws — those sources don't expose a listening IP address.

sourceIngestPortstringsource_ingest_portstrsourceIngestPortStringSourceIngestPortstringSourceIngestPort*string#

The port that the flow listens on for incoming content.

Available for the same listener-style source protocols as sourceIngestIp. Accessing this on SRT caller, entitlement, gateway bridge, router, CDI, JPEG XS, or imported flows throws.

sourceIngestUrlstringsource_ingest_urlstrsourceIngestUrlStringSourceIngestUrlstringSourceIngestUrl*string#

The full ingest URL for the flow source, combining protocol, IP, and port. For example: `srt://203.0.113.10:5000`.

notes

Available for listener-style source protocols (RTP, RTP-FEC, RIST, SRT listener, Zixi push) where the flow listens for an upstream sender. Accessing this on SRT caller, entitlement, gateway bridge, router, CDI, JPEG XS, or imported flows throws — those sources don't expose a single host:port ingest URL.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

addOutput(id: string, options: AddFlowOutputOptions): IFlowOutputdef add_output(self, id: str, options: AddFlowOutputOptions) -> IFlowOutputpublic IFlowOutput addOutput(String id, AddFlowOutputOptions options)public IFlowOutput AddOutput(string id, AddFlowOutputOptions options)func AddOutput(Id *string, Options AddFlowOutputOptions) IFlowOutput#

Add an output to this flow.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#

Create a CloudWatch metric for this flow.

metricSourceBitrate(props?: MetricOptions): Metricdef metric_source_bitrate(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSourceBitrate(MetricOptions props)public Metric MetricSourceBitrate(MetricOptions? props = null)func MetricSourceBitrate(Props MetricOptions) Metric#

Metric for the bitrate of content ingested into the flow.

metricSourceConnected(props?: MetricOptions): Metricdef metric_source_connected(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSourceConnected(MetricOptions props)public Metric MetricSourceConnected(MetricOptions? props = null)func MetricSourceConnected(Props MetricOptions) Metric#

Metric indicating the connection state of the source (1 connected, 0 disconnected).

Applies only to Zixi, SRT, and RIST sources.

metricSourceDisconnections(props?: MetricOptions): Metricdef metric_source_disconnections(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSourceDisconnections(MetricOptions props)public Metric MetricSourceDisconnections(MetricOptions? props = null)func MetricSourceDisconnections(Props MetricOptions) Metric#

Metric for the number of times the source transitioned from connected to disconnected.

metricSourceDroppedPackets(props?: MetricOptions): Metricdef metric_source_dropped_packets(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSourceDroppedPackets(MetricOptions props)public Metric MetricSourceDroppedPackets(MetricOptions? props = null)func MetricSourceDroppedPackets(Props MetricOptions) Metric#

Metric for the number of packets lost during transit, measured before any error correction.

metricSourceJitter(props?: MetricOptions): Metricdef metric_source_jitter(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSourceJitter(MetricOptions props)public Metric MetricSourceJitter(MetricOptions? props = null)func MetricSourceJitter(Props MetricOptions) Metric#

Metric for the current network jitter of the source, measured in milliseconds.

metricSourceNotRecoveredPackets(props?: MetricOptions): Metricdef metric_source_not_recovered_packets(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSourceNotRecoveredPackets(MetricOptions props)public Metric MetricSourceNotRecoveredPackets(MetricOptions? props = null)func MetricSourceNotRecoveredPackets(Props MetricOptions) Metric#

Metric for packets that were not recovered by the flow source.

metricSourcePacketLossPercent(props?: MetricOptions): Metricdef metric_source_packet_loss_percent(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSourcePacketLossPercent(MetricOptions props)public Metric MetricSourcePacketLossPercent(MetricOptions? props = null)func MetricSourcePacketLossPercent(Props MetricOptions) Metric#

Metric for the percentage of packets lost during transit, even if they were recovered.

metricSourceRoundTripTime(props?: MetricOptions): Metricdef metric_source_round_trip_time(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSourceRoundTripTime(MetricOptions props)public Metric MetricSourceRoundTripTime(MetricOptions? props = null)func MetricSourceRoundTripTime(Props MetricOptions) Metric#

Metric for the round-trip time between the source and MediaConnect.

Applies only to RIST, Zixi, and SRT sources.

metricSourceSelected(props?: MetricOptions): Metricdef metric_source_selected(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSourceSelected(MetricOptions props)public Metric MetricSourceSelected(MetricOptions? props = null)func MetricSourceSelected(Props MetricOptions) Metric#

Metric indicating which source is selected for ingest when using `Failover` failover mode.

metricSourceTotalPackets(props?: MetricOptions): Metricdef metric_source_total_packets(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSourceTotalPackets(MetricOptions props)public Metric MetricSourceTotalPackets(MetricOptions? props = null)func MetricSourceTotalPackets(Props MetricOptions) Metric#

Metric for the total number of packets received by the flow source.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining