Class Channel

(experimental) Defines an AWS Elemental MediaPackage V2 Channel.

Inheritance

object

Resource

Channel

Implements

IChannel

IResource

IChannelRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.With(params IMixin[])

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.MediaPackageV2.Alpha

Assembly: Amazon.CDK.AWS.MediaPackageV2.Alpha.dll

Syntax (csharp)

public class Channel : Resource, IChannel, IResource, IChannelRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class Channel Inherits Resource Implements IChannel, IResource, IChannelRef, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

ExampleMetadata: infused

Examples

Stack stack;

             var group = new ChannelGroup(stack, "MyChannelGroup", new ChannelGroupProps {
                 ChannelGroupName = "my-test-channel-group"
             });

             var channel = new Channel(stack, "MyChannel", new ChannelProps {
                 ChannelGroup = group,
                 ChannelName = "my-testchannel",
                 Input = InputConfiguration.Cmaf()
             });

             var endpoint = new OriginEndpoint(stack, "MyOriginEndpoint", new OriginEndpointProps {
                 Channel = channel,
                 OriginEndpointName = "my-test-endpoint",
                 Segment = Segment.Cmaf(),
                 Manifests = new [] { Manifest.Hls(new HlsManifestConfiguration {
                     ManifestName = "index"
                 }) }
             });

Synopsis

Constructors

Channel(Construct, string, IChannelProps)

(experimental) Defines an AWS Elemental MediaPackage V2 Channel.

Properties

AutoCreatePolicy	(experimental) Indicates if a channel resource policy should automatically created upon the first call to `addToResourcePolicy`.
ChannelArn	(experimental) The Amazon Resource Name (ARN) associated with the resource.
ChannelGroup	(experimental) The channel group this channel belongs to.
ChannelGroupName	(experimental) The name that describes the channel group.
ChannelName	(experimental) The name that describes the channel.
ChannelRef	(experimental) A reference to this Channel resource.
CreatedAt	(experimental) The date and time the channel was created.
Grants	(experimental) Collection of grant methods for this channel.
IngestEndpointUrls	(experimental) The list of ingest endpoints.
ModifiedAt	(experimental) The date and time the channel was modified.
PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.
Policy	(experimental) The resource policy associated with this channel.
Region	(experimental) The AWS region where this channel lives.

Methods

AddOriginEndpoint(string, IOriginEndpointOptions)	(experimental) Add Origin Endpoint for this Channel.
AddToResourcePolicy(PolicyStatement)	(experimental) Configure channel policy.
FromChannelArn(Construct, string, string)	(experimental) Creates a Channel construct that represents an external (imported) Channel from its ARN.
FromChannelAttributes(Construct, string, IChannelAttributes)	(experimental) Creates a Channel construct that represents an external (imported) Channel.
Metric(string, IMetricOptions?)	(experimental) Create a CloudWatch metric.
MetricEgressBytes(IMetricOptions?)	(experimental) Returns Metric for Egress Bytes.
MetricEgressRequestCount(IMetricOptions?)	(experimental) Returns Metric for Egress Request Count.
MetricEgressResponseTime(IMetricOptions?)	(experimental) Returns Metric for Egress Response time.
MetricIngressBytes(IMetricOptions?)	(experimental) Returns Metric for Ingress Bytes.
MetricIngressRequestCount(IMetricOptions?)	(experimental) Returns Metric for Ingress Request Count.
MetricIngressResponseTime(IMetricOptions?)	(experimental) Returns Metric for Ingress response time.

Constructors

Channel(Construct, string, IChannelProps)

(experimental) Defines an AWS Elemental MediaPackage V2 Channel.

public Channel(Construct scope, string id, IChannelProps props)

Parameters

scope Construct
id string
props IChannelProps

Remarks

Stability: Experimental

Properties

AutoCreatePolicy

(experimental) Indicates if a channel resource policy should automatically created upon the first call to addToResourcePolicy.

protected virtual bool AutoCreatePolicy { get; set; }

Property Value

bool

Remarks

Stability: Experimental

ChannelArn

(experimental) The Amazon Resource Name (ARN) associated with the resource.

public virtual string ChannelArn { get; }

Property Value

string

Remarks

Stability: Experimental

ChannelGroup

(experimental) The channel group this channel belongs to.

public virtual IChannelGroup? ChannelGroup { get; }

Property Value

IChannelGroup

Remarks

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

Stability: Experimental

ChannelGroupName

(experimental) The name that describes the channel group.

public virtual string ChannelGroupName { get; }

Property Value

string

Remarks

The name is the primary identifier for the channel group.

Stability: Experimental

ChannelName

(experimental) The name that describes the channel.

public virtual string ChannelName { get; }

Property Value

string

Remarks

The name is the primary identifier for the channel.

Stability: Experimental

ChannelRef

(experimental) A reference to this Channel resource.

public virtual IChannelReference ChannelRef { get; }

Property Value

IChannelReference

Remarks

Stability: Experimental

CreatedAt

(experimental) The date and time the channel was created.

public virtual string? CreatedAt { get; }

Property Value

string

Remarks

Stability: Experimental

Grants

(experimental) Collection of grant methods for this channel.

public virtual ChannelGrants Grants { get; }

Property Value

ChannelGrants

Remarks

Stability: Experimental

IngestEndpointUrls

(experimental) The list of ingest endpoints.

public virtual string[] IngestEndpointUrls { get; }

Property Value

string[]

Remarks

Stability: Experimental

ModifiedAt

(experimental) The date and time the channel was modified.

public virtual string? ModifiedAt { get; }

Property Value

string

Remarks

Stability: Experimental

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Stability: Experimental

Policy

(experimental) The resource policy associated with this channel.

public virtual ChannelPolicy? Policy { get; set; }

Property Value

ChannelPolicy

Remarks

If autoCreatePolicy is true, a ChannelPolicy will be created upon the first call to addToResourcePolicy(s).

Stability: Experimental

Region

(experimental) The AWS region where this channel lives.

public virtual string Region { get; }

Property Value

string

Remarks

Stability: Experimental

Methods

AddOriginEndpoint(string, IOriginEndpointOptions)

(experimental) Add Origin Endpoint for this Channel.

public virtual OriginEndpoint AddOriginEndpoint(string id, IOriginEndpointOptions options)

Parameters

id string
options IOriginEndpointOptions

Returns

OriginEndpoint

Remarks

Stability: Experimental

AddToResourcePolicy(PolicyStatement)

(experimental) Configure channel policy.

public virtual IAddToResourcePolicyResult AddToResourcePolicy(PolicyStatement statement)

Parameters

statement PolicyStatement

Returns

IAddToResourcePolicyResult

Remarks

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

Stability: Experimental

FromChannelArn(Construct, string, string)

(experimental) Creates a Channel construct that represents an external (imported) Channel from its ARN.

public static IChannel FromChannelArn(Construct scope, string id, string channelArn)

Parameters

scope Construct
id string
channelArn string

Returns

IChannel

Remarks

The ARN is expected to be in the format: arn:<partition>:mediapackagev2:<region>:<account>:channelGroup/<groupName>/channel/<channelName>

Stability: Experimental

FromChannelAttributes(Construct, string, IChannelAttributes)

(experimental) Creates a Channel construct that represents an external (imported) Channel.

public static IChannel FromChannelAttributes(Construct scope, string id, IChannelAttributes attrs)

Parameters

scope Construct
id string
attrs IChannelAttributes

Returns

IChannel

Remarks

Stability: Experimental

Metric(string, IMetricOptions?)

(experimental) Create a CloudWatch metric.

public virtual Metric Metric(string metricName, IMetricOptions? options = null)

Parameters

metricName string: name of the metric.
options IMetricOptions: metric options.

Returns

Metric

Remarks

Stability: Experimental

MetricEgressBytes(IMetricOptions?)

(experimental) Returns Metric for Egress Bytes.

public virtual Metric MetricEgressBytes(IMetricOptions? options = null)

Parameters

options IMetricOptions

Returns

Metric

Remarks

Default: - sum over 60 seconds

Stability: Experimental

MetricEgressRequestCount(IMetricOptions?)

(experimental) Returns Metric for Egress Request Count.

public virtual Metric MetricEgressRequestCount(IMetricOptions? options = null)

Parameters

options IMetricOptions

Returns

Metric

Remarks

Default: - sum over 60 seconds

Stability: Experimental

MetricEgressResponseTime(IMetricOptions?)

(experimental) Returns Metric for Egress Response time.

public virtual Metric MetricEgressResponseTime(IMetricOptions? options = null)

Parameters

options IMetricOptions

Returns

Metric

Remarks

Default: - average over 60 seconds

Stability: Experimental

MetricIngressBytes(IMetricOptions?)

(experimental) Returns Metric for Ingress Bytes.

public virtual Metric MetricIngressBytes(IMetricOptions? options = null)

Parameters

options IMetricOptions

Returns

Metric

Remarks

Default: - sum over 60 seconds

Stability: Experimental

MetricIngressRequestCount(IMetricOptions?)

(experimental) Returns Metric for Ingress Request Count.

public virtual Metric MetricIngressRequestCount(IMetricOptions? options = null)

Parameters

options IMetricOptions

Returns

Metric

Remarks

Default: - sum over 60 seconds

Stability: Experimental

MetricIngressResponseTime(IMetricOptions?)

(experimental) Returns Metric for Ingress response time.

public virtual Metric MetricIngressResponseTime(IMetricOptions? options = null)

Parameters

options IMetricOptions

Returns

Metric

Remarks

Default: - average over 60 seconds

Stability: Experimental

Implements

IChannel

IResource

IChannelRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware