class Bridge (construct) 🔹

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

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IBridge, IBridgeRef

Defines a AWS Elemental MediaConnect Bridge.

Example

declare const stack: Stack;

const productionNetwork = GatewayNetwork.define({
  cidrBlock: '192.168.1.0/24',
  name: 'production-network',
});

const gateway = new Gateway(stack, 'MyGateway', {
  gatewayName: 'my-gateway',
  egressCidrBlocks: ['10.0.0.0/16'],
  networks: [productionNetwork],
});

const ingressBridge = new Bridge(stack, 'MyIngressBridge', {
  bridgeName: 'my-ingress-bridge',
  config: BridgeConfiguration.ingress({
    maxBitrate: Bitrate.mbps(10),
    maxOutputs: 2,
    networkSources: [{
      name: 'on-prem-source',
      source: {
        protocol: BridgeProtocol.RTP,
        network: productionNetwork,
        multicastIp: '239.1.1.1',
        port: 5000,
      },
    }],
  }),
  gateway: gateway,
});

Initializer

new Bridge(scope: Construct, id: string, props: BridgeProps)

Parameters

• scope Construct
• id string
• props BridgeProps

Construct Props

Name	Type	Description
config🔹	BridgeConfiguration	The bridge configuration specifying ingress or egress settings.
gateway🔹	IGateway	The gateway that the bridge is associated with.
bridgeName?🔹	string	The name of the bridge.
sourceFailoverConfig?🔹	BridgeFailoverConfig	The source failover configuration for the bridge.

---

config🔹

Type: BridgeConfiguration

The bridge configuration specifying ingress or egress settings.

---

gateway🔹

Type: IGateway

The gateway that the bridge is associated with.

---

bridgeName?🔹

Type: string (optional, default: autogenerated)

The name of the bridge.

Cannot be modified after the bridge is created.

---

sourceFailoverConfig?🔹

Type: BridgeFailoverConfig (optional, default: No failover configuration)

The source failover configuration for the 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 this 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.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

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

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
addOutput(id, networkOutput)🔹	Add a network output to this bridge (for egress bridges only).
applyCrossStackReferenceStrength(strength)🔹	Override the cross-stack reference strength for this resource.
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.
toString()🔹	Returns a string representation of this construct.
with(...mixins)🔹	Applies one or more mixins to this construct.
static fromBridgeArn(scope, id, bridgeArn)🔹	Import an existing Bridge from its ARN.
static fromBridgeAttributes(scope, id, attrs)🔹	Creates a Bridge construct that represents an external (imported) Bridge.

---

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

---

applyCrossStackReferenceStrength(strength)🔹

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

• strength ReferenceStrength — - The reference strength to use for this resource.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

---

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.

---

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.

---

metricSourceBitrate(bridgeSourceName, props?)🔹

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

Parameters

• bridgeSourceName string
• props MetricOptions

Returns

• Metric

Metric for the bitrate of a specific bridge source.

---

metricSourcePacketLossPercent(bridgeSourceName, props?)🔹

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

Parameters

• bridgeSourceName string
• props MetricOptions

Returns

• Metric

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

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)🔹

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

Parameters

• mixins IMixin

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. Use multiple with() calls if subsequent mixins should apply to added constructs.

---

static fromBridgeArn(scope, id, bridgeArn)🔹

public static fromBridgeArn(scope: Construct, id: string, bridgeArn: string): IBridge

Parameters

• scope Construct
• id string
• bridgeArn string

Returns

• IBridge

Import an existing Bridge from its ARN.

Use fromBridgeAttributes() instead if you need access to bridgeName, bridgeType (required for addOutput()), or isFailoverEnabled.

---

static fromBridgeAttributes(scope, id, attrs)🔹

public static fromBridgeAttributes(scope: Construct, id: string, attrs: BridgeAttributes): IBridge

Parameters

• scope Construct
• id string
• attrs BridgeAttributes

Returns

• IBridge

Creates a Bridge construct that represents an external (imported) Bridge.