Class: Aws::MediaPackageV2::Types::CreateChannelRequest

Inherits:

Struct

• Object
• Struct
• Aws::MediaPackageV2::Types::CreateChannelRequest

Defined in:

gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #channel_group_name ⇒ String

  The name that describes the channel group.

• #channel_name ⇒ String

  The name that describes the channel.

• #client_token ⇒ String

  A unique, case-sensitive token that you provide to ensure the idempotency of the request.

• #description ⇒ String

  Enter any descriptive text that helps you to identify the channel.

• #input_switch_configuration ⇒ Types::InputSwitchConfiguration

  The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.

• #input_type ⇒ String

  The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest.

• #output_header_configuration ⇒ Types::OutputHeaderConfiguration

  The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.

• #tags ⇒ Hash<String,String>

  A comma-separated list of tag key:value pairs that you define.

Instance Attribute Details

#channel_group_name ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 340

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#channel_name ⇒ String

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.

Returns:

• (String)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 340

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 340

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Enter any descriptive text that helps you to identify the channel.

Returns:

• (String)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 340

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#input_switch_configuration ⇒ Types::InputSwitchConfiguration

The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF.

Returns:

• (Types::InputSwitchConfiguration)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 340

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#input_type ⇒ String

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

The allowed values are:

• HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

• CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

Returns:

• (String)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 340

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_header_configuration ⇒ Types::OutputHeaderConfiguration

The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF.

Returns:

• (Types::OutputHeaderConfiguration)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 340

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A comma-separated list of tag key:value pairs that you define. For example:

"Key1": "Value1",

"Key2": "Value2"

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 340

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end