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

Interface IChannel

All Superinterfaces:
IChannelRef, software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IChannel.Jsii$Default
All Known Implementing Classes:
Channel, IChannel.Jsii$Proxy
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-02T09:32:03.714Z") @Stability(Experimental) public interface IChannel extends software.amazon.jsii.JsiiSerializable, IResource, IChannelRef
(experimental) Represents a MediaPackage V2 Channel.

  • Method Details

    • getChannelArn

      @Stability(Experimental) @NotNull String getChannelArn()
      (experimental) The Amazon Resource Name (ARN) associated with the resource.

    • getChannelGroupName

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

      The name is the primary identifier for the channel group.

    • getChannelName

      @Stability(Experimental) @NotNull String getChannelName()
      (experimental) The name that describes the channel.

      The name is the primary identifier for the channel.

    • getGrants

      @Stability(Experimental) @NotNull ChannelGrants getGrants()
      (experimental) Grants IAM resource policy to the role used to write to MediaPackage V2 Channel.

    • getIngestEndpointUrls

      @Stability(Experimental) @NotNull List<String> getIngestEndpointUrls()
      (experimental) The ingest endpoint URLs for the channel.

    • getChannelGroup

      @Stability(Experimental) @Nullable default IChannelGroup getChannelGroup()
      (experimental) The channel group this channel belongs to.

      Only available when the channel was created in the same stack. Undefined for imported channels.

    • getCreatedAt

      @Stability(Experimental) @Nullable default String getCreatedAt()
      (experimental) The date and time the channel was created.

    • getModifiedAt

      @Stability(Experimental) @Nullable default String getModifiedAt()
      (experimental) The date and time the channel was modified.

    • addOriginEndpoint

      @Stability(Experimental) @NotNull OriginEndpoint addOriginEndpoint(@NotNull String id, @NotNull OriginEndpointOptions options)
      (experimental) Add Origin Endpoint for this Channel.

      Parameters:
      id - This parameter is required.
      options - This parameter is required.

    • addToResourcePolicy

      @Stability(Experimental) @NotNull AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement statement)
      (experimental) Configure channel policy.

      You can only add 1 ChannelPolicy to a Channel. If you have already defined one, function will append the policy already created.

      Parameters:
      statement - This parameter is required.

    • metric

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

      Parameters:
      metricName - name of the metric. This parameter is required.
      props - metric options.

    • metric

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

      Parameters:
      metricName - name of the metric. This parameter is required.

    • metricEgressBytes

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

      Default: - sum over 60 seconds

      Parameters:
      options -

    • metricEgressBytes

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

      Default: - sum over 60 seconds

    • metricEgressRequestCount

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

      Default: - sum over 60 seconds

      Parameters:
      options -

    • metricEgressRequestCount

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

      Default: - sum over 60 seconds

    • metricEgressResponseTime

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

      Default: - average over 60 seconds

      Parameters:
      options -

    • metricEgressResponseTime

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

      Default: - average over 60 seconds

    • metricIngressBytes

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

      Default: - sum over 60 seconds

      Parameters:
      options -

    • metricIngressBytes

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

      Default: - sum over 60 seconds

    • metricIngressRequestCount

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

      Default: - sum over 60 seconds

      Parameters:
      options -

    • metricIngressRequestCount

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

      Default: - sum over 60 seconds

    • metricIngressResponseTime

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

      Default: - average over 60 seconds

      Parameters:
      options -

    • metricIngressResponseTime

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

      Default: - average over 60 seconds