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

Class Gateway

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.mediaconnect.alpha.Gateway
All Implemented Interfaces:
IEnvironmentAware, IGatewayRef, IResource, IGateway, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-07-31T10:49:55.169Z") @Stability(Experimental) public class Gateway extends Resource implements IGateway
(experimental) AWS Elemental MediaConnect Gateway is a feature of MediaConnect that allows the deployment of on-premises resources for transporting live video to and from the AWS Cloud.

MediaConnect Gateway allows you to contribute live video to the AWS Cloud from on-premises hardware, as well as distribute live video from the AWS Cloud to your local data center.

Example: 

 Stack stack;
 GatewayNetwork productionNetwork = GatewayNetwork.define(GatewayNetworkDefineProps.builder()
         .cidrBlock("192.168.1.0/24")
         .name("production-network")
         .build());
 Gateway gateway = Gateway.Builder.create(stack, "MyGateway")
         .gatewayName("my-gateway")
         .egressCidrBlocks(List.of("10.0.0.0/16"))
         .networks(List.of(productionNetwork))
         .build();

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Experimental) public static final String PROPERTY_INJECTION_ID
      (experimental) Uniquely identifies this class.

  • Constructor Details

    • Gateway

      protected Gateway(software.amazon.jsii.JsiiObjectRef objRef)

    • Gateway

      protected Gateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • Gateway

      @Stability(Experimental) public Gateway(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull GatewayProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromGatewayArn

      @Stability(Experimental) @NotNull public static IGateway fromGatewayArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String gatewayArn)
      (experimental) Creates a MediaConnect Gateway construct that represents an external (imported) MediaConnect Gateway.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      gatewayArn - This parameter is required.

    • addNetwork

      @Stability(Experimental) @NotNull public GatewayNetwork addNetwork(@NotNull GatewayNetwork network)
      (experimental) Add a network to this gateway.

      Parameters:
      network - This parameter is required.

    • metric

      @Stability(Experimental) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      (experimental) Create a CloudWatch metric for this gateway.

      Specified by:
      metric in interface IGateway
      Parameters:
      metricName - This parameter is required.
      props -
      See Also:

    • metric

      @Stability(Experimental) @NotNull public Metric metric(@NotNull String metricName)
      (experimental) Create a CloudWatch metric for this gateway.

      Specified by:
      metric in interface IGateway
      Parameters:
      metricName - This parameter is required.
      See Also:

    • metricEgressBridgeDroppedPackets

      @Stability(Experimental) @NotNull public Metric metricEgressBridgeDroppedPackets(@Nullable MetricOptions props)
      (experimental) Metric for the number of packets dropped by egress bridges hosted on this gateway.

      Specified by:
      metricEgressBridgeDroppedPackets in interface IGateway
      Parameters:
      props -

    • metricEgressBridgeDroppedPackets

      @Stability(Experimental) @NotNull public Metric metricEgressBridgeDroppedPackets()
      (experimental) Metric for the number of packets dropped by egress bridges hosted on this gateway.
      Specified by:
      metricEgressBridgeDroppedPackets in interface IGateway

    • metricEgressBridgeTotalPackets

      @Stability(Experimental) @NotNull public Metric metricEgressBridgeTotalPackets(@Nullable MetricOptions props)
      (experimental) Metric for the total number of packets sent from egress bridges hosted on this gateway.

      Specified by:
      metricEgressBridgeTotalPackets in interface IGateway
      Parameters:
      props -

    • metricEgressBridgeTotalPackets

      @Stability(Experimental) @NotNull public Metric metricEgressBridgeTotalPackets()
      (experimental) Metric for the total number of packets sent from egress bridges hosted on this gateway.
      Specified by:
      metricEgressBridgeTotalPackets in interface IGateway

    • metricIngressBridgeDroppedPackets

      @Stability(Experimental) @NotNull public Metric metricIngressBridgeDroppedPackets(@Nullable MetricOptions props)
      (experimental) Metric for the number of packets dropped by ingress bridges hosted on this gateway.

      Specified by:
      metricIngressBridgeDroppedPackets in interface IGateway
      Parameters:
      props -

    • metricIngressBridgeDroppedPackets

      @Stability(Experimental) @NotNull public Metric metricIngressBridgeDroppedPackets()
      (experimental) Metric for the number of packets dropped by ingress bridges hosted on this gateway.
      Specified by:
      metricIngressBridgeDroppedPackets in interface IGateway

    • metricIngressBridgeTotalPackets

      @Stability(Experimental) @NotNull public Metric metricIngressBridgeTotalPackets(@Nullable MetricOptions props)
      (experimental) Metric for the total number of packets received by ingress bridges hosted on this gateway.

      Specified by:
      metricIngressBridgeTotalPackets in interface IGateway
      Parameters:
      props -

    • metricIngressBridgeTotalPackets

      @Stability(Experimental) @NotNull public Metric metricIngressBridgeTotalPackets()
      (experimental) Metric for the total number of packets received by ingress bridges hosted on this gateway.
      Specified by:
      metricIngressBridgeTotalPackets in interface IGateway

    • getGatewayArn

      @Stability(Experimental) @NotNull public String getGatewayArn()
      (experimental) The Amazon Resource Name (ARN) of the gateway.
      Specified by:
      getGatewayArn in interface IGateway

    • getGatewayRef

      @Stability(Experimental) @NotNull public GatewayReference getGatewayRef()
      (experimental) A reference to a Gateway resource.
      Specified by:
      getGatewayRef in interface IGatewayRef

    • getGatewayState

      @Stability(Experimental) @Nullable public String getGatewayState()
      (experimental) The current state of the gateway.
      Specified by:
      getGatewayState in interface IGateway