Package software.amazon.awscdk.services.mediapackagev2.alpha

Class ChannelGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.mediapackagev2.alpha.ChannelGroup
All Implemented Interfaces:
IEnvironmentAware, IChannelGroupRef, IResource, IChannelGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-02T09:32:03.690Z") @Stability(Experimental) public class ChannelGroup extends Resource implements IChannelGroup
(experimental) Defines an AWS Elemental MediaPackage V2 Channel Group.

Example: 

 Stack stack;
 // Create a channel group
 ChannelGroup group = ChannelGroup.Builder.create(stack, "MyChannelGroup")
         .channelGroupName("my-channel-group")
         .build();
 // Add a channel using the factory method
 Channel channel = group.addChannel("MyChannel", ChannelOptions.builder()
         .channelName("my-channel")
         .input(InputConfiguration.cmaf())
         .build());
 // Add an origin endpoint using the factory method
 OriginEndpoint endpoint = channel.addOriginEndpoint("MyEndpoint", OriginEndpointOptions.builder()
         .originEndpointName("my-endpoint")
         .segment(Segment.cmaf())
         .manifests(List.of(Manifest.hls(HlsManifestConfiguration.builder().manifestName("index").build())))
         .build());

  • Field Details

    • PROPERTY_INJECTION_ID

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

  • Constructor Details

    • ChannelGroup

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

    • ChannelGroup

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

    • ChannelGroup

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

    • ChannelGroup

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

  • Method Details

    • fromChannelGroupAttributes

      @Stability(Experimental) @NotNull public static IChannelGroup fromChannelGroupAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ChannelGroupAttributes attrs)
      (experimental) Creates a Channel Group construct that represents an external (imported) Channel Group.

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

    • addChannel

      @Stability(Experimental) @NotNull public Channel addChannel(@NotNull String id, @Nullable ChannelOptions options)
      (experimental) Add Channel for this Channel Group.

      Specified by:
      addChannel in interface IChannelGroup
      Parameters:
      id - This parameter is required.
      options -

    • addChannel

      @Stability(Experimental) @NotNull public Channel addChannel(@NotNull String id)
      (experimental) Add Channel for this Channel Group.

      Specified by:
      addChannel in interface IChannelGroup
      Parameters:
      id - This parameter is required.

    • metric

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

      Specified by:
      metric in interface IChannelGroup
      Parameters:
      metricName - name of the metric. This parameter is required.
      props - metric options.

    • metric

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

      Specified by:
      metric in interface IChannelGroup
      Parameters:
      metricName - name of the metric. This parameter is required.

    • metricEgressBytes

      @Stability(Experimental) @NotNull public Metric metricEgressBytes(@Nullable MetricOptions props)
      (experimental) Returns Metric for Egress Bytes.

      Default: - sum over 60 seconds

      Specified by:
      metricEgressBytes in interface IChannelGroup
      Parameters:
      props -

    • metricEgressBytes

      @Stability(Experimental) @NotNull public Metric metricEgressBytes()
      (experimental) Returns Metric for Egress Bytes.

      Default: - sum over 60 seconds

      Specified by:
      metricEgressBytes in interface IChannelGroup

    • metricEgressRequestCount

      @Stability(Experimental) @NotNull public Metric metricEgressRequestCount(@Nullable MetricOptions props)
      (experimental) Returns Metric for Egress Request Count.

      Default: - sum over 60 seconds

      Specified by:
      metricEgressRequestCount in interface IChannelGroup
      Parameters:
      props -

    • metricEgressRequestCount

      @Stability(Experimental) @NotNull public Metric metricEgressRequestCount()
      (experimental) Returns Metric for Egress Request Count.

      Default: - sum over 60 seconds

      Specified by:
      metricEgressRequestCount in interface IChannelGroup

    • metricEgressResponseTime

      @Stability(Experimental) @NotNull public Metric metricEgressResponseTime(@Nullable MetricOptions props)
      (experimental) Returns Metric for Egress Response time.

      Default: - average over 60 seconds

      Specified by:
      metricEgressResponseTime in interface IChannelGroup
      Parameters:
      props -

    • metricEgressResponseTime

      @Stability(Experimental) @NotNull public Metric metricEgressResponseTime()
      (experimental) Returns Metric for Egress Response time.

      Default: - average over 60 seconds

      Specified by:
      metricEgressResponseTime in interface IChannelGroup

    • metricIngressBytes

      @Stability(Experimental) @NotNull public Metric metricIngressBytes(@Nullable MetricOptions props)
      (experimental) Returns Metric for Ingress Bytes.

      Default: - sum over 60 seconds

      Specified by:
      metricIngressBytes in interface IChannelGroup
      Parameters:
      props -

    • metricIngressBytes

      @Stability(Experimental) @NotNull public Metric metricIngressBytes()
      (experimental) Returns Metric for Ingress Bytes.

      Default: - sum over 60 seconds

      Specified by:
      metricIngressBytes in interface IChannelGroup

    • metricIngressRequestCount

      @Stability(Experimental) @NotNull public Metric metricIngressRequestCount(@Nullable MetricOptions props)
      (experimental) Returns Metric for Ingress Request Count.

      Default: - sum over 60 seconds

      Specified by:
      metricIngressRequestCount in interface IChannelGroup
      Parameters:
      props -

    • metricIngressRequestCount

      @Stability(Experimental) @NotNull public Metric metricIngressRequestCount()
      (experimental) Returns Metric for Ingress Request Count.

      Default: - sum over 60 seconds

      Specified by:
      metricIngressRequestCount in interface IChannelGroup

    • metricIngressResponseTime

      @Stability(Experimental) @NotNull public Metric metricIngressResponseTime(@Nullable MetricOptions props)
      (experimental) Returns Metric for Ingress response time.

      Default: - average over 60 seconds

      Specified by:
      metricIngressResponseTime in interface IChannelGroup
      Parameters:
      props -

    • metricIngressResponseTime

      @Stability(Experimental) @NotNull public Metric metricIngressResponseTime()
      (experimental) Returns Metric for Ingress response time.

      Default: - average over 60 seconds

      Specified by:
      metricIngressResponseTime in interface IChannelGroup

    • getChannelGroupArn

      @Stability(Experimental) @NotNull public String getChannelGroupArn()
      (experimental) The Amazon Resource Name (ARN) associated with the resource.
      Specified by:
      getChannelGroupArn in interface IChannelGroup

    • getChannelGroupName

      @Stability(Experimental) @NotNull public String getChannelGroupName()
      (experimental) The name that describes the channel group.

      The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      Specified by:
      getChannelGroupName in interface IChannelGroup

    • getChannelGroupRef

      @Stability(Experimental) @NotNull public ChannelGroupReference getChannelGroupRef()
      (experimental) A reference to this Channel Group resource.

      Required by the auto-generated IChannelGroupRef interface.

      Specified by:
      getChannelGroupRef in interface IChannelGroupRef

    • getEgressDomain

      @Stability(Experimental) @NotNull public String getEgressDomain()
      (experimental) The egress domain where packaged content is available.

      Use this as the origin domain when configuring a CDN such as Amazon CloudFront.

      Specified by:
      getEgressDomain in interface IChannelGroup

    • getCreatedAt

      @Stability(Experimental) @Nullable public String getCreatedAt()
      (experimental) The date and time the channel group was created.
      Specified by:
      getCreatedAt in interface IChannelGroup

    • getModifiedAt

      @Stability(Experimental) @Nullable public String getModifiedAt()
      (experimental) The date and time the channel group was modified.
      Specified by:
      getModifiedAt in interface IChannelGroup