interface IGateway 🔹

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

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IGatewayRef

Implemented by Gateway

Obtainable from Gateway.fromGatewayArn()

Interface for Gateway.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
gatewayArn🔹	string	The Amazon Resource Name (ARN) of the gateway.
gatewayRef🔹	GatewayReference	A reference to a Gateway resource.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
gatewayState?🔹	string	The current state of the gateway.

---

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.

---

gatewayArn🔹

Type: string

The Amazon Resource Name (ARN) of the gateway.

---

gatewayRef🔹

Type: GatewayReference

A reference to a Gateway resource.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

gatewayState?🔹

Type: string (optional)

The current state of the gateway.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
metric(metricName, props?)🔹	Create a CloudWatch metric for this gateway.
metricEgressBridgeDroppedPackets(props?)🔹	Metric for the number of packets dropped by egress bridges hosted on this gateway.
metricEgressBridgeTotalPackets(props?)🔹	Metric for the total number of packets sent from egress bridges hosted on this gateway.
metricIngressBridgeDroppedPackets(props?)🔹	Metric for the number of packets dropped by ingress bridges hosted on this gateway.
metricIngressBridgeTotalPackets(props?)🔹	Metric for the total number of packets received by ingress bridges hosted on this gateway.
with(...mixins)🔹	Applies one or more mixins to this construct.

---

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

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

---

metricEgressBridgeDroppedPackets(props?)🔹

public metricEgressBridgeDroppedPackets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

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

---

metricEgressBridgeTotalPackets(props?)🔹

public metricEgressBridgeTotalPackets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

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

---

metricIngressBridgeDroppedPackets(props?)🔹

public metricIngressBridgeDroppedPackets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

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

---

metricIngressBridgeTotalPackets(props?)🔹

public metricIngressBridgeTotalPackets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

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

---

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.