interface IBridge 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MediaConnect.Alpha.IBridge
Go	github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2#IBridge
Java	software.amazon.awscdk.services.mediaconnect.alpha.IBridge
Python	aws_cdk.aws_mediaconnect_alpha.IBridge
TypeScript (source)	@aws-cdk/aws-mediaconnect-alpha » IBridge

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IBridgeRef

Implemented by Bridge

Obtainable from Bridge.fromBridgeArn(), Bridge.fromBridgeAttributes()

Interface for Bridge.

Properties

Name	Type	Description
bridgeArn🔹	string	The Amazon Resource Name (ARN) of the bridge.
bridgeName🔹	string	The name of the bridge.
bridgeRef🔹	BridgeReference	A reference to a Bridge resource.
bridgeType🔹	BridgeType	The type of bridge (ingress or egress).
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
bridgeState?🔹	string	The current state of the bridge.
isFailoverEnabled?🔹	boolean	Failover Configuration for Bridge.

---

bridgeArn🔹

Type: string

The Amazon Resource Name (ARN) of the bridge.

---

bridgeName🔹

Type: string

The name of the bridge.

---

bridgeRef🔹

Type: BridgeReference

A reference to a Bridge resource.

---

bridgeType🔹

Type: BridgeType

The type of bridge (ingress or egress).

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

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.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

bridgeState?🔹

Type: string (optional)

The current state of the bridge.

---

isFailoverEnabled?🔹

Type: boolean (optional)

Failover Configuration for Bridge.

Methods

Name	Description
addOutput(id, networkOutput)🔹	Add a network output to this bridge (for egress bridges only).
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
metric(metricName, props?)🔹	Create a CloudWatch metric for this bridge.
metricFailoverSwitches(props?)🔹	Metric for the total number of times the bridge switches between sources when using the FAILOVER failover mode.
metricSourceBitrate(bridgeSourceName, props?)🔹	Metric for the bitrate of a specific bridge source.
metricSourcePacketLossPercent(bridgeSourceName, props?)🔹	Metric for the percentage of packets lost on a specific bridge source.
with(...mixins)🔹	Applies one or more mixins to this construct.

---

addOutput(id, networkOutput)🔹

public addOutput(id: string, networkOutput: BridgeNetworkOutput): IBridgeOutput

Parameters

• id string — Construct id for the new BridgeOutput.
• networkOutput BridgeNetworkOutput — The named output to add.

Returns

• IBridgeOutput

Add a network output to this bridge (for egress bridges only).

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

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, props?)🔹

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Create a CloudWatch metric for this bridge.

Bridge metrics are dimensioned by BridgeARN. See the MediaConnect documentation for available metric names (e.g. IngressBridgeBitRate, EgressBridgeBitRate, IngressBridgePacketLossPercent).

---

metricFailoverSwitches(props?)🔹

public metricFailoverSwitches(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the total number of times the bridge switches between sources when using the FAILOVER failover mode.

Uses IngressBridgeFailoverSwitches for ingress bridges and EgressBridgeFailoverSwitches for egress bridges.

---

metricSourceBitrate(bridgeSourceName, props?)🔹

public metricSourceBitrate(bridgeSourceName: string, props?: MetricOptions): Metric

Parameters

• bridgeSourceName string — The name of the bridge source.
• props MetricOptions

Returns

• Metric

Metric for the bitrate of a specific bridge source.

Uses IngressBridgeSourceBitRate for ingress bridges and EgressBridgeSourceBitRate for egress bridges.

---

metricSourcePacketLossPercent(bridgeSourceName, props?)🔹

public metricSourcePacketLossPercent(bridgeSourceName: string, props?: MetricOptions): Metric

Parameters

• bridgeSourceName string — The name of the bridge source.
• props MetricOptions

Returns

• Metric

Metric for the percentage of packets lost on a specific bridge source.

Uses IngressBridgeSourcePacketLossPercent for ingress bridges and EgressBridgeSourcePacketLossPercent for egress bridges.

---

with(...mixins)🔹

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• 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.