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

Interface IGateway.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IGateway, IGatewayRef, IGatewayRef.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IGateway.Jsii$Proxy

Enclosing interface:

IGateway

@Internal
public static interface IGateway.Jsii$Default
extends IGateway, IResource.Jsii$Default, IGatewayRef.Jsii$Default

Internal default implementation for IGateway.

Nested Class Summary

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.mediaconnect.alpha.IGateway

IGateway.Jsii$Default, IGateway.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.mediaconnect.IGatewayRef

IGatewayRef.Jsii$Default, IGatewayRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Method Summary

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

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware.Jsii$Default

getEnv

Methods inherited from interface software.amazon.awscdk.interfaces.mediaconnect.IGatewayRef.Jsii$Default

getGatewayRef

Methods inherited from interface software.amazon.awscdk.IResource.Jsii$Default

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGatewayArn

@Stability(Experimental)
@NotNull
default String getGatewayArn()

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

Specified by:

getGatewayArn in interface IGateway

getGatewayState

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

(experimental) The current state of the gateway.

Specified by:

getGatewayState in interface IGateway

metric

@Stability(Experimental)
@NotNull
default 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).

Specified by:

metric in interface IGateway

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

Specified by:

metric in interface IGateway

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
default 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

Specified by:

metricEgressBridgeDroppedPackets in interface IGateway

Parameters:

props -

metricEgressBridgeDroppedPackets

@Stability(Experimental)
@NotNull
default 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

Specified by:

metricEgressBridgeDroppedPackets in interface IGateway

metricEgressBridgeTotalPackets

@Stability(Experimental)
@NotNull
default 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

Specified by:

metricEgressBridgeTotalPackets in interface IGateway

Parameters:

props -

metricEgressBridgeTotalPackets

@Stability(Experimental)
@NotNull
default 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

Specified by:

metricEgressBridgeTotalPackets in interface IGateway

metricIngressBridgeDroppedPackets

@Stability(Experimental)
@NotNull
default 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

Specified by:

metricIngressBridgeDroppedPackets in interface IGateway

Parameters:

props -

metricIngressBridgeDroppedPackets

@Stability(Experimental)
@NotNull
default 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

Specified by:

metricIngressBridgeDroppedPackets in interface IGateway

metricIngressBridgeTotalPackets

@Stability(Experimental)
@NotNull
default 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

Specified by:

metricIngressBridgeTotalPackets in interface IGateway

Parameters:

props -

metricIngressBridgeTotalPackets

@Stability(Experimental)
@NotNull
default 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

Specified by:

metricIngressBridgeTotalPackets in interface IGateway