Interface IGateway

(experimental) Interface for Gateway.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Stack

IGatewayRef.GatewayRef

IEnvironmentAware.Env

Namespace: Amazon.CDK.AWS.MediaConnect.Alpha

Assembly: Amazon.CDK.AWS.MediaConnect.Alpha.dll

Syntax (csharp)

public interface IGateway : IResource, IGatewayRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Interface IGateway Inherits IResource, IGatewayRef, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

Synopsis

Properties

GatewayArn	(experimental) The Amazon Resource Name (ARN) of the gateway.
GatewayState	(experimental) The current state of the gateway.

Methods

Metric(string, IMetricOptions?)	(experimental) Create a CloudWatch metric for this gateway.
MetricEgressBridgeDroppedPackets(IMetricOptions?)	(experimental) Metric for the number of packets dropped by egress bridges hosted on this gateway.
MetricEgressBridgeTotalPackets(IMetricOptions?)	(experimental) Metric for the total number of packets sent from egress bridges hosted on this gateway.
MetricIngressBridgeDroppedPackets(IMetricOptions?)	(experimental) Metric for the number of packets dropped by ingress bridges hosted on this gateway.
MetricIngressBridgeTotalPackets(IMetricOptions?)	(experimental) Metric for the total number of packets received by ingress bridges hosted on this gateway.

Properties

GatewayArn

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

string GatewayArn { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

GatewayState

(experimental) The current state of the gateway.

string? GatewayState { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

Methods

Metric(string, IMetricOptions?)

(experimental) Create a CloudWatch metric for this gateway.

Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

metricName string

props IMetricOptions

Returns

Metric

Remarks

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

Stability: Experimental

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

MetricEgressBridgeDroppedPackets(IMetricOptions?)

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

Metric MetricEgressBridgeDroppedPackets(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Pair with {@link metricEgressBridgeTotalPackets} to chart a dropped-packet percentage. For per-bridge data, pass dimensionsMap: { BridgeSourceName: '...' }.

Default: - sum over 60 seconds

Stability: Experimental

MetricEgressBridgeTotalPackets(IMetricOptions?)

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

Metric MetricEgressBridgeTotalPackets(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Pair with {@link metricEgressBridgeDroppedPackets} to chart an egress dropped-packet percentage. For per-bridge data, pass dimensionsMap: { BridgeSourceName: '...' }.

Default: - sum over 60 seconds

Stability: Experimental

MetricIngressBridgeDroppedPackets(IMetricOptions?)

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

Metric MetricIngressBridgeDroppedPackets(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Pair with {@link metricIngressBridgeTotalPackets} to chart a dropped-packet percentage. For per-bridge data, pass dimensionsMap: { BridgeSourceName: '...' }.

Default: - sum over 60 seconds

Stability: Experimental

MetricIngressBridgeTotalPackets(IMetricOptions?)

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

Metric MetricIngressBridgeTotalPackets(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Pair with {@link metricIngressBridgeDroppedPackets} to chart an ingress dropped-packet percentage. For per-bridge data, pass dimensionsMap: { BridgeSourceName: '...' }.

Default: - sum over 60 seconds

Stability: Experimental