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

Experimental

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

IBridge Interface

Interface for Bridge.

IBridge

extends

• IResource,
• IBridgeRef

implemented by

• Bridge

Stability

Experimental

Source

lib/bridge.ts

Properties

bridgeArnstringbridge_arnstrbridgeArnStringBridgeArnstringBridgeArn*string#

The Amazon Resource Name (ARN) of the bridge.

bridgeNamestringbridge_namestrbridgeNameStringBridgeNamestringBridgeName*string#

The name of the bridge.

bridgeRefBridgeReferencebridge_refBridgeReferencebridgeRefBridgeReferenceBridgeRefBridgeReferenceBridgeRefBridgeReference#

A reference to a Bridge resource.

bridgeState?may be undefinedstringbridge_state?may be undefinedstrbridgeState?may be undefinedStringBridgeState?may be undefinedstringBridgeState?may be undefined*string#

The current state of the bridge.

bridgeTypeBridgeTypebridge_typeBridgeTypebridgeTypeBridgeTypeBridgeTypeBridgeTypeBridgeTypeBridgeType#

The type of bridge (ingress or egress).

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.

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

Failover Configuration for Bridge.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

addOutput(id: string, networkOutput: BridgeNetworkOutput): IBridgeOutputdef add_output(self, id: str, network_output: BridgeNetworkOutput) -> IBridgeOutputpublic IBridgeOutput addOutput(String id, BridgeNetworkOutput networkOutput)public IBridgeOutput AddOutput(string id, BridgeNetworkOutput networkOutput)func AddOutput(Id *string, NetworkOutput BridgeNetworkOutput) IBridgeOutput#

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

2 parameters

Parameters

• ididididId — Construct id for the new BridgeOutput.
• networkOutputnetwork_outputnetworkOutputnetworkOutputNetworkOutput — The named output to add.

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

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

metricFailoverSwitches(props?: MetricOptions): Metricdef metric_failover_switches(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricFailoverSwitches(MetricOptions props)public Metric MetricFailoverSwitches(MetricOptions? props = null)func MetricFailoverSwitches(Props MetricOptions) 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: string, props?: MetricOptions): Metricdef metric_source_bitrate(self, bridge_source_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSourceBitrate(String bridgeSourceName, MetricOptions props)public Metric MetricSourceBitrate(string bridgeSourceName, MetricOptions? props = null)func MetricSourceBitrate(BridgeSourceName *string, Props MetricOptions) Metric#

Metric for the bitrate of a specific bridge source.

Uses IngressBridgeSourceBitRate for ingress bridges and EgressBridgeSourceBitRate for egress bridges.

1 parameter

Parameters

• bridgeSourceNamebridge_source_namebridgeSourceNamebridgeSourceNameBridgeSourceName — The name of the bridge source.

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

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

Uses IngressBridgeSourcePacketLossPercent for ingress bridges and EgressBridgeSourcePacketLossPercent for egress bridges.

1 parameter

Parameters

• bridgeSourceNamebridge_source_namebridgeSourceNamebridgeSourceNameBridgeSourceName — The name of the bridge 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