aws-cdk-lib.aws_medialive.CfnChannel

class CfnChannel (construct)

LanguageType name
.NETAmazon.CDK.AWS.MediaLive.CfnChannel
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsmedialive#CfnChannel
Javasoftware.amazon.awscdk.services.medialive.CfnChannel
Pythonaws_cdk.aws_medialive.CfnChannel
TypeScript aws-cdk-lib » aws_medialive » CfnChannel

Implements IConstruct, IDependable, IInspectable

A CloudFormation AWS::MediaLive::Channel.

The AWS::MediaLive::Channel resource is a MediaLive resource type that creates a channel.

A MediaLive channel ingests and transcodes (decodes and encodes) source content from the inputs that are attached to that channel, and packages the new content into outputs.

Example

// The generated example for this type would exceed 500 lines,
// and has been elided for readability.

Initializer

new CfnChannel(scope: Construct, id: string, props?: CfnChannelProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnChannelProps — - resource properties.

Create a new AWS::MediaLive::Channel.

Construct Props

NameTypeDescription
cdiInputSpecification?IResolvable | CdiInputSpecificationPropertySpecification of CDI inputs for this channel.
channelClass?stringThe class for this channel.
destinations?IResolvable | IResolvable | OutputDestinationProperty[]The settings that identify the destination for the outputs in this MediaLive output package.
encoderSettings?IResolvable | EncoderSettingsPropertyThe encoding configuration for the output content.
inputAttachments?IResolvable | IResolvable | InputAttachmentProperty[]The list of input attachments for the channel.
inputSpecification?IResolvable | InputSpecificationPropertyThe input specification for this channel.
logLevel?stringThe verbosity for logging activity for this channel.
maintenance?IResolvable | MaintenanceCreateSettingsPropertyAWS::MediaLive::Channel.Maintenance.
name?stringA name for this audio selector.
roleArn?stringThe IAM role for MediaLive to assume when running this channel.
tags?anyA collection of tags for this channel.
vpc?IResolvable | VpcOutputSettingsPropertySettings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.

cdiInputSpecification?

Type: IResolvable | CdiInputSpecificationProperty (optional)

Specification of CDI inputs for this channel.


channelClass?

Type: string (optional)

The class for this channel.

For a channel with two pipelines, the class is STANDARD. For a channel with one pipeline, the class is SINGLE_PIPELINE.


destinations?

Type: IResolvable | IResolvable | OutputDestinationProperty[] (optional)

The settings that identify the destination for the outputs in this MediaLive output package.


encoderSettings?

Type: IResolvable | EncoderSettingsProperty (optional)

The encoding configuration for the output content.


inputAttachments?

Type: IResolvable | IResolvable | InputAttachmentProperty[] (optional)

The list of input attachments for the channel.


inputSpecification?

Type: IResolvable | InputSpecificationProperty (optional)

The input specification for this channel.

It specifies the key characteristics of the inputs for this channel: the maximum bitrate, the resolution, and the codec.


logLevel?

Type: string (optional)

The verbosity for logging activity for this channel.

Charges for logging (which are generated through Amazon CloudWatch Logging) are higher for higher verbosities.


maintenance?

Type: IResolvable | MaintenanceCreateSettingsProperty (optional)

AWS::MediaLive::Channel.Maintenance.


name?

Type: string (optional)

A name for this audio selector.

The AudioDescription (in an output) references this name in order to identify a specific input audio to include in that output.


roleArn?

Type: string (optional)

The IAM role for MediaLive to assume when running this channel.

The role is identified by its ARN.


tags?

Type: any (optional)

A collection of tags for this channel.

Each tag is a key-value pair.


vpc?

Type: IResolvable | VpcOutputSettingsProperty (optional)

Settings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.

Properties

NameTypeDescription
attrArnstringThe ARN of the MediaLive channel.
attrInputsstring[]The inputs that are attached to this channel.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
tagsTagManagerA collection of tags for this channel.
cdiInputSpecification?IResolvable | CdiInputSpecificationPropertySpecification of CDI inputs for this channel.
channelClass?stringThe class for this channel.
destinations?IResolvable | IResolvable | OutputDestinationProperty[]The settings that identify the destination for the outputs in this MediaLive output package.
encoderSettings?IResolvable | EncoderSettingsPropertyThe encoding configuration for the output content.
inputAttachments?IResolvable | IResolvable | InputAttachmentProperty[]The list of input attachments for the channel.
inputSpecification?IResolvable | InputSpecificationPropertyThe input specification for this channel.
logLevel?stringThe verbosity for logging activity for this channel.
maintenance?IResolvable | MaintenanceCreateSettingsPropertyAWS::MediaLive::Channel.Maintenance.
name?stringA name for this audio selector.
roleArn?stringThe IAM role for MediaLive to assume when running this channel.
vpc?IResolvable | VpcOutputSettingsPropertySettings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrArn

Type: string

The ARN of the MediaLive channel.

For example: arn:aws:medialive:us-west-1:111122223333:medialive:channel:1234567


attrInputs

Type: string[]

The inputs that are attached to this channel.

The inputs are identified by their IDs (not by their names or their ARNs).


cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


tags

Type: TagManager

A collection of tags for this channel.

Each tag is a key-value pair.


cdiInputSpecification?

Type: IResolvable | CdiInputSpecificationProperty (optional)

Specification of CDI inputs for this channel.


channelClass?

Type: string (optional)

The class for this channel.

For a channel with two pipelines, the class is STANDARD. For a channel with one pipeline, the class is SINGLE_PIPELINE.


destinations?

Type: IResolvable | IResolvable | OutputDestinationProperty[] (optional)

The settings that identify the destination for the outputs in this MediaLive output package.


encoderSettings?

Type: IResolvable | EncoderSettingsProperty (optional)

The encoding configuration for the output content.


inputAttachments?

Type: IResolvable | IResolvable | InputAttachmentProperty[] (optional)

The list of input attachments for the channel.


inputSpecification?

Type: IResolvable | InputSpecificationProperty (optional)

The input specification for this channel.

It specifies the key characteristics of the inputs for this channel: the maximum bitrate, the resolution, and the codec.


logLevel?

Type: string (optional)

The verbosity for logging activity for this channel.

Charges for logging (which are generated through Amazon CloudWatch Logging) are higher for higher verbosities.


maintenance?

Type: IResolvable | MaintenanceCreateSettingsProperty (optional)

AWS::MediaLive::Channel.Maintenance.


name?

Type: string (optional)

A name for this audio selector.

The AudioDescription (in an output) references this name in order to identify a specific input audio to include in that output.


roleArn?

Type: string (optional)

The IAM role for MediaLive to assume when running this channel.

The role is identified by its ARN.


vpc?

Type: IResolvable | VpcOutputSettingsProperty (optional)

Settings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }