Package software.amazon.awscdk.services.mediaconnect.alpha

Interface IGateway

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IGatewayRef, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IGateway.Jsii$Default

All Known Implementing Classes:

Gateway, IGateway.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-31T10:49:55.175Z")
@Stability(Experimental)
public interface IGateway
extends software.amazon.jsii.JsiiSerializable, IResource, IGatewayRef

(experimental) Interface for Gateway.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IGateway.Jsii$Default	Internal default implementation for IGateway.
static final class	IGateway.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getGatewayArn()	(experimental) The Amazon Resource Name (ARN) of the gateway.
default String	getGatewayState()	(experimental) The current state of the gateway.
Metric	metric(String metricName)	(experimental) Create a CloudWatch metric for this gateway.
Metric	metric(String metricName, MetricOptions props)	(experimental) Create a CloudWatch metric for this gateway.
Metric	metricEgressBridgeDroppedPackets()	(experimental) Metric for the number of packets dropped by egress bridges hosted on this gateway.
Metric	metricEgressBridgeDroppedPackets(MetricOptions props)	(experimental) Metric for the number of packets dropped by egress bridges hosted on this gateway.
Metric	metricEgressBridgeTotalPackets()	(experimental) Metric for the total number of packets sent from egress bridges hosted on this gateway.
Metric	metricEgressBridgeTotalPackets(MetricOptions props)	(experimental) Metric for the total number of packets sent from egress bridges hosted on this gateway.
Metric	metricIngressBridgeDroppedPackets()	(experimental) Metric for the number of packets dropped by ingress bridges hosted on this gateway.
Metric	metricIngressBridgeDroppedPackets(MetricOptions props)	(experimental) Metric for the number of packets dropped by ingress bridges hosted on this gateway.
Metric	metricIngressBridgeTotalPackets()	(experimental) Metric for the total number of packets received by ingress bridges hosted on this gateway.
Metric	metricIngressBridgeTotalPackets(MetricOptions props)	(experimental) Metric for the total number of packets received by ingress bridges hosted on this gateway.

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.interfaces.mediaconnect.IGatewayRef

getGatewayRef

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGatewayArn

@Stability(Experimental)
@NotNull
String getGatewayArn()

(experimental) The Amazon Resource Name (ARN) of the gateway.

getGatewayState

@Stability(Experimental)
@Nullable
default String getGatewayState()

(experimental) The current state of the gateway.

metric

@Stability(Experimental)
@NotNull
Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

(experimental) Create a CloudWatch metric for this gateway.

The gateway ARN is set as the GatewayARN dimension automatically. For metrics that require additional dimensions (such as NetworkName, InstanceId for a specific appliance, or BridgeSourceName), pass them via props.dimensionsMap.

See the MediaConnect documentation for available metric names (for example IngressBridgeBitRate, EgressBridgeBitRate, IngressBridgeSourcePacketLossPercent).

Parameters:

metricName - This parameter is required.

props -

See Also:

• https://docs.aws.amazon.com/mediaconnect/latest/ug/monitor-with-cloudwatch-metrics-gateway-health.html

metric

@Stability(Experimental)
@NotNull
Metric metric(@NotNull
 String metricName)

(experimental) Create a CloudWatch metric for this gateway.

The gateway ARN is set as the GatewayARN dimension automatically. For metrics that require additional dimensions (such as NetworkName, InstanceId for a specific appliance, or BridgeSourceName), pass them via props.dimensionsMap.

See the MediaConnect documentation for available metric names (for example IngressBridgeBitRate, EgressBridgeBitRate, IngressBridgeSourcePacketLossPercent).

Parameters:

metricName - This parameter is required.

See Also:

• https://docs.aws.amazon.com/mediaconnect/latest/ug/monitor-with-cloudwatch-metrics-gateway-health.html

metricEgressBridgeDroppedPackets

@Stability(Experimental)
@NotNull
Metric metricEgressBridgeDroppedPackets(@Nullable
 MetricOptions props)

(experimental) Metric for the number of packets dropped by egress bridges hosted on this gateway.

Pair with metricEgressBridgeTotalPackets(software.amazon.awscdk.services.cloudwatch.MetricOptions) to chart a dropped-packet percentage. For per-bridge data, pass `dimensionsMap: { BridgeSourceName: '...' }`.

Default: - sum over 60 seconds

Parameters:

props -

metricEgressBridgeDroppedPackets

@Stability(Experimental)
@NotNull
Metric metricEgressBridgeDroppedPackets()

(experimental) Metric for the number of packets dropped by egress bridges hosted on this gateway.

Pair with metricEgressBridgeTotalPackets(software.amazon.awscdk.services.cloudwatch.MetricOptions) to chart a dropped-packet percentage. For per-bridge data, pass `dimensionsMap: { BridgeSourceName: '...' }`.

Default: - sum over 60 seconds

metricEgressBridgeTotalPackets

@Stability(Experimental)
@NotNull
Metric metricEgressBridgeTotalPackets(@Nullable
 MetricOptions props)

(experimental) Metric for the total number of packets sent from egress bridges hosted on this gateway.

Pair with metricEgressBridgeDroppedPackets(software.amazon.awscdk.services.cloudwatch.MetricOptions) to chart an egress dropped-packet percentage. For per-bridge data, pass `dimensionsMap: { BridgeSourceName: '...' }`.

Default: - sum over 60 seconds

Parameters:

props -

metricEgressBridgeTotalPackets

@Stability(Experimental)
@NotNull
Metric metricEgressBridgeTotalPackets()

(experimental) Metric for the total number of packets sent from egress bridges hosted on this gateway.

Pair with metricEgressBridgeDroppedPackets(software.amazon.awscdk.services.cloudwatch.MetricOptions) to chart an egress dropped-packet percentage. For per-bridge data, pass `dimensionsMap: { BridgeSourceName: '...' }`.

Default: - sum over 60 seconds

metricIngressBridgeDroppedPackets

@Stability(Experimental)
@NotNull
Metric metricIngressBridgeDroppedPackets(@Nullable
 MetricOptions props)

(experimental) Metric for the number of packets dropped by ingress bridges hosted on this gateway.

Pair with metricIngressBridgeTotalPackets(software.amazon.awscdk.services.cloudwatch.MetricOptions) to chart a dropped-packet percentage. For per-bridge data, pass `dimensionsMap: { BridgeSourceName: '...' }`.

Default: - sum over 60 seconds

Parameters:

props -

metricIngressBridgeDroppedPackets

@Stability(Experimental)
@NotNull
Metric metricIngressBridgeDroppedPackets()

(experimental) Metric for the number of packets dropped by ingress bridges hosted on this gateway.

Pair with metricIngressBridgeTotalPackets(software.amazon.awscdk.services.cloudwatch.MetricOptions) to chart a dropped-packet percentage. For per-bridge data, pass `dimensionsMap: { BridgeSourceName: '...' }`.

Default: - sum over 60 seconds

metricIngressBridgeTotalPackets

@Stability(Experimental)
@NotNull
Metric metricIngressBridgeTotalPackets(@Nullable
 MetricOptions props)

(experimental) Metric for the total number of packets received by ingress bridges hosted on this gateway.

Pair with metricIngressBridgeDroppedPackets(software.amazon.awscdk.services.cloudwatch.MetricOptions) to chart an ingress dropped-packet percentage. For per-bridge data, pass `dimensionsMap: { BridgeSourceName: '...' }`.

Default: - sum over 60 seconds

Parameters:

props -

metricIngressBridgeTotalPackets

@Stability(Experimental)
@NotNull
Metric metricIngressBridgeTotalPackets()

(experimental) Metric for the total number of packets received by ingress bridges hosted on this gateway.

Pair with metricIngressBridgeDroppedPackets(software.amazon.awscdk.services.cloudwatch.MetricOptions) to chart an ingress dropped-packet percentage. For per-bridge data, pass `dimensionsMap: { BridgeSourceName: '...' }`.

Default: - sum over 60 seconds