Interface IChannel

(experimental) Represents a MediaPackage V2 Channel.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Stack

IChannelRef.ChannelRef

IEnvironmentAware.Env

Namespace: Amazon.CDK.AWS.MediaPackageV2.Alpha

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

Syntax (csharp)

public interface IChannel : IResource, IChannelRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Interface IChannel Inherits IResource, IChannelRef, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

Synopsis

Properties

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.
CreatedAt	(experimental) The date and time the channel was created.
Grants	(experimental) Grants IAM resource policy to the role used to write to MediaPackage V2 Channel.
IngestEndpointUrls	(experimental) The ingest endpoint URLs for the channel.
ModifiedAt	(experimental) The date and time the channel was modified.

Methods

AddOriginEndpoint(string, IOriginEndpointOptions)	(experimental) Add Origin Endpoint for this Channel.
AddToResourcePolicy(PolicyStatement)	(experimental) Configure channel policy.
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.

Properties

ChannelArn

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

string ChannelArn { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

ChannelGroup

(experimental) The channel group this channel belongs to.

IChannelGroup? ChannelGroup { get; }

Property Value

IChannelGroup

Remarks

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

Stability: Experimental

Attribute: true

ChannelGroupName

(experimental) The name that describes the channel group.

string ChannelGroupName { get; }

Property Value

string

Remarks

The name is the primary identifier for the channel group.

Stability: Experimental

Attribute: true

ChannelName

(experimental) The name that describes the channel.

string ChannelName { get; }

Property Value

string

Remarks

The name is the primary identifier for the channel.

Stability: Experimental

Attribute: true

CreatedAt

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

string? CreatedAt { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

Grants

(experimental) Grants IAM resource policy to the role used to write to MediaPackage V2 Channel.

ChannelGrants Grants { get; }

Property Value

ChannelGrants

Remarks

Stability: Experimental

IngestEndpointUrls

(experimental) The ingest endpoint URLs for the channel.

string[] IngestEndpointUrls { get; }

Property Value

string[]

Remarks

Stability: Experimental

Attribute: true

ModifiedAt

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

string? ModifiedAt { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

Methods

AddOriginEndpoint(string, IOriginEndpointOptions)

(experimental) Add Origin Endpoint for this Channel.

OriginEndpoint AddOriginEndpoint(string id, IOriginEndpointOptions options)

Parameters

id string
options IOriginEndpointOptions

Returns

OriginEndpoint

Remarks

Stability: Experimental

AddToResourcePolicy(PolicyStatement)

(experimental) Configure channel policy.

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

Metric(string, IMetricOptions?)

(experimental) Create a CloudWatch metric.

Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

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

Returns

Metric

Remarks

Stability: Experimental

MetricEgressBytes(IMetricOptions?)

(experimental) Returns Metric for Egress Bytes.

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.

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.

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.

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.

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.

Metric MetricIngressResponseTime(IMetricOptions? options = null)

Parameters

options IMetricOptions

Returns

Metric

Remarks

Default: - average over 60 seconds

Stability: Experimental